ConstructionAxis Object

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

Description

ConstructionAxis Object

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().
createForAssemblyContext Creates or returns a proxy for the native object - i.e. a new object that represents this object but adds the assembly context defined by the input occurrence.
deleteMe Deletes the construction axis.

Properties

Name Description
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 axis.
baseFeature If this construction axis 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 construction axis definition object which provides access to the information defining the construction axis.
entityToken Returns a token for the ConstructionAxis object. This can be saved and used at a later time with the Design.findEntityByToken method to get back the same construction axis.

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 an infinite line that represents the position and orientation of the construction axis. This geometry is defined in the AssemblyContext of this ConstructionAxis.
healthState Returns the current health state of this construction axis.
isDeletable Indicates if this construction axis can be deleted. Base construction axes can not be deleted.
isLightBulbOn Indicates if the light bulb (as displayed in the browser) is on. A construction axis 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 axis 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 Gets if the construction plane is visible. This property is affected by the AssemblyContext of the construction axis.
name The name of the construction axis as it is shown in the browser.
nativeObject The NativeObject is the object outside the context of an assembly and in the context of it's parent component. 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 axis are parametric, the parent will be a component. If the design is parametric and the construction axis 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 axis.

Accessed From

BaseFeature.constructionAxes, Component.xConstructionAxis, Component.yConstructionAxis, Component.zConstructionAxis, ConstructionAxes.add, ConstructionAxes.item, ConstructionAxes.itemByName, ConstructionAxis.createForAssemblyContext, ConstructionAxis.nativeObject, ConstructionAxisByLineDefinition.parentConstructionAxis, ConstructionAxisCircularFaceDefinition.parentConstructionAxis, ConstructionAxisDefinition.parentConstructionAxis, ConstructionAxisEdgeDefinition.parentConstructionAxis, ConstructionAxisNormalToFaceAtPointDefinition.parentConstructionAxis, ConstructionAxisPerpendicularAtPointDefinition.parentConstructionAxis, ConstructionAxisTwoPlaneDefinition.parentConstructionAxis, ConstructionAxisTwoPointDefinition.parentConstructionAxis, FlatPatternComponent.xConstructionAxis, FlatPatternComponent.yConstructionAxis, FlatPatternComponent.zConstructionAxis

Samples

Name Description
Construction Axis API Sample Demonstrates creating construction axis in various ways.

Version

Introduced in version August 2014