ArrangeComponents.add Method

Parent Object: ArrangeComponents

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.


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

Description

Adds a new ArrangeComponent object to the collection.

Syntax

"arrangeComponents_var" is a variable referencing an ArrangeComponents object.
returnValue = arrangeComponents_var.add(occurrenceOrFace)
"arrangeComponents_var" is a variable referencing an ArrangeComponents object.

#include <Fusion/Arrange/ArrangeComponents.h>

returnValue = arrangeComponents_var->add(occurrenceOrFace);

Return Value

Type Description
ArrangeComponent Returns the created ArrangeComponent where you can use properties on it to define the various other settings supported to control how the component is arranged.

Parameters

Name Type Description
occurrenceOrFace Base For a 2D arrange this can be an Occurrence or BRepFace object that defines which component to use. If a BRepFace object is used, the face is used to orient the part in the arrangement and will face up or down depending on the isGlobalDirectionFaceUp property on the ArrangeFeature2DInput object.

For a 2D arrange, if an Occurrence is provided, the Occurrence will be oriented in the arrangement such that the largest face points downward.

For a 3D arrange this can be an Occurrence or BRepFace object but if a BRepFace is provided it does not define the orientation but is only used to get the parent Occurrence. For a 3D arrange the arranged occurrences have the same orientation as the original occurrence but are positioned within the 3D envelope.

Version

Introduced in version January 2025