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.
The VolumetricSampler object which is used for controled sampling of the volumetric model.
| Name | Description |
| addSamplePoints |
Appends sample points to the existing sample points to be used for sampling the volumetric model. Adding sample points results in an unstructured sampling layout. |
| classType |
Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType(). |
| clearSamplePoints |
Clears the sample points that have been set for sampling the volumetric model. This will reset the structured sampling rank to 0. |
| evaluate |
Evaluates the volumetric model at the previously set sample points for the given node and returns the results. |
| evaluateColor |
Evaluates the color of the model at the previously set sample points and returns the results. |
| evaluateDensity |
Evaluates the density of the model at the previously set sample points and returns the results. This value is what is used to determine the level set of the model. |
| evaluateLevelSet |
Evaluates the level set function of the model at the previously set sample points and returns the results. |
| samplePointCount |
Gets the number of sample points that will be used for sampling the volumetric model. |
| setBoundingBoxSampling |
Calculates and sets the sample points to be used for sampling the volumetric model for a given resolution throughout the bounding box provided. This will override any previously set sample points. |
| setPlaneSampling |
Calculates and sets the sample points to be used for sampling the volumetric model for a given resolution, plane and primary axis. The points will be distributed in a grid pattern on the plane, starting at the plane origin and extend in the primary axis and secodary axis for the axis size arguments. The secondary axis is calculated from the cross product of the plane normal and the primary axis. This will override any previously set sample points. |
| setSamplePoints |
Sets sample points to be used for sampling the volumetric model. This will override any previously set sample points and result in an unstructured sampling layout. |
| Name | Description |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| objectType | This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object. It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType(): |
| sampleAxes | Gets the axes of the current structured sampling layout. For plane grid sampling this returns [primaryAxis, secondaryAxis]. For bounding box grid sampling this returns [xAxis, yAxis, zAxis]. For unstructured sampling this returns an empty array. |
| sampleDimensions | 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. |
| sampleOrigin | 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. |
| sampleSpacings | Gets the spacing between neighbouring samples along each structured sampling axis. For unstructured sampling this returns an empty array. |
| structuredSamplingRank | 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. |