Arrange2DDefinition Object Preview

Derived from: ArrangeDefinition Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Arrange/Arrange2DDefinition.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

This object defines all of the settings associated with a 2D arrangement. This is used for both rectangular and true shape arrangements, but some properties are ignored in some cases.

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

Properties

Name Description
globalQuantity Returns the parameter that controls the global quantity. You can modify the value by using the properties on the returned ModelParameter object.
globalRotation Gets and sets the global rotation type.
grainDirection Defines the angle of the grain direction of the envelope. An angle of 0 is in the X direction of the envelope. You can modify the value by using the properties on the returned ModelParameter object.

This is only valid when the solver type is True Shape and it returns null in all other cases.
isCreateCopies Gets if the original components were moved to create the arrangement or copied were created. This value can only be set when creating a new arrangement.
isGlobalDirectionFaceUp Gets and sets the global direction for selected faces. When true, the components specified by selecting a face will be oriented such that the selection face will be oriented upward in the arrangement.
isPartInPartAllowed Gets and sets if parts can be nested within void areas of other parts.

This is only used when the solver type is 2D True Shape and is ignored for 2D Rectangular solutions.
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():
solverType Gets the type of arrange feature defined by this definition.

Version

Introduced in version January 2025