StockMaterial Object Preview

Derived from: Base Object
Defined in namespace "adsk::cam" and the header file is <Cam/StockMaterials/StockMaterial.h>

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

Represents a StockMaterial.

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().
createFromJson Creates a StockMaterial object from given JSON string.
toJson Generates and returns a JSON string that contains a description of this StockMaterial.

Properties

Name Description
category Gets and sets the category of the stock material.
designators Gets a list of designators of the stock material.
hardness Get and sets the hardness of the stock materials. NOTE: the hardness can be NaN if not set. and user can set the hardness to NaN.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
name Gets and sets the name of the stock material.
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

DocumentStockMaterialLibrary.item, Setup.stockMaterial, StockMaterial.createFromJson, StockMaterialLibrary.childStockMaterials, StockMaterialLibrary.stockMaterialAtURL

Version

Introduced in version September 2024