VolumetricSampler.structuredSamplingRank Property

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.

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

# Get the value of the property.
propertyValue = volumetricSampler_var.structuredSamplingRank

#include <Volume/Volumetric/VolumetricSampler.h>

// Get the value of the property.
uinteger propertyValue = volumetricSampler_var->structuredSamplingRank();

// Get the value of the property.
propertyValue = volumetricSampler_var.structuredSamplingRank;

Property Value

Version