RigidGroup Object

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

Description

Represents a rigid group within an assembly.

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().
createForAssemblyContext Creates or returns a proxy for the native object - i.e. a new object that represents this object but adds the assembly context defined by the input occurrence.
deleteMe Deletes this rigid group.
setOccurrences Sets which occurrences are to be part of this rigid group.

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

Properties

Name Description
assemblyContext Returns the assembly occurrence (i.e. the occurrence) of this object in an assembly. This is only valid in the case where this is acting as a proxy in an assembly. Returns null in the case where the object is not in the context of an assembly but is already the native object.
attributes Returns the collection of attributes associated with this rigid group.
entityToken Returns a token for the RigidGroup object. This can be saved and used at a later time with the Design.findEntityByToken method to get back the same rigid group.

When using entity tokens it's important to understand that the token string returned for a specific entity can be different over time. However, even if you have two different token strings that were obtained from the same entity, when you use findEntityByToken they will both return the same entity. Because of that you should never compare entity tokens as way to determine what the token represents. Instead, you need to use the findEntityByToken method to get the two entities identified by the tokens and then compare them.
isSuppressed Gets and sets if this rigid group is suppressed.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
isVisible Gets and sets whether the occurrences that are part of this rigid group are visible or not.
name Gets and sets the name of the rigid group as seen in the timeline.
nativeObject The NativeObject is the object outside the context of an assembly and in the context of it's parent component. Returns null in the case where this object is not in the context of an assembly but is already the native object.
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():
occurrences Returns the list of occurrences that are part of the rigid group.
parentComponent Returns the parent component that owns this rigid group.
timelineObject Returns the timeline object associated with this rigid group.

Accessed From

Component.allRigidGroups, FlatPatternComponent.allRigidGroups, RigidGroup.createForAssemblyContext, RigidGroup.nativeObject, RigidGroupList.item, RigidGroupList.itemByName, RigidGroups.add, RigidGroups.item, RigidGroups.itemByName

Samples

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

Version

Introduced in version September 2015