A ConstructionPlaneInput is a throwaway object used to create a ConstructionPlane. The usage pattern is: a. create a ConstructionPlaneInput (ConstructionPlanes.CreateInput) b. call one of the member functions to specify how the ConstructionPlane is created c. create the ConstructionPlane (call ConstructionPlanes.Add) d. stop referencing the ConstructionPlaneInput (so it gets deleted).
| 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(). |
| setByAngle |
This input method is for creating a construction plane through an edge, axis or line at a specified angle. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| setByAngleOnCurvedFace |
This input method is for creating a construction plane through the axis inferred from a cylindrical or conical curved face at a specified angle. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| setByDistanceOnPath |
**RETIRED** This method has been retired and replaced by the setByPath method. The setByPath method lets you choose how the distance is specified; proportional distance (which is the only option with setByDistanceOnPath) or the physical distance along the path. |
| setByOffset |
This input method is for creating a construction plane that is offset from a planar face or construction plane at a specified distance. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| setByOffsetThroughPoint |
Defines a construction plane that is offset from a planar face or construction plane and whose offset distance is defined by a vertex, sketch point, or construction point where the plane passes through the point. |
| setByPath |
This input method is for creating a construction plane normal to the specified path at a specified position along the path. This can result in a parametric or non-parametric construction plane, depending on whether the parent design is parametric or is a direct edit component, or if the construction plane is created in a base feature in a parametric design. |
| setByPathToObject |
This input method is for creating a construction plane normal to the specified path at the position where the path meets the target point entity, with an optional signed offset along the path from that target. This can result in a parametric or non-parametric construction plane, depending on whether the parent design is parametric or is a direct edit component, or if the construction plane is created in a base feature in a parametric design. |
| setByPerpendicularToPlane |
This input method creates a construction plane that is perpendicular to the input face or plane. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| setByPlane |
This input method is for creating a non-parametric construction plane positioned in space as defined by the input Plane object. |
| setByTangent |
This input method is for creating a construction plane tangent to a cylindrical or conical face at a specified point. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| setByTangentAtPoint |
This input method is for creating a construction plane tangent to a face and aligned to a point. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| setByThreePoints |
This input method is for creating a construction plane through three points that define a triangle. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| setByThreeSnapPoints |
This input method is for creating a construction plane through three snap points. A snap point captures the same information that the user supplies in the UI when they hover over an entity and pick a snap location: the host entity, an optional reference entity, the picked 3D point in world space, and a ConstructionSnapPointTypes value that classifies the selection. Build each snap with ConstructionSnapPoint.create. Supported snap-point types include vertex (DefaultConstructionSnapPointType on a BRepVertex, SketchPoint, or ConstructionPoint), edge midpoint, edge start/end, arc center, face center, and tangent on a curved face (cylinder/cone, sphere, torus, or spline). The first snap point defines the plane origin. The three points together define the plane orientation (normal); they do not explicitly set the in-plane X- or Y-axis directions. This matches setByThreePoints. This will fail if the three points are collinear or any two are coincident. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| setByTwoEdges |
This input method is for creating a construction plane that passes through two coplanar linear entities or axes. Defines a plane by specifying two coplanar linear entities. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| setByTwoPlanes |
This input method is for creating a construction plane at the midpoint between two planar faces or construction planes. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| Name | Description |
| creationOccurrence | In order for geometry to be transformed correctly, an Occurrence for creation needs to be specified when the ConstructionPlane is created based on geometry (e.g. a planarEntity) in another component AND (the ConstructionPlane) is not in the root component. The CreationOccurrence is analogous to the active occurrence in the UI. |
| isExtended | Gets and sets whether the construction plane will use the extended display mode when created. When true, the plane extends to fill the viewport. When false, the plane size fits to the defining geometry (default). |
| 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(): |
| targetBaseOrFormFeature | When creating a construction plane that is owned by a base or form feature, set this property to the base or form feature you want to associate the new construction plane with. By default, this is null, meaning it will not be associated with a base or form feature. Because of a current limitation, if you want to create a construction plane associated with a base or form feature, you must set this property AND call the startEdit method of the base or form feature, create the feature, and then call the finishEdit method of the base or form feature. The base or form feature must be in an "edit" state to be able to add any additional items to it. |
| Name | Description |
| Construction Plane API Sample | Demonstrates creating construction plane by different ways. |
| Loft Feature API Sample | Demonstrates creating a new loft feature. |
| Create a User Coordinate System | Demonstrates the creation of a user coordinate system at the end of a selected sketch curve or edge. |