| assemblyContext |
Returns the assembly occurrence (i.e. the occurrence) of this object in an assembly. This is only valid in the case where this is acting as a proxy in an assembly. Returns null in the case where the object is not in the context of an assembly but is already the native object. |
| attributes |
Returns the collection of attributes associated with this construction plane. |
| baseFeature |
If this construction plane is associated with a base feature, this property will return that base feature. If it's not associated with a base feature, this property will return null. |
| component |
Returns the component this construction plane belongs to. |
| definition |
Returns the ConstructionPlaneDefinition object which provides access to the information defining this ConstructionPlane. |
| displayBounds |
Gets and sets the display size of the construction plane. The bounding box defines the min and max corners of the plane as defined in the 2D space of the construction plane. |
| entityToken |
Returns a token for the ConstructionPlane object. This can be saved and used at a later time with the Design.findEntityByToken method to get back the same construction plane.
When using entity tokens it's important to understand that the token string returned for a specific entity can be different over time. However, even if you have two different token strings that were obtained from the same entity, when you use findEntityByToken they will both return the same entity. Because of that you should never compare entity tokens as way to determine what the token represents. Instead, you need to use the findEntityByToken method to get the two entities identified by the tokens and then compare them. |
| errorOrWarningMessage |
Returns the error or warning message in the case where the healthState property returns either WarningFeatureHealthState or ErrorFeatureHealthState. Otherwise this property returns an empty string. |
| geometry |
Returns a plane that represents the position and orientation of the construction plane. This geometry is defined in the AssemblyContext of this ConstructionPlane. |
| healthState |
Returns the current health state of this construction plane. |
| isDeletable |
Indicates if this construction plane can be deleted. Base construction planes can not be deleted. |
| isLightBulbOn |
Indicates if the light bulb (as displayed in the browser) is on. A construction plane will only be visible if it's light bulb, and that of it's containing folder and parent component/s are also on. |
| isParametric |
Indicates if this construction plane is parametric or not. |
| isValid |
Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| isVisible |
Indicates if the construction plane is visible. This property is affected by the AssemblyContext of the construction plane. |
| name |
Returns the name of the construction plane as it is shown in the browser. |
| nativeObject |
The NativeObject is the object outside the context of an assembly. Returns null in the case where this object is not in the context of an assembly but is already the native object. |
| 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 |
Returns the parent component or base feature. If both the design and the construction plane are parametric, the parent will be a component. If the design is parametric and the construction plane is not, the parent will be a base feature. If the design is not parametric the parent will be a component. |
| timelineObject |
Returns the timeline object associated with this construction plane. |
| transform |
Returns the current position and orientation of the construction plane as a matrix. For a parametric construction plane, this property is read-only. For a construction plane in a direct modeling model or in a base feature, this is read-write and can be used to reposition the constructions plane. |