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.
A parameter value that is a CadMultiPointOnSurface.
| Name | Description |
| appendPoint |
Append a probe point using the same surface reference as the last point. Position is in cm model coordinates and is projected onto the surface. |
| 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(). |
| insertInterpolatedPointAfter |
Insert a new point between points at leftIndex and leftIndex+1 using t in (0,1). Same surface: interpolate UV on faces or world position on meshes. Different surfaces: interpolate world position, project onto each neighbor surface (closest point), and insert using the closest projection. |
| removePointAt |
Remove the probe point at the given index in the stored point list (order before inspect_order_method reordering). At least one point must remain. |
| 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(): |
| parent | Get the parameter object that the value is associated with. |
| value | Get or set the value of the parameter. If the value originates from a component instead of an occurrence, or an occurrence outside of the CAM environment, then the subpath is checked against the CAM model tree. An exception is thrown if the matching fails or the given entity does not match the expected type. |
| values | Get/Set the values of the parameter as a vector of Point3D positions. Points are in CM units. Points are in model coordinates. |