Navigation
API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units
Classes
| Type | Name | Description | |
|---|---|---|---|
| FRigDispatch_GetMetadata | Sets some metadata for the provided item | ||
| FRigDispatch_GetModuleMetadata | Returns some metadata on a given module | ||
| FRigDispatch_MetadataBase | |||
| FRigDispatch_SetMetadata | Sets some metadata for the provided item | ||
| FRigDispatch_SetModuleMetadata | Sets metadata on the module | ||
| FRigUnit_AddBoneTransform | Offset Transform is used to perform a change in the hierarchy by setting a single bone's transform. | ||
| FRigUnit_BoneName | BoneName is used to represent a bone name in the graph | ||
| FRigUnit_ControlName | ControlName is used to represent a Control name in the graph | ||
| FRigUnit_CurveExists | CurveExists is used to check whether a curve exists or not. | ||
| FRigUnit_FilterItemsByMetadataTags | Filters an item array by a list of tags | ||
| FRigUnit_FindItemsWithMetadata | Returns all items containing a specific set of metadata | ||
| FRigUnit_FindItemsWithMetadataTag | Returns all items with a specific tag | ||
| FRigUnit_FindItemsWithMetadataTagArray | Returns all items with a specific tag | ||
| FRigUnit_GetAnimationChannelBase | Get Animation Channel is used to retrieve a control's animation channel value | ||
| FRigUnit_GetBoneTransform | GetBoneTransform is used to retrieve a single transform from a hierarchy. | ||
| FRigUnit_GetBoolAnimationChannel | Get Bool Channel is used to retrieve a control's animation channel value | ||
| FRigUnit_GetControlBool | GetControlBool is used to retrieve a single Bool from a hierarchy. | ||
| FRigUnit_GetControlColor | GetControlColor is used to retrieve the color of control | ||
| FRigUnit_GetControlDrivenList | GetControlDrivenList is used to retrieve the list of affected controls of an indirect control | ||
| FRigUnit_GetControlFloat | GetControlFloat is used to retrieve a single Float from a hierarchy. | ||
| FRigUnit_GetControlInitialTransform | GetControlTransform is used to retrieve a single transform from a hierarchy. | ||
| FRigUnit_GetControlInteger | GetControlFloat is used to retrieve a single Integer from a hierarchy. | ||
| FRigUnit_GetControlRotator | GetControlRotator is used to retrieve a single Rotator from a hierarchy. | ||
| FRigUnit_GetControlTransform | GetControlTransform is used to retrieve a single transform from a hierarchy. | ||
| FRigUnit_GetControlVector | GetControlVector is used to retrieve a single Vector from a hierarchy, can be used for Controls of type "Position" or "Scale". | ||
| FRigUnit_GetControlVector2D | GetControlVector2D is used to retrieve a single Vector2D from a hierarchy. | ||
| FRigUnit_GetControlVisibility | GetControlVisibility is used to retrieve the visibility of a control | ||
| FRigUnit_GetCurveValue | GetCurveValue is used to retrieve a single float from a Curve | ||
| FRigUnit_GetFloatAnimationChannel | Get Float Channel is used to retrieve a control's animation channel value | ||
| FRigUnit_GetInitialBoneTransform | GetInitialBoneTransform is used to retrieve a single transform from a hierarchy. | ||
| FRigUnit_GetIntAnimationChannel | Get Int Channel is used to retrieve a control's animation channel value | ||
| FRigUnit_GetMetadataTags | Returns the metadata tags on an item | ||
| FRigUnit_GetRelativeBoneTransform | GetBoneTransform is used to retrieve a single transform from a hierarchy. | ||
| FRigUnit_GetRelativeTransformForItem | GetRelativeTransform is used to retrieve a single transform from a hierarchy in the space of another transform | ||
| FRigUnit_GetRotatorAnimationChannel | Get Rotator Channel is used to retrieve a control's animation channel value | ||
| FRigUnit_GetShapeTransform | GetShapeTransform is used to retrieve single control's shape transform. | ||
| FRigUnit_GetSpaceTransform | GetSpaceTransform is used to retrieve a single transform from a hierarchy. | ||
| FRigUnit_GetTransform | GetTransform is used to retrieve a single transform from a hierarchy. | ||
| FRigUnit_GetTransformAnimationChannel | Get Transform Channel is used to retrieve a control's animation channel value | ||
| FRigUnit_GetTransformArray | GetTransformArray is used to retrieve an array of transforms from the hierarchy. | ||
| FRigUnit_GetTransformItemArray | GetTransformArray is used to retrieve an array of transforms from the hierarchy. | ||
| FRigUnit_GetVector2DAnimationChannel | Get Vector2D Channel is used to retrieve a control's animation channel value | ||
| FRigUnit_GetVectorAnimationChannel | Get Vector Channel is used to retrieve a control's animation channel value | ||
| FRigUnit_HasMetadata | Returns true if a given item in the hierarchy has a specific set of metadata | ||
| FRigUnit_HasMetadataTag | Returns true if a given item in the hierarchy has a specific tag stored in the metadata | ||
| FRigUnit_HasMetadataTagArray | Returns true if a given item in the hierarchy has all of the provided tags | ||
| FRigUnit_Item | The Item node is used to share a specific item across the graph | ||
| FRigUnit_ItemArray | The Item Array node is used to share an array of items across the graph | ||
| FRigUnit_OffsetTransformForItem | Offset Transform is used to add an offset to an existing transform in the hierarchy. | ||
| FRigUnit_ParentSwitchConstraint | The Parent Switch Constraint is used to have an item follow one of multiple parents, and allowing to switch between the parent in question. | ||
| FRigUnit_ParentSwitchConstraintArray | The Parent Switch Constraint is used to have an item follow one of multiple parents, and allowing to switch between the parent in question. | ||
| FRigUnit_ProjectTransformToNewParent | Gets the relative offset between the child and the old parent, then multiplies by new parent's transform. | ||
| FRigUnit_PropagateTransform | Propagate Transform can be used to force a recalculation of a bone's global transform from its local - as well as propagating that change onto the children. | ||
| FRigUnit_RemoveAllMetadata | Removes an existing metadata filed from an item | ||
| FRigUnit_RemoveMetadata | Removes an existing metadata filed from an item | ||
| FRigUnit_RemoveMetadataTag | Removes a tag from an item | ||
| FRigUnit_SendEvent | SendEvent is used to notify the engine / editor of a change that happend within the Control Rig. | ||
| FRigUnit_SetAnimationChannelBase | Set Animation Channel is used to change a control's animation channel value | ||
| FRigUnit_SetBoneInitialTransform | SetBoneInitialTransform is used to perform a change in the hierarchy by setting a single bone's transform. | ||
| FRigUnit_SetBoneRotation | SetBoneRotation is used to perform a change in the hierarchy by setting a single bone's rotation. | ||
| FRigUnit_SetBoneTransform | SetBoneTransform is used to perform a change in the hierarchy by setting a single bone's transform. | ||
| FRigUnit_SetBoneTranslation | SetBoneTranslation is used to perform a change in the hierarchy by setting a single bone's Translation. | ||
| FRigUnit_SetBoolAnimationChannel | Set Bool Channel is used to set a control's animation channel value | ||
| FRigUnit_SetControlBool | SetControlBool is used to perform a change in the hierarchy by setting a single control's bool value. | ||
| FRigUnit_SetControlColor | SetControlColor is used to change the control's color | ||
| FRigUnit_SetControlDrivenList | SetControlDrivenList is used to change the list of affected controls of an indirect control | ||
| FRigUnit_SetControlFloat | SetControlFloat is used to perform a change in the hierarchy by setting a single control's float value. | ||
| FRigUnit_SetControlInteger | SetControlInteger is used to perform a change in the hierarchy by setting a single control's int32 value. | ||
| FRigUnit_SetControlOffset | SetControlOffset is used to perform a change in the hierarchy by setting a single control's transform. | ||
| FRigUnit_SetControlRotator | SetControlRotator is used to perform a change in the hierarchy by setting a single control's Rotator value. | ||
| FRigUnit_SetControlTransform | SetControlTransform is used to perform a change in the hierarchy by setting a single control's transform. | ||
| FRigUnit_SetControlVector | SetControlVector is used to perform a change in the hierarchy by setting a single control's Vector value. | ||
| FRigUnit_SetControlVector2D | SetControlVector2D is used to perform a change in the hierarchy by setting a single control's Vector2D value. | ||
| FRigUnit_SetControlVisibility | SetControlVisibility is used to change the visibility on a control at runtime | ||
| FRigUnit_SetCurveValue | SetCurveValue is used to perform a change in the curve container by setting a single Curve value. | ||
| FRigUnit_SetFloatAnimationChannel | Set Float Channel is used to set a control's animation channel value | ||
| FRigUnit_SetIntAnimationChannel | Set Int Channel is used to set a control's animation channel value | ||
| FRigUnit_SetMetadataTag | Sets a single tag on an item | ||
| FRigUnit_SetMetadataTagArray | Sets multiple tags on an item | ||
| FRigUnit_SetMultiControlBool | SetMultiControlBool is used to perform a change in the hierarchy by setting multiple controls' bool value. | ||
| FRigUnit_SetMultiControlBool_Entry | |||
| FRigUnit_SetMultiControlFloat | SetMultiControlFloat is used to perform a change in the hierarchy by setting multiple controls' float value. | ||
| FRigUnit_SetMultiControlFloat_Entry | |||
| FRigUnit_SetMultiControlInteger | SetMultiControlInteger is used to perform a change in the hierarchy by setting multiple controls' integer value. | ||
| FRigUnit_SetMultiControlInteger_Entry | |||
| FRigUnit_SetMultiControlRotator | SetMultiControlRotator is used to perform a change in the hierarchy by setting multiple controls' rotator value. | ||
| FRigUnit_SetMultiControlRotator_Entry | |||
| FRigUnit_SetMultiControlVector2D | SetMultiControlVector2D is used to perform a change in the hierarchy by setting multiple controls' vector2D value. | ||
| FRigUnit_SetMultiControlVector2D_Entry | |||
| FRigUnit_SetRelativeBoneTransform | SetRelativeBoneTransform is used to perform a change in the hierarchy by setting a single bone's transform. | ||
| FRigUnit_SetRelativeRotationForItem | SetRelativeRotation is used to set a single rotation from a hierarchy in the space of another item | ||
| FRigUnit_SetRelativeTransformForItem | SetRelativeTransform is used to set a single transform from a hierarchy in the space of another item | ||
| FRigUnit_SetRelativeTranslationForItem | SetRelativeTranslation is used to set a single translation from a hierarchy in the space of another item | ||
| FRigUnit_SetRotation | SetRotation is used to set a single rotation on hierarchy. | ||
| FRigUnit_SetRotatorAnimationChannel | Set Rotator Channel is used to set a control's animation channel value | ||
| FRigUnit_SetScale | SetScale is used to set a single scale on hierarchy. | ||
| FRigUnit_SetShapeTransform | SetShapeTransform is used to perform a change in the hierarchy by setting a single control's shape transform. | ||
| FRigUnit_SetSpaceInitialTransform | SetSpaceInitialTransform is used to perform a change in the hierarchy by setting a single space's initial transform. | ||
| FRigUnit_SetSpaceTransform | SetSpaceTransform is used to perform a change in the hierarchy by setting a single space's transform. | ||
| FRigUnit_SetTransform | SetTransform is used to set a single transform on hierarchy. | ||
| FRigUnit_SetTransformAnimationChannel | Set Transform Channel is used to set a control's animation channel value | ||
| FRigUnit_SetTransformArray | SetTransformArray is used to set an array of transforms on the hierarchy. | ||
| FRigUnit_SetTransformItemArray | SetTransformArray is used to set an array of transforms on the hierarchy. | ||
| FRigUnit_SetTranslation | SetTranslation is used to set a single translation on hierarchy. | ||
| FRigUnit_SetVector2DAnimationChannel | Set Vector2D Channel is used to set a control's animation channel value | ||
| FRigUnit_SetVectorAnimationChannel | Set Vector Channel is used to set a control's animation channel value | ||
| FRigUnit_SpaceName | SpaceName is used to represent a Space name in the graph | ||
| FRigUnit_ToRigSpace_Location | Converts a position / location from world space to rig (global) space | ||
| FRigUnit_ToRigSpace_Rotation | Converts a rotation from world space to rig (global) space | ||
| FRigUnit_ToRigSpace_Transform | Converts a transform from world space to rig (global) space | ||
| FRigUnit_ToWorldSpace_Location | Converts a position / location from rig (global) space to world space | ||
| FRigUnit_ToWorldSpace_Rotation | Converts a rotation from rig (global) space to world space | ||
| FRigUnit_ToWorldSpace_Transform | Converts a transform from rig (global) space to world space | ||
| FRigUnit_UnsetCurveValue | UnsetCurveValue is used to perform a change in the curve container by invalidating a single Curve value. |