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.

Methods

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 a direct edit model (do not capture design history) and will fail in a parametric model.
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.

Properties

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():

Accessed From

BaseComponent.constructionPlanes, Component.constructionPlanes, FlatPatternComponent.constructionPlanes

Samples

Name Description
Construction Plane API Sample Demonstrates creating construction plane by different ways.
Loft Feature API Sample Demonstrates creating a new loft feature.

Version

Introduced in version August 2014