ArrangeComponents Object Preview

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

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

The collection of ArrangeComponent objects associated with an arrangement. This provides access to existing ArrangeComponent objects and supports adding new components to the the arrangement. An ArrangeComponent object defines an occurrence along with additional arrangement information. This object is used for both the creation of a new Arrange feature and querying and modifying an existing Arrange feature.

Methods

Name Description
add Adds a new ArrangeComponent object to the collection.
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().
item Returns an ArrangeComponent object using an index into the collection.

Properties

Name Description
count Returns the number of ArrangeComponent objects 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

ArrangeFeature.arrangeComponents, ArrangeFeatureInput.arrangeComponents

Version

Introduced in version January 2025