VolumetricSampler.sampleOrigin Property

Parent Object: VolumetricSampler

PreviewThis 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

Gets the origin of the current structured sampling layout. For plane grid sampling this is the plane origin. For bounding box grid sampling this is the minimum corner of the bounding box. Returns null if the current sampling layout is not structured.

Syntax

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

// Get the value of the property.
Ptr<Point3D> propertyValue = volumetricSampler_var->sampleOrigin();
"volumetricSampler_var" Is a variable referencing a VolumetricSampler Object.
// Get the value of the property.
propertyValue = volumetricSampler_var.sampleOrigin;

Property Value

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

Version

Introduced in version July 2026