VolumetricSampler.sampleDimensions Property

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

Description

Gets the dimensions of the current structured sampling layout. For plane grid sampling this returns [primaryCount, secondaryCount]. For bounding box grid sampling this returns [xCount, yCount, zCount]. For unstructured sampling this returns an empty array.

Syntax

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

// Get the value of the property.
std::vector<uinteger> propertyValue = volumetricSampler_var->sampleDimensions();
"volumetricSampler_var" Is a variable referencing a VolumetricSampler Object.
// Get the value of the property.
propertyValue = volumetricSampler_var.sampleDimensions;

Property Value

This is a read only property whose value is an array of type uinteger.

Version

Introduced in version July 2026