Plane Object
Derived from: Surface ObjectDefined in namespace "adsk::core" and the header file is <Core/Geometry/Plane.h>
Description
Transient plane. A transient plane is not displayed or saved in a document. Transient planes are used as a wrapper to work with raw plane information. A transient plane has no boundaries or size, but is infinite and is represented by a position, a normal, and an orientation in space. They are created statically using the create method of the Plane class.Methods
| 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(). |
| copy | Creates and returns an independent copy of this Plane object. |
| create | Creates a transient plane object by specifying an origin and a normal direction. |
| createUsingDirections | Creates a transient plane object by specifying an origin along with U and V directions. |
| intersectWithCurve | Intersect this plane with a curve to get the intersection point(s). |
| intersectWithLine | Creates a 3D point at the intersection of this plane and a line. |
| intersectWithPlane | Creates an infinite line at the intersection of this plane with another plane. |
| intersectWithSurface | Intersect this plane with a surface to get the intersection point(s). |
| isCoPlanarTo | Checks if this plane is coplanar with another plane. |
| isParallelToLine | Checks if this plane is parallel to a line. |
| isParallelToPlane | Checks if this plane is parallel to another plane. |
| isPerpendicularToLine | Checks if this plane is perpendicular to a line. |
| isPerpendicularToPlane | Checks if this plane is perpendicular to another plane. |
| setUVDirections | Sets the U and V directions of the plane. |
| transformBy | Updates this surface by transforming it with a given input matrix. |
Properties
| Name | Description |
| evaluator | Returns the surface evaluator. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| normal | Gets and sets the normal of the plane. |
| 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(): |
| origin | Gets and sets the origin point of the plane. |
| surfaceType | Returns the surface type. |
| uDirection | Gets the U Direction of the plane. |
| vDirection | Gets the V Direction of the plane. |