MaterialLibrary Object

Derived from: Base Object
Defined in namespace "adsk::core" and the header file is <Core/Materials/MaterialLibrary.h>

Description

A material library.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
unload Unloads this material from Fusion. Only non-native material libraries can be unloaded. You can determine this by checking the isNative property.

Properties

Name Description
appearances Returns the appearances defined within this library.
id The unique internal ID of this Library.
isNative Gets if this is a native material library. Native libraries are those that are delivered with Fusion and are always available. And non-native libraries are user created. If This returns True then there are some limitations to what can be done with the library. For example, if this is a native material library it cannot be unloaded.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
materials Returns the materials defined within this library.
name Property that gets the name of this Library. This is the localized name shown in the user interface.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():

Accessed From

MaterialLibraries.item, MaterialLibraries.itemById, MaterialLibraries.itemByName, MaterialLibraries.load

Samples

Name Description
Material API Sample

Demonstrates using materials and appearance using the API.

To use the sample, create a new Python or C++ script and copy and paste this code, replacing the default code. The sample also used an external appearance library which you can get here. Copy that to any location on your computer and edit the path in the script. When running the script, have a design open that contains a body in the root component.

Version

Introduced in version August 2014