ArrangeFeature.unusedComponents Property

This 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

Returns an array of ArrangeComponent objects that did not fit in the arrangement. This is most useful in the case where partial arrange has been enabled, which means some components may have been arranged and others were left out.

To use this property, you need to position the timeline marker immediately before the Arrange feature. This can be accomplished using the following code: arrangeFeature.timelineObject.rollTo(True)

Syntax

# Get the value of the property.
propertyValue = arrangeFeature_var.unusedComponents

#include <Fusion/Arrange/ArrangeFeature.h>

// Get the value of the property.
std::vector<Ptr<ArrangeComponent>> propertyValue = arrangeFeature_var->unusedComponents();

Property Value

Version