RigidGroups.add Method

Parent Object: RigidGroups
Defined in namespace "adsk::fusion" and the header file is <Fusion/Components/RigidGroups.h>

Description

Creates a new rigid group.

Syntax

"rigidGroups_var" is a variable referencing a RigidGroups object.
returnValue = rigidGroups_var.add(occurrences, includeChildren)
"rigidGroups_var" is a variable referencing a RigidGroups object.

#include <Fusion/Components/RigidGroups.h>

returnValue = rigidGroups_var->add(occurrences, includeChildren);

Return Value

Type Description
RigidGroup Returns the new RigidGroup object or null in the case of failure.

Parameters

Name Type Description
occurrences ObjectCollection An ObjectCollection containing the occurrences to use in creating the rigid group.
includeChildren boolean Boolean indicating if the children of the input occurrences should be included in the rigid group.

Samples

Name Description
Rigid Group API Sample Demonstrates creating a new Rigid Group.

Version

Introduced in version September 2015