ConstructionPlanes Object

Derived from: Base Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Construction/ConstructionPlanes.h>

Description

Provides access to the construction planes within a component and provides methods to create new construction planes.

Name	Description
add	Creates and adds a new ConstructionPlane using the creation parameters in the ConstructionPlaneInput. If the ConstructionPlaneInput was defined using the setByPlane method then the add will only work in the direct modeling model and will fail in the parametric modeling mode.
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().
createInput	Create a ConstructionPlaneInput object that is in turn used to create a ConstructionPlane.
item	Function that returns the specified construction plane using an index into the collection.
itemByName	Returns the specified construction plane using the name of the construction plane as it is displayed in the browser.

Name	Description
component	Returns the component that owns this collection.
count	Returns the number of construction planes in the collection.
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():

Name	Description
Construction Plane API Sample	Demonstrates creating construction planes using `ConstructionPlaneInput`: offset from a profile, angle, tangent, two planes, two edges, three points, three snap points, tangent at a point, and along a path. Also shows reading `healthState`, `errorOrWarningMessage`, and renaming planes. Before running: No open document is required. The script creates a new design, sketches a circle and lines, extrudes a cylinder, then exercises the construction plane APIs on that model. Run from Scripts and Add-Ins (Python/C++/TypeScript) in the DESIGN workspace.
Loft Feature API Sample	Demonstrates creating a new loft feature. Before running: No open document is required; the script creates a new design (or additional documents) as it runs.
Create a User Coordinate System	Demonstrates the creation of a user coordinate system at the end of a selected sketch curve or edge. Before running: Run from Scripts and Add-Ins. This sample may open dialogs or require interactive choices; keep Fusion in the foreground.

Introduced in version August 2014