1. Epic GamesDeveloper
  3. Execution

Execution

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units

Classes

  Type Name Description
Public struct UStruct meta FRigUnit_AddParent Adds a new parent to an element.  
Public struct UStruct meta FRigUnit_BeginExecution Event for driving the skeleton hierarchy with variables and rig elements  
Public struct UStruct meta FRigUnit_CollectionAddItem Adds an element to an existing collection  
Public struct UStruct meta FRigUnit_CollectionBase    
Public struct UStruct meta FRigUnit_CollectionBaseMutable    
Public struct UStruct meta FRigUnit_CollectionChain Creates a collection based on a first and last item within a chain.  
Public struct UStruct meta FRigUnit_CollectionChainArray Creates an item array based on a first and last item within a chain.  
Public struct UStruct meta FRigUnit_CollectionChildren Creates a collection based on the direct or recursive children of a provided parent item.  
Public struct UStruct meta FRigUnit_CollectionChildrenArray Creates an item array based on the direct or recursive children of a provided parent item.  
Public struct UStruct meta FRigUnit_CollectionCount Returns the number of elements in a collection  
Public struct UStruct meta FRigUnit_CollectionDifference Returns the difference between two collections (the items present in A but not in B).  
Public struct UStruct meta FRigUnit_CollectionGetAll Creates an item array for all elements given the filter.  
Public struct UStruct meta FRigUnit_CollectionGetItems Returns an array of items provided a collection  
Public struct UStruct meta FRigUnit_CollectionGetParentIndices Returns an array of relative parent indices for each item.  
Public struct UStruct meta FRigUnit_CollectionGetParentIndicesItemArray Returns an array of relative parent indices for each item.  
Public struct UStruct meta FRigUnit_CollectionIntersection Returns the intersection of two provided collections (the items present in both A and B).  
Public struct UStruct meta FRigUnit_CollectionItemAtIndex Returns a single item within a collection by index  
Public struct UStruct meta FRigUnit_CollectionItems Returns a collection provided a specific array of items.  
Public struct UStruct meta FRigUnit_CollectionLoop Given a collection of items, execute iteratively across all items in a given collection  
Public struct UStruct meta FRigUnit_CollectionNameSearch Creates a collection based on a name search. The name search is case sensitive.  
Public struct UStruct meta FRigUnit_CollectionNameSearchArray Creates an item array based on a name search. The name search is case sensitive.  
Public struct UStruct meta FRigUnit_CollectionReplaceItems Replaces all names within the collection  
Public struct UStruct meta FRigUnit_CollectionReplaceItemsArray Replaces all names within the item array  
Public struct UStruct meta FRigUnit_CollectionReverse Returns the collection in reverse order  
Public struct UStruct meta FRigUnit_CollectionUnion Returns the union of two provided collections (the combination of all items from both A and B).  
Public struct UStruct meta FRigUnit_DynamicHierarchyBase    
Public struct UStruct meta FRigUnit_DynamicHierarchyBaseMutable    
Public struct UStruct meta FRigUnit_GetCurrentNameSpace Returns the currently used namespace of the module.  
Public struct UStruct meta FRigUnit_GetItemNameSpace Returns the namespace of a given item.  
Public struct UStruct meta FRigUnit_GetItemShortName Returns the short name of the given item (without the namespace)  
Public struct UStruct meta FRigUnit_GetItemsInNameSpace Returns all items (based on a filter) in the current namespace.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddAnimationChannel2DLimitSettings    
Public struct UStruct meta FRigUnit_HierarchyAddAnimationChannelBool Adds a new animation channel to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddAnimationChannelEmptyLimitSettings    
Public struct UStruct meta FRigUnit_HierarchyAddAnimationChannelFloat Adds a new animation channel to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_HierarchyAddAnimationChannelInteger Adds a new animation channel to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_HierarchyAddAnimationChannelRotator Adds a new animation channel to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddAnimationChannelRotatorLimitSettings    
Public struct UStruct meta FRigUnit_HierarchyAddAnimationChannelScaleFloat Adds a new animation channel to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_HierarchyAddAnimationChannelScaleVector Adds a new animation channel to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddAnimationChannelSingleLimitSettings    
Public struct UStruct meta FRigUnit_HierarchyAddAnimationChannelVector Adds a new animation channel to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_HierarchyAddAnimationChannelVector2D Adds a new animation channel to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddAnimationChannelVectorLimitSettings    
Public struct UStruct meta FRigUnit_HierarchyAddBone Adds a new bone to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControl_ProxySettings    
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControl_Settings    
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControl_ShapeSettings    
Public struct UStruct meta FRigUnit_HierarchyAddControlElement Adds a new control to the hierarchy  
Public struct UStruct meta FRigUnit_HierarchyAddControlFloat Adds a new control to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlFloat_LimitSettings    
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlFloat_Settings    
Public struct UStruct meta FRigUnit_HierarchyAddControlInteger Adds a new control to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlInteger_LimitSettings    
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlInteger_Settings    
Public struct UStruct meta FRigUnit_HierarchyAddControlRotator Adds a new control to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlRotator_LimitSettings    
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlRotator_Settings    
Public struct UStruct meta FRigUnit_HierarchyAddControlTransform Adds a new control to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlTransform_LimitSettings    
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlTransform_Settings    
Public struct UStruct meta FRigUnit_HierarchyAddControlVector Adds a new control to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlVector_LimitSettings    
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlVector_Settings    
Public struct UStruct meta FRigUnit_HierarchyAddControlVector2D Adds a new control to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlVector2D_LimitSettings    
Public struct UStruct BlueprintType FRigUnit_HierarchyAddControlVector2D_Settings    
Public struct UStruct meta FRigUnit_HierarchyAddElement    
Public struct UStruct meta FRigUnit_HierarchyAddNull Adds a new null to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_HierarchyAddPhysicsJoint Adds a new physics joint to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_HierarchyAddPhysicsSolver Adds a new physics solver to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_HierarchyAddSocket Adds a new socket to the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_HierarchyBase    
Public struct UStruct meta FRigUnit_HierarchyBaseMutable    
Public struct UStruct meta FRigUnit_HierarchyCreatePoseItemArray Creates the hierarchy's pose  
Public struct UStruct BlueprintType FRigUnit_HierarchyCreatePoseItemArray_Entry    
Public struct UStruct meta FRigUnit_HierarchyGetChainItemArray Returns a chain between two items  
Public struct UStruct meta FRigUnit_HierarchyGetChildren Returns the item's children  
Public struct UStruct meta FRigUnit_HierarchyGetParent Returns the item's parent  
Public struct UStruct meta FRigUnit_HierarchyGetParents Returns the item's parents  
Public struct UStruct meta FRigUnit_HierarchyGetParentsItemArray Returns the item's parents  
Public struct UStruct meta FRigUnit_HierarchyGetParentWeights Returns the item's parents' weights  
Public struct UStruct meta FRigUnit_HierarchyGetParentWeightsArray Returns the item's parents' weights  
Public struct UStruct meta FRigUnit_HierarchyGetPose Returns the hierarchy's pose  
Public struct UStruct meta FRigUnit_HierarchyGetPoseItemArray Returns the hierarchy's pose  
Public struct UStruct meta FRigUnit_HierarchyGetShapeSettings Retrieves the shape settings of a control  
Public struct UStruct meta FRigUnit_HierarchyGetSiblings Returns the item's siblings  
Public struct UStruct meta FRigUnit_HierarchyGetSiblingsItemArray Returns the item's siblings  
Public struct UStruct meta FRigUnit_HierarchyImportFromSkeleton Imports all bones (and curves) from the currently assigned skeleton.  
Public struct UStruct meta FRigUnit_HierarchyRemoveElement Removes an element from the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_HierarchyReset Removes all elements from the hierarchy Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_HierarchySetParentWeights Sets the item's parents' weights  
Public struct UStruct meta FRigUnit_HierarchySetPose Sets the hierarchy's pose  
Public struct UStruct meta FRigUnit_HierarchySetPoseItemArray Sets the hierarchy's pose  
Public struct UStruct meta FRigUnit_HierarchySetShapeSettings Changes the shape settings of a control Note: This node only runs as part of the construction event.  
Public struct UStruct meta FRigUnit_InteractionExecution Event for executing logic during an interaction  
Public struct UStruct meta FRigUnit_InverseExecution Event for driving elements based off the skeleton hierarchy  
Public struct UStruct meta FRigUnit_IsInteracting Returns true if the Control Rig is being interacted  
Public struct UStruct meta FRigUnit_IsItemInCurrentNameSpace Returns true if the given item has been created by this module, which means that the item's namespace is the module namespace.  
Public struct UStruct meta FRigUnit_ItemBase    
Public struct UStruct meta FRigUnit_ItemBaseMutable    
Public struct UStruct meta FRigUnit_ItemEquals Returns true if the two items are equal  
Public struct UStruct meta FRigUnit_ItemExists Returns true or false if a given item exists  
Public struct UStruct meta FRigUnit_ItemNotEquals Returns true if the two items are not equal  
Public struct UStruct meta FRigUnit_ItemReplace Replaces the text within the name of the item  
Public struct UStruct meta FRigUnit_ItemToName Casts the provided item key to its name  
Public struct UStruct meta FRigUnit_ItemTypeEquals Returns true if the two items' types are equal  
Public struct UStruct meta FRigUnit_ItemTypeNotEquals Returns true if the two items's types are not equal  
Public struct UStruct meta FRigUnit_PoseGetCurve Returns the hierarchy's pose curve value  
Public struct UStruct meta FRigUnit_PoseGetDelta Compares two pose caches and compares their values.  
Public struct UStruct meta FRigUnit_PoseGetItems Returns the items in the hierarchy pose  
Public struct UStruct meta FRigUnit_PoseGetItemsItemArray Returns the items in the hierarchy pose  
Public struct UStruct meta FRigUnit_PoseGetTransform Returns the hierarchy's pose transform  
Public struct UStruct meta FRigUnit_PoseGetTransformArray Returns an array of transforms from a given hierarchy pose  
Public struct UStruct meta FRigUnit_PoseIsEmpty Returns true if the hierarchy pose is empty (has no items)  
Public struct UStruct meta FRigUnit_PoseLoop Given a pose, execute iteratively across all items in the pose  
Public struct UStruct meta FRigUnit_PostBeginExecution Event always executed after the forward solve  
Public struct UStruct meta FRigUnit_PostPrepareForExecution Event to further configure elements. Runs after the Construction Event  
Public struct UStruct meta FRigUnit_PreBeginExecution Event always executed before the forward solve  
Public struct UStruct meta FRigUnit_PrepareForExecution Event to create / configure elements before any other event  
Public struct UStruct meta FRigUnit_ResolveConnector Returns the resolved item of the connector.  
Public struct UStruct meta FRigUnit_RigModulesBase    
Public struct UStruct meta FRigUnit_RigModulesBaseMutable    
Public struct UStruct meta FRigUnit_SequenceExecution Allows for a single execution pulse to trigger a series of events in order.  
Public struct UStruct meta FRigUnit_SetChannelHosts Allows an animation channel to be hosted by multiple controls  
Public struct UStruct meta FRigUnit_SetDefaultParent Changes the default parent for an item - this removes all other current parents.  
Public struct UStruct meta FRigUnit_SwitchParent Switches an element to a new parent.  

Enums

  Type Name Description
Public enum UEnum meta ERigSwitchParentMode    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page