VolumetricSampler.evaluate Method

Parent Object: VolumetricSampler

Preview This 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.

Defined in namespace "adsk::volume" and the header file is <Volume/Volumetric/VolumetricSampler.h>

Description

Evaluates the volumetric model at the previously set sample points for the given node and returns the results.

"volumetricSampler_var" is a variable referencing a VolumetricSampler object.

# Uses no optional arguments.
returnValue = volumetricSampler_var.evaluate(graphNode)

# Uses optional arguments.
returnValue = volumetricSampler_var.evaluate(graphNode, isOutput, index)

"volumetricSampler_var" is a variable referencing a VolumetricSampler object.

#include <Volume/Volumetric/VolumetricSampler.h>

// Uses no optional arguments.
returnValue = volumetricSampler_var->evaluate(graphNode);

// Uses optional arguments.
returnValue = volumetricSampler_var->evaluate(graphNode, isOutput, index);

Return Value

Type	Description
VolumetricSample[]	An array of VolumetricSample objects that contain the results of sampling the volumetric model.

Parameters

Name	Type	Description
graphNode	GraphNode	The graph node to evaluate at the sample points.
isOutput	boolean	Optional argument that controls the sampling. If set to true samples an output pin, if set to false samples an input pin. Default is True. This is an optional argument whose default value is True.
index	integer	Optional argument that controls the index of the pin to sample. Default is 0 which is the first pin. This is an optional argument whose default value is 0.

Version

Introduced in version May 2025