StockMaterial Object

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

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.
hardnessUnit Gets and sets the hardness unit of the stock material. Returns an empty string when no unit is set (including legacy materials with unitless hardness). Standard hardness scales such as "HRC", "HRA", and "HB" are supported, as well as custom unit names. When setting a hardness unit, a hardness value must already be set. Clearing the unit while a hardness value is set is not allowed. Legacy unitless hardness can be read but cannot be created or saved via import or update.
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