VolumetricModel Object

Derived from: Base Object
Defined in namespace "adsk::volume" and the header file is <Volume/Volumetric/VolumetricModel.h>

Description

The main volumetric graph object. It has a parent component and is defined in this parent component's space. It also contains the primary and cell graphs.

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().

createSampler

Creates a VolumetricSampler object that can be used to sample the volumetric model.

getGraph

Returns a graph from the volumetric model.

registerCustomSDFCallback

Registers a custom Signed Distance Field callback handler with a given ID. To use the callback, set a GeometryGraphNodeProperty's customSDFCallbackID to the same string ID.

unregisterCustomSDFCallback

Unregisters the Signed Distance Field callback handler with the given ID.

Properties

Name Description
boundaryBody Gets the main boundary body for this volumetric model. The volumetric model is bound by the axis aligned bounding box and will only be rendered within this body.
isLightBulbOn Gets and sets if the light bulb / eye (as displayed in the browser) controlling the model's visibility is on.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
isVisible Gets if the volumetric model is visible. To change the visibility see the isLightBulbOn property. A volumetric model will only be visible if the light bulb is switched on. However, the light bulb can be on and the volumetric model is still invisible if the light bulb for all bodies or the owning component is off.
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():
parentComponent Returns the parent Component.

Samples

Name Description
Volumetric Custom Feature API Sample

Demonstrates how to create a Volumetric Custom Feature using the API for graph creation.

To run the sample script, have a document open in Fusion’s DESIGN workspace. This script will create a component with a box by sketching then extruding that sketch. It will then use that box as a boundary body and create a Volumetric Custom Feature.

The script will then create a gyroid lattice using the Volumetric Model API with the appropriate graphs, nodes, and pin connections for a minimal example. Finally, the script will convert that Volumetric Model to Mesh using the API and the VolumetricModelToMeshFeature.

Version

Introduced in version May 2025