Volumetric Node and Property Reference

Nodes are added to a Graph through its GraphNodes collection with GraphNodes.add(name, nodeTypeString). Output channels are retrieved with GraphNodes.outputNode and a GraphOutputNodeTypes constant; pins are wired with GraphNodePin.connect. See Graphs and channels for channel names and graph evaluation for how channels combine.

Listing Nodes in a Graph

To inspect an existing graph, iterate the node's collection and print each node's type, name, and properties:

import adsk.volume

primaryGraph = volumetricModel.getGraph(adsk.volume.GraphTypes.PrimaryGraphType)
for node in primaryGraph.nodes:
    propNames = [node.properties.item(j).name for j in range(node.properties.count)]
    print(node.nodeType, node.name, propNames)

You can also look up a node by name with GraphNodes.itemByName, or obtain a snapshot array with GraphNodes.asArray. List available node type strings with Graph.allPossibleNodeTypes.

Property Types

Node properties are accessed through GraphNode.properties and cast to the appropriate property class:

Property class	Value type	Typical use
ScalarGraphNodeProperty	Floating point	Constants, densities, SDF offsets
Vector3DGraphNodeProperty	Vector3D	Scaling, translation, coordinate transforms
ColorGraphNodeProperty	Color	Constant or computed color values
StringGraphNodeProperty	String	Function expressions, custom SDF callback IDs
IntegerGraphNodeProperty	Integer	Discrete settings
BooleanGraphNodeProperty	Boolean	On/off flags
GeometryGraphNodeProperty	BRep reference	Bodies, faces, curves for `ReferencedGeometrySDF` and related nodes. Also supports beamNetwork for discrete lattice structures.
TransformReferenceGraphNodeProperty	Occurrence	Assembly context for geometry references
Matrix3DGraphNodeProperty	Matrix3D	Homogeneous transforms
ScalarControlPointMapGraphNodeProperty	Control point map	Scalar-to-scalar ramps (`ControlPointMapScalarToScalar`)
ColorControlPointMapGraphNodeProperty	Control point map	Scalar-to-color ramps (`ControlPointMapScalarToColor`)

Node Type Catalog

The following type strings are valid arguments to GraphNodes.add. They are grouped by category. Unless noted, nodes can be used in either graph; coordinate and cell-shape nodes are typically placed in the Cell graph, while boundary and density nodes belong in the Primary graph.

SDF Primitives

Type string	Purpose
`BoxSDF`	Axis-aligned box signed distance field
`CylinderSDF`	Cylinder SDF
`SphereSDF`	Sphere SDF
`TorusSDF`	Torus SDF
`PlaneSDF`	Plane SDF
`ReferencedGeometrySDF`	SDF from Fusion BRep geometry (bodies, faces). See Referenced geometry below.
`Shell`	Shell offset operation on an input SDF

Geometry References

Type string	Purpose
`ReferencedCurveLength`	Scalar field from curve length
`ReferencedCurveCoords`	Coordinates along a referenced curve
`ReferencedFaceCoords`	Coordinates on a referenced face

Constants and Noise

Type string	Purpose
`ConstantScalar`	Fixed scalar value (value property)
`ConstantColor`	Fixed color value
`PerlinNoiseScalar`	Perlin noise scalar field
`VoronoiNoiseScalar`	Voronoi noise scalar field
`InvertDensity`	Inverts a density input
`GradientVector`	Gradient of a scalar field as a vector

Image Samplers

Type string	Purpose
`ImageSamplerScalar`	Sample a 2D image as scalar
`ImageSamplerVector`	Sample a 2D image as vector
`ImageSamplerColor`	Sample a 2D image as color
`3DImageSamplerScalar`	Sample a 3D image volume as scalar
`ExternalColor`	External color source

Coordinate Transforms

Type string	Purpose
`TransformCoords`	Scale, translate, and rotate cell coordinates
`HomogenousTransformCoords`	Transform using a homogeneous matrix
`TwistCoords`	Twist deformation of coordinates
`AxisBasedDeformCoords`	Deform coordinates about an axis
`SphereCoords`	Convert to spherical coordinates
`TorusCoords`	Convert to toroidal coordinates
`CylinderCoords`	Convert to cylindrical coordinates

Control Point Maps and Falloff

Type string	Purpose
`ControlPointMapScalarToScalar`	Map scalar input to scalar output via control points
`ControlPointMapScalarToColor`	Map scalar input to color via control points
`FalloffMapping`	Distance-based falloff mapping

Type Conversion and Math

Type string	Purpose
`VectorToColor`	Convert vector to color
`CombineScalarsToVector`	Build a vector from scalars
`CombineScalarsToColor`	Build a color from scalars
`SplitVectorToScalars`	Split vector into x, y, z scalars
`SplitColorToScalars`	Split color into r, g, b, a scalars
`LengthOfVector`	Vector magnitude
`NormalizeVector`	Unit vector
`BinaryOperatorScalar`	Binary operation on two scalars
`BinaryOperatorVector`	Binary operation on two vectors
`BinaryOperatorColor`	Binary operation on two colors
`MultiplyScalar`	Multiply scalars
`MultiplyVector`	Multiply vectors
`MultiplyColor`	Multiply colors

Function Nodes

Type string	Purpose
`FunctionScalarToScalar`	Expression with scalar input and scalar output
`FunctionVectorToScalar`	Expression with vector input and scalar output (common for cell shapes)
`FunctionVectorToVector`	Expression with vector input and vector output
`FunctionVectorToColor`	Expression with vector input and color output

Expression syntax for function nodes is documented in Volumetric Function Expression Syntax.

Referenced Fusion Geometry

The ReferencedGeometrySDF node converts Fusion BRep geometry into a signed distance field. Set the geometry reference on the node's GeometryGraphNodeProperty. Use Shell to offset the resulting SDF inward or outward.

import adsk.core, adsk.volume

primaryGraph = volumetricModel.getGraph(adsk.volume.GraphTypes.PrimaryGraphType)

# Reference a boundary body (use createForAssemblyContext in assemblies)
geomNode = primaryGraph.nodes.add("BoundaryBody", "ReferencedGeometrySDF")
geomProp = adsk.volume.GeometryGraphNodeProperty.cast(
    geomNode.properties.itemByName("geometry"))
geomProp.value = [boundaryBody]

# Optional: shell the referenced geometry SDF
shellNode = primaryGraph.nodes.add("ShellOffset", "Shell")
shellNode.properties.itemByName("thickness").value = 0.1
geomNode.outputPins.item(0).connect(shellNode.inputPins.item(0))

boundaryChannel = primaryGraph.nodes.outputNode(
    adsk.volume.GraphOutputNodeTypes.BoundarySDFOutputNodeType)
shellNode.outputPins.item(0).connect(boundaryChannel.inputPins.item(0))