The definition for a parametric construction plane created using the setByPath method.
| Name | Description |
| 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(). |
| redefine |
Redefines the input geometry of the construction plane using Proportional or Absolute (physical distance) positioning via setByPath. |
| redefineToObject |
Redefines the input geometry of the construction plane using To Object positioning via setByPathToObject. |
| Name | Description |
| distance | Returns the ModelParameter that controls position along the path. To change the value, use the properties on the returned ModelParameter object. For Proportional planes (setByPath with ProportionalPathDistanceType), this is the proportional distance (0 to 1) along the path. For Absolute planes (setByPath with PhysicalPathDistanceType), this is the physical distance along the path. For To Object planes (setByPathToObject), this is the computed along-path position where the path meets the target entity. The user-controlled signed shift from that target is returned by the offset property, not this property. To change To Object positioning, use redefineToObject or edit offset rather than distance alone. |
| distanceType | Returns an PathDistanceTypes value indicating the measurement type for distance. For planes created with setByPathToObject, this returns PhysicalPathDistanceType (the position is stored non-proportionally). Use the toObject property to distinguish To Object planes from Absolute (physical distance) planes. |
| 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(): |
| offset | Returns the ModelParameter controlling the signed offset from the target along the path, or null when the plane was not created using setByPathToObject (Proportional or Absolute planes). For To Object planes, this is the user-facing offset passed to setByPathToObject (positive or negative along the path from the target point). It is separate from the distance property, which holds the along-path position derived from the target entity. To change the value, use the properties on the returned ModelParameter object, or use redefineToObject to change path, target, or offset together. |
| parentConstructionPlane | Returns the ConstructionPlane object |
| path | Returns the Path object the construction plane was created on. |
| toObject | Returns the target ("to object") point entity, or null when the plane was not created using setByPathToObject (Proportional or Absolute planes). |