VolumetricSampler.structuredSamplingRank Property

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

Description

Gets the rank of the current structured sampling layout. This is 0 for unstructured sampling, 2 for plane grid sampling and 3 for bounding box grid sampling.

Syntax

"volumetricSampler_var" is a variable referencing a VolumetricSampler object.
# Get the value of the property.
propertyValue = volumetricSampler_var.structuredSamplingRank
"volumetricSampler_var" Is a variable referencing a VolumetricSampler Object.
#include <Volume/Volumetric/VolumetricSampler.h>

// Get the value of the property.
uinteger propertyValue = volumetricSampler_var->structuredSamplingRank();
"volumetricSampler_var" Is a variable referencing a VolumetricSampler Object.
// Get the value of the property.
propertyValue = volumetricSampler_var.structuredSamplingRank;

Property Value

This is a read only property whose value is a uinteger.

Version

Introduced in version July 2026