VolumetricSampler.clearSamplePoints Method

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

Clears the sample points that have been set for sampling the volumetric model.

Syntax

"volumetricSampler_var" is a variable referencing a VolumetricSampler object.
returnValue = volumetricSampler_var.clearSamplePoints()
"volumetricSampler_var" is a variable referencing a VolumetricSampler object.

#include <Volume/Volumetric/VolumetricSampler.h>

returnValue = volumetricSampler_var->clearSamplePoints();

Return Value

Type Description
boolean True if the sample points were successfully cleared.

Version

Introduced in version May 2025