VolumetricSampler.evaluate Method

Parent Object: VolumetricSampler
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.

Syntax

"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);
"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);

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