1. Epic GamesDeveloper
  3. URigHierarchy

URigHierarchy

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Rigs

Inheritance Hierarchy

References

   
Module ControlRig
Header /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h
Include #include "Rigs/RigHierarchy.h"

Syntax

UCLASS&40;BlueprintType&41;  
class URigHierarchy : public UObject

Variables

  Type Name Description
Protected variable bool bEnableCacheValidityCheck  
Protected variable bool bUpdatePreferedEulerAngleWhenSettingTransform  
Protected variable TMap< FRigElementKey, FRigElementKey > DefaultParentPerElement  
Protected variable UProperty Transient TObjectPtr< URigHierarchy > HierarchyForCacheValidation  
Protected variable int32 TraceFramesCaptured  
Protected variable int32 TraceFramesLeft  
Protected variable TMap< FName, FRigPose > TracePoses  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const void

AddCachedCollection ( uint32 InHash,
const FRigElementKeyCollection& InCollection
)

  
Public function TArray< FRigBaseElement * >::RangedForIteratorType

begin ()

 Iterators
Public function bool

CanSwitchToParent ( FRigElementKey InChild,
FRigElementKey InParent,
const TElementDependencyMap& InDependencyMap,
FString* OutFailureReason
)

 Determines if the element can be switched to a provided parent
Public function Static void Updates the format for trace floating point numbers
Public function void Cleans up caches after load
Public function void  
Public function Const bool

Contains ( const FRigElementKey& InKey
)

 Returns true if the provided element key is valid as a certain typename
Public function Const bool

Contains ( const FRigElementKey& InKey
)

 Returns true if the provided element key is valid
Public function Const UFunction BlueprintCallable, Category, Meta bool Returns true if the provided element key is valid
Public function UFunction BlueprintCallable, Category void

CopyHierarchy ( URigHierarchy* InHierarchy
)

 Copies the contents of a hierarchy onto this one
Public function UFunction BlueprintCallable, Category void

CopyPose ( URigHierarchy* InHierarchy,
bool bCurrent,
bool bInitial,
bool bWeights,
bool bMatchPoseInGlobalIfNeeded
)

 Copies the contents of a hierarchy onto this one
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function void Dumps the content of the transform stack to a string
Public function TArray< FRigBaseElement * >::RangedForIteratorType

end ()

  
Public function void Starts an interaction on the rig. This will cause all transform actions happening to be merged
Public function Const void Performs validation of the cache within the hierarchy on any mutation.
Public function Const const T *

Find ( const FRigElementKey& InKey
)

 Returns an element for a given key or nullptr.
Public function T *

Find ( const FRigElementKey& InKey
)

 Returns an element for a given key or nullptr.
Public function Const const FRigBaseElement *

Find ( const FRigElementKey& InKey
)

 Returns an element for a given key or nullptr.
Public function FRigBaseElement *

Find ( const FRigElementKey& InKey
)

 Returns an element for a given key or nullptr.
Public function Const const FRigElementKeyCollection *

FindCachedCollection ( uint32 InHash
)

  
Public function Const const T *

FindChecked ( const FRigElementKey& InKey
)

 Returns an element for a given key.
Public function FRigBaseElement *

FindChecked ( const FRigElementKey& InKey
)

 Returns an element for a given key and raises for invalid results.
Public function Const const FRigBaseElement *

FindChecked ( const FRigElementKey& InKey
)

 Returns an element for a given key and raises for invalid results.
Public function T *

FindChecked ( const FRigElementKey& InKey
)

 Returns an element for a given key.
Public function Const FRigElementKeyCollection &

FindOrAddCachedCollection ( uint32 InHash
)

  
Protected function Static ERigElementType

FlatIndexToRigElementType ( int32 InIndex
)

  
Public function Const void

ForEach ( TFunction< bool(FRigBaseElement*)> PerElementFunction
)

 Iterator function to invoke a lambda / TFunction for each element
Public function Const void

ForEach ( TFunction< bool(T*)> PerElementFunction
)

 Filtered template Iterator function to invoke a lambda / TFunction for each element of a given type.
Public function FRigBaseElement *

Get ( int32 InIndex
)

 Returns an element at a given index or nullptr.
Public function Const const T *

Get ( int32 InIndex
)

 Returns an element at a given index or nullptr.
Public function T *

Get ( int32 InIndex
)

 Returns an element at a given index or nullptr.
Public function Const const FRigBaseElement *

Get ( int32 InIndex
)

 Returns an element at a given index or nullptr.
Public function Const FRigElementKey

GetActiveParent ( const FRigElementKey& InKey
)

 Get the current active for the passed in key.
Public function Const TArray< FRigElementKey >

GetAllKeys ( bool bTraverse,
ERigElementType InElementType
)

 Returns all element keys of this hierarchy
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FRigElementKey >

GetAllKeys_ForBlueprint ( bool bTraverse
)

 Returns all element keys of this hierarchy
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FRigElementKey >

GetBoneKeys ( bool bTraverse
)

 Returns all Bone elements
Public function Const TArray< FRigBoneElement * >

GetBones ( bool bTraverse
)

 Returns all Bone elements
Public function Const UFunction BlueprintPure, Category TArray< bool >

GetBoolArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Queries and returns the value of bool array metadata
Public function Const UFunction BlueprintPure, Category bool

GetBoolMetadata ( FRigElementKey InItem,
FName InMetadataName,
bool DefaultValue
)

 Queries and returns the value of bool metadata
Public function Const const T *

GetChecked ( int32 InIndex
)

 Returns an element at a given index.
Public function T *

GetChecked ( int32 InIndex
)

 Returns an element at a given index.
Public function Const UFunction BlueprintCallable, Category TArray< FRigElementKey >

GetChildren ( FRigElementKey InKey,
bool bRecursive
)

 Returns the child elements of a given element key
Public function Const FRigBaseElementChildrenArray

GetChildren ( const FRigBaseElement* InElement,
bool bRecursive
)

 Returns the child elements of a given element
Public function Const TArray< int32 >

GetChildren ( int32 InIndex,
bool bRecursive
)

 Returns the child elements of a given element index
Public function Const const FRigBaseElementChildrenArray &

GetChildren ( const FRigBaseElement* InElement
)

 Returns the child elements of a given element
Public function Const FVector

GetControlAnglesFromQuat ( const FRigControlElement* InControlElement,
const FQuat& InQuat
)

  
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FRigElementKey >

GetControlKeys ( bool bTraverse
)

 Returns all Control elements
Public function UFunction BlueprintCallable, Category URigHierarchyController *

GetController ( bool bCreateIfNeeded
)

 Returns a controller for this hierarchy.
Public function Const FTransform

GetControlOffsetTransform ( FRigControlElement* InControlElement,
const ERigTransformType::Type InTransformType
)

 Returns the global offset transform for a given control element.
Public function Const FString

GetControlPinDefaultValue ( FRigControlElement* InControlElement,
bool bForEdGraph,
ERigControlValueType InValueType
)

 Returns the default value to use for a pin for a control
Public function Const FEdGraphPinType

GetControlPinType ( FRigControlElement* InControlElement
)

 Returns the pin type to use for a control
Public function Const FVector

GetControlPreferredEulerAngles ( const FRigControlElement* InControlElement,
EEulerRotationOrder InRotationOrder,
bool bInitial
)

 Returns a control's preferred euler angles (local transform rotation)
Public function Const UFunction BlueprintCallable, Category FVector

GetControlPreferredEulerAngles ( FRigElementKey InKey,
EEulerRotationOrder InRotationOrder,
bool bInitial
)

 Returns a control's preferred euler angles (local transform rotation)
Public function Const UFunction BlueprintCallable, Category FVector

GetControlPreferredEulerAnglesByIndex ( int32 InElementIndex,
EEulerRotationOrder InRotationOrder,
bool bInitial
)

 Returns a control's preferred euler angles (local transform rotation)
Public function Const EEulerRotationOrder

GetControlPreferredEulerRotationOrder ( const FRigControlElement* InControlElement,
bool bFromSettings
)

 Returns a control's preferred euler rotation order
Public function Const UFunction BlueprintCallable, Category EEulerRotationOrder Returns a control's preferred euler rotation order
Public function Const UFunction BlueprintCallable, Category EEulerRotationOrder

GetControlPreferredEulerRotationOrderByIndex ( int32 InElementIndex,
bool bFromSettings
)

 Returns a control's preferred euler rotation order
Public function Const UFunction BlueprintCallable, Category FRotator

GetControlPreferredRotator ( FRigElementKey InKey,
bool bInitial
)

 Returns a control's preferred rotator (local transform rotation)
Public function Const FRotator

GetControlPreferredRotator ( const FRigControlElement* InControlElement,
bool bInitial
)

 Returns a control's preferred rotator (local transform rotation)
Public function Const UFunction BlueprintCallable, Category FRotator

GetControlPreferredRotatorByIndex ( int32 InElementIndex,
bool bInitial
)

 Returns a control's preferred rotator (local transform rotation)
Public function Const FQuat

GetControlQuaternion ( const FRigControlElement* InControlElement,
const FVector& InEulerAngle
)

  
Public function Const TArray< FRigControlElement * >

GetControls ( bool bTraverse
)

 Returns all Control elements
Public function Const FTransform

GetControlShapeTransform ( FRigControlElement* InControlElement,
const ERigTransformType::Type InTransformType
)

 Returns the global shape transform for a given control element.
Public function Const FVector

GetControlSpecifiedEulerAngle ( const FRigControlElement* InControlElement,
bool bIsInitial
)

  
Public function Const T

GetControlValue ( FRigControlElement* InControlElement,
ERigControlValueType InValueType
)

  
Public function Const T Returns a control's current value given its key
Public function Const FRigControlValue

GetControlValue ( int32 InElementIndex,
ERigControlValueType InValueType
)

 Returns a control's current value given its index
Public function Const T

GetControlValue ( int32 InElementIndex,
ERigControlValueType InValueType
)

 Returns a control's current value given its index
Public function Const FRigControlValue

GetControlValue ( FRigControlElement* InControlElement,
ERigControlValueType InValueType
)

 Returns a control's current value
Public function Const FVector2D

GetControlValue ( FRigControlElement* InControlElement,
ERigControlValueType InValueType
)

  
Public function Const UFunction BlueprintCallable, Category FRigControlValue Returns a control's current value given its key
Public function Const UFunction BlueprintCallable, Category FRigControlValue

GetControlValueByIndex ( int32 InElementIndex,
ERigControlValueType InValueType
)

 Returns a control's current value given its index
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FRigElementKey > Returns all Curve elements
Public function Const TArray< FRigCurveElement * > Returns all Curve elements
Public function Const float

GetCurveValue ( FRigCurveElement* InCurveElement
)

 Returns a curve's value. If the curve value is not set, returns
Public function Const float

GetCurveValue ( int32 InElementIndex
)

 TODO: Deprecate?
Public function Const UFunction BlueprintCallable, Category float Returns a curve's value given its key
Public function Const UFunction BlueprintCallable, Category float

GetCurveValueByIndex ( int32 InElementIndex
)

 Returns a curve's value given its index
Public function URigHierarchy * Returns the default hierarchy for this hierarchy (or nullptr)
Public function Const UFunction BlueprintCallable, Category FRigElementKey Returns the default parent element's key of a given child key
Public function Static FRigElementKey  
Public function Const TElementDependencyMap

GetDependenciesForVM ( const URigVM* InVM,
FName InEventName
)

  
Public function Const TArray< T * >

GetElementsOfType ( bool bTraverse
)

 Filtered accessor to retrieve all elements of a given type
Public function Static UFunction BlueprintCallable, Category FEulerTransform Returns the contained FEulerTransform value from a a Rig Control Value
Public function Const TArray< T * >

GetFilteredElements ( TFunction< bool(T*)> InKeepElementFunction,
bool bTraverse
)

 Filtered accessor to retrieve all elements of a given type
Public function Const UFunction BlueprintCallable, Category FRigElementKey Returns the first parent element of a given element key
Public function Const int32

GetFirstParent ( int32 InIndex
)

 Returns the first parent element of a given element index
Public function Const FRigBaseElement *

GetFirstParent ( const FRigBaseElement* InElement
)

 Returns the first parent element of a given element
Public function Const UFunction BlueprintPure, Category TArray< float >

GetFloatArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Queries and returns the value of float array metadata
Public function Static UFunction BlueprintCallable, Category float Returns the contained float value from a a Rig Control Value
Public function Const UFunction BlueprintPure, Category float

GetFloatMetadata ( FRigElementKey InItem,
FName InMetadataName,
float DefaultValue
)

 Queries and returns the value of float metadata
Public function Const UFunction BlueprintCallable, Category FTransform Returns the global offset transform for a given control element.
Public function Const UFunction BlueprintCallable, Category FTransform

GetGlobalControlOffsetTransformByIndex ( int32 InElementIndex,
bool bInitial
)

 Returns the global offset transform for a given control element.
Public function Const UFunction BlueprintCallable, Category FTransform Returns the global shape transform for a given control element.
Public function Const UFunction BlueprintCallable, Category FTransform

GetGlobalControlShapeTransformByIndex ( int32 InElementIndex,
bool bInitial
)

 Returns the global shape transform for a given control element.
Public function Const FTransform

GetGlobalTransform ( int32 InElementIndex
)

  
Public function Const UFunction BlueprintCallable, Category FTransform

GetGlobalTransform ( FRigElementKey InKey,
bool bInitial
)

 Returns the global current or initial value for a given key.
Public function Const UFunction BlueprintCallable, Category FTransform

GetGlobalTransformByIndex ( int32 InElementIndex,
bool bInitial
)

 Returns the global current or initial value for a element index.
Public function Const FRigElementHandle

GetHandle ( const FRigElementKey& InKey
)

 Returns a handle to an existing element
Public function Const int32

GetIndex ( const FRigElementKey& InKey
)

 Returns the index of an element given its key
Public function Const UFunction BlueprintCallable, Category, Meta int32 Returns the index of an element given its key
Public function Const TArray< int32 >

GetIndices ( const TArray< FRigElementKey >& InKeys
)

 Returns the indices of an array of keys
Public function Const T

GetInitialControlValue ( int32 InElementIndex
)

 Returns a control's initial value given its index
Public function Const FRigControlValue

GetInitialControlValue ( int32 InElementIndex
)

 Returns a control's initial value given its index
Public function Const FTransform  
Public function Const FTransform

GetInitialGlobalTransform ( int32 InElementIndex
)

  
Public function Const FTransform

GetInitialLocalTransform ( int32 InElementIndex
)

  
Public function Const FTransform  
Public function Const UFunction BlueprintPure, Category TArray< int32 >

GetInt32ArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Queries and returns the value of int32 array metadata
Public function Const UFunction BlueprintPure, Category int32

GetInt32Metadata ( FRigElementKey InItem,
FName InMetadataName,
int32 DefaultValue
)

 Queries and returns the value of int32 metadata
Public function Static UFunction BlueprintCallable, Category int32 Returns the contained int32 value from a a Rig Control Value
Public function Const UFunction BlueprintCallable, Category FRigElementKey

GetKey ( int32 InElementIndex
)

 Returns the key of an element given its index
Public function Const UFunction BlueprintCallable, Category TArray< FRigElementKey >

GetKeys ( const TArray< int32 > InElementIndices
)

 Returns the keys of an array of indices
Public function Const TArray< FRigElementKey >

GetKeysByPredicate ( TFunctionRef< bool(const FRigBaseElement&)> InPredicateFunc,
bool bInTraverse
)

 Returns element keys of this hierarchy, filtered by a predicate.
Public function Const TArray< FRigElementKey >

GetKeysOfType ( bool bTraverse
)

 Filtered accessor to retrieve all element keys of a given type
Public function Const UFunction BlueprintPure, Category TArray< FLinearColor >

GetLinearColorArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Queries and returns the value of FLinearColor array metadata
Public function Const UFunction BlueprintPure, Category FLinearColor

GetLinearColorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FLinearColor DefaultValue
)

 Queries and returns the value of FLinearColor metadata
Public function Const UFunction BlueprintCallable, Category FTransform Returns the local shape transform for a given control element.
Public function Const UFunction BlueprintCallable, Category FTransform

GetLocalControlShapeTransformByIndex ( int32 InElementIndex,
bool bInitial
)

 Returns the local shape transform for a given control element.
Public function Const int32

GetLocalIndex ( const FRigElementKey& InKey
)

 Returns the index of an element given its key within its default parent (or root)
Public function Const int32

GetLocalIndex ( const FRigBaseElement* InElement
)

 Returns the index of an element given its key within its default parent (or root)
Public function Const UFunction BlueprintCallable, Category, Meta int32 Returns the index of an element given its key within its default parent (or root)
Public function Const UFunction BlueprintCallable, Category FTransform

GetLocalTransform ( FRigElementKey InKey,
bool bInitial
)

 Returns the local current or initial value for a given key.
Public function Const FTransform

GetLocalTransform ( int32 InElementIndex
)

  
Public function Const UFunction BlueprintCallable, Category FTransform

GetLocalTransformByIndex ( int32 InElementIndex,
bool bInitial
)

 Returns the local current or initial value for a element index.
Public function Static int32 Returns the max allowed length for a name within the hierarchy.
Public function UFunction BlueprintPure, Category TArray< FName > Returns the name of metadata for a given element
Public function Const uint16 Returns the metadata tag version of this hierarchy
Public function UFunction BlueprintPure, Category ERigMetadataType

GetMetadataType ( FRigElementKey InItem,
FName InMetadataName
)

 Returns the type of metadata given its name the item it is stored under
Public function Const uint16 Returns the metadata version of this hierarchy
Public function Const UFunction BlueprintPure, Category TArray< FName >

GetNameArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Queries and returns the value of FName array metadata
Public function Const uint32 Returns a hash for the hierarchy representing all names as well as the topology version.
Public function Const UFunction BlueprintPure, Category FName

GetNameMetadata ( FRigElementKey InItem,
FName InMetadataName,
FName DefaultValue
)

 Queries and returns the value of FName metadata
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FRigElementKey >

GetNullKeys ( bool bTraverse
)

 Returns all Null elements
Public function Const TArray< FRigNullElement * >

GetNulls ( bool bTraverse
)

 Returns all Null elements
Public function Const int32

GetNumberOfParents ( int32 InIndex
)

 Returns the number of parents of an element
Public function Const UFunction BlueprintCallable, Category int32 Returns the number of parents of an element
Public function Const int32

GetNumberOfParents ( const FRigBaseElement* InElement
)

 Returns the number of parents of an element
Public function FRigElementKey Adds the world space reference or returns it
Public function Const UFunction BlueprintCallable, Category TArray< FRigElementKey >

GetParents ( FRigElementKey InKey,
bool bRecursive
)

 Returns the parent elements of a given element key
Public function Const TArray< int32 >

GetParents ( int32 InIndex,
bool bRecursive
)

 Returns the parent elements of a given element index
Public function Const FRigBaseElementParentArray

GetParents ( const FRigBaseElement* InElement,
bool bRecursive
)

 Returns the parent elements of a given element
Public function Const UFunction BlueprintCallable, Category FTransform

GetParentTransform ( FRigElementKey InKey,
bool bInitial
)

 Returns the global current or initial value for a given key.
Public function Const FTransform

GetParentTransform ( FRigBaseElement* InElement,
const ERigTransformType::Type InTransformType
)

 Returns a transform for a given element's parent based on the transform type If the element does not have a parent FTransform::Identity will be returned.
Public function Const UFunction BlueprintCallable, Category FTransform

GetParentTransformByIndex ( int32 InElementIndex,
bool bInitial
)

 Returns the global current or initial value for a given element index.
Public function Const UFunction BlueprintCallable, Category FRigElementWeight

GetParentWeight ( FRigElementKey InChild,
FRigElementKey InParent,
bool bInitial
)

 Returns the weight of a parent below a multi parent element
Public function Const FRigElementWeight

GetParentWeight ( const FRigBaseElement* InChild,
const FRigBaseElement* InParent,
bool bInitial
)

 Returns the weight of a parent below a multi parent element
Public function Const FRigElementWeight

GetParentWeight ( const FRigBaseElement* InChild,
int32 InParentIndex,
bool bInitial
)

 Returns the weight of a parent below a multi parent element
Public function Const UFunction BlueprintCallable, Category TArray< FRigElementWeight >

GetParentWeightArray ( FRigElementKey InChild,
bool bInitial
)

 Returns the weights of all parents below a multi parent element
Public function Const TArray< FRigElementWeight >

GetParentWeightArray ( const FRigBaseElement* InChild,
bool bInitial
)

 Returns the weights of all parents below a multi parent element
Public function Const UFunction BlueprintCallable, Category FRigPose

GetPose ( bool bInitial
)

 Returns the current / initial pose of the hierarchy
Public function Const FRigPose

GetPose ( bool bInitial,
ERigElementType InElementType,
const FRigElementKeyCollection& InItems
)

 Returns the current / initial pose of the hierarchy
Public function Const FRigPose

GetPose ( bool bInitial,
ERigElementType InElementType,
const TArrayView< const FRigElementKey >& InItems
)

 Returns the current / initial pose of the hierarchy
Public function Const UFunction BlueprintCallable, Category FName

GetPreviousName ( const FRigElementKey& InKey
)

 Returns the previous name of an element prior to a rename operation
Public function Const UFunction BlueprintCallable, Category FRigElementKey Returns the previous parent of an element prior to a reparent operation
Public function Const UFunction BlueprintPure, Category TArray< FQuat >

GetQuatArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Queries and returns the value of FQuat array metadata
Public function Const UFunction BlueprintPure, Category FQuat

GetQuatMetadata ( FRigElementKey InItem,
FName InMetadataName,
FQuat DefaultValue
)

 Queries and returns the value of FQuat metadata
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FRigElementKey >

GetReferenceKeys ( bool bTraverse
)

 Returns all references
Public function Const TArray< FRigReferenceElement * >

GetReferences ( bool bTraverse
)

 Returns all references
Public function Const UFunction BlueprintPure, Category TArray< FRigElementKey > Queries and returns the value of FRigElementKey array metadata
Public function Const UFunction BlueprintPure, Category FRigElementKey

GetRigElementKeyMetadata ( FRigElementKey InItem,
FName InMetadataName,
FRigElementKey DefaultValue
)

 Queries and returns the value of FRigElementKey metadata
Public function Const TArray< FRigRigidBodyElement * >

GetRigidBodies ( bool bTraverse
)

 Returns all RigidBody elements
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FRigElementKey >

GetRigidBodyKeys ( bool bTraverse
)

 Returns all RigidBody elements
Public function Const UFunction BlueprintCallable, Category, Meta TArray< FRigElementKey > Returns all root element keys
Public function Const TArray< FRigBaseElement * > Returns all root elements
Public function Const UFunction BlueprintPure, Category TArray< FRotator >

GetRotatorArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Queries and returns the value of FRotator array metadata
Public function Static UFunction BlueprintCallable, Category FRotator Returns the contained FRotator value from a a Rig Control Value
Public function Const UFunction BlueprintPure, Category FRotator

GetRotatorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FRotator DefaultValue
)

 Queries and returns the value of FRotator metadata
Public function Const FName

GetSafeNewDisplayName ( const FRigElementKey& InParentElement,
const FString& InPotentialNewDisplayName
)

 Returns a valid new display name for a control
Public function Const FName

GetSafeNewName ( const FString& InPotentialNewName,
ERigElementType InType
)

 Returns a valid new name for a to-be-added element.
Public function Static FName

GetSanitizedName ( const FString& InName
)

 Sanitizes a name by removing invalid characters.
Public function Const TArray< const FRigBaseElement * > Returns the selected elements The types to retrieve the selection for
Public function Const UFunction BlueprintCallable, Category TArray< FRigElementKey >

GetSelectedKeys ( ERigElementType InTypeFilter
)

 Returns the keys of selected elements The types to retrieve the selection for
Public function bool & Returns a reference to the suspend notifications flag
Public function Const UFunction BlueprintPure, Category TArray< FName >

GetTags ( FRigElementKey InItem
)

 Returns the tags for a given item
Public function Const uint32

GetTopologyHash ( bool bIncludeTopologyVersion,
bool bIncludeTransientControls
)

 Returns a hash representing the topological state of the hierarchy
Public function Const uint16 Returns the topology version of this hierarchy
Public function Const FTransform

GetTransform ( FRigTransformElement* InTransformElement,
const ERigTransformType::Type InTransformType
)

 Returns a transform based on a given transform type
Public function Const UFunction BlueprintPure, Category TArray< FTransform >

GetTransformArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Queries and returns the value of FTransform array metadata
Public function Static UFunction BlueprintCallable, Category FTransform Returns the contained FTransform value from a a Rig Control Value
Public function Const UFunction BlueprintPure, Category FTransform

GetTransformMetadata ( FRigElementKey InItem,
FName InMetadataName,
FTransform DefaultValue
)

 Queries and returns the value of FTransform metadata
Public function Static UFunction BlueprintCallable, Category FTransformNoScale Returns the contained FTransformNoScale value from a a Rig Control Value
Public function Const int32 Returns the transform stack index
Public function Const TArray< FRigControlElement * > Returns all transient Control elements
Public function Const bool

GetUsePreferredRotationOrder ( const FRigControlElement* InControlElement
)

  
Public function Static UFunction BlueprintCallable, Category FVector2D Returns the contained FVector2D value from a a Rig Control Value
Public function Const UFunction BlueprintPure, Category TArray< FVector >

GetVectorArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Queries and returns the value of FVector array metadata
Public function Static UFunction BlueprintCallable, Category FVector Returns the contained FVector value from a a Rig Control Value
Public function Const UFunction BlueprintPure, Category FVector

GetVectorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FVector DefaultValue
)

 Queries and returns the value of FVector metadata
Public function Static FRigElementKey  
Public function Const UFunction BlueprintPure, Category bool

HasTag ( FRigElementKey InItem,
FName InTag
)

 Returns true if a given item has a certain tag
Public function void

IncrementMetadataTagVersion ( const FRigElementKey& InKey,
const FName& InTag,
bool bAdded
)

 Increments the metadataTag version
Public function void

IncrementMetadataVersion ( const FRigElementKey& InKey,
const FName& InName
)

 Increments the metadata version
Public function void Increments the topology version
Public function Const bool

IsAnimatable ( const FRigElementKey& InKey
)

 Returns true if the control is animatable
Public function Const bool

IsAnimatable ( const FRigControlElement* InControlElement
)

 Returns true if the control is animatable
Public function Const UFunction BlueprintPure, Category bool Returns true if the hierarchy controller is currently available The controller may not be available during certain events.
Public function Const bool

IsCurveValueSet ( FRigCurveElement* InCurveElement
)

 Returns whether a curve's value is set. If the curve value is not set, returns false.
Public function Const UFunction BlueprintCallable, Category bool Returns whether a curve's value is set, given its key
Public function Const UFunction BlueprintCallable, Category bool

IsCurveValueSetByIndex ( int32 InElementIndex
)

 Returns a curve's value given its index
Public function Const bool

IsDependentOn ( FRigBaseElement* InDependent,
FRigBaseElement* InDependency,
TArray< bool >& InElementsVisited,
const TElementDependencyMap& InDependencyMap
)

 Returns true if an element is affected to another element
Public function Const bool

IsDisplayNameAvailable ( const FRigElementKey& InParentElement,
const FString& InPotentialNewDisplayName,
FString* OutErrorMessage
)

 Returns true if a given display name is available.
Public function Const bool

IsNameAvailable ( const FString& InPotentialNewName,
ERigElementType InType,
FString* OutErrorMessage
)

 Returns true if a given name is available.
Public function Const UFunction BlueprintCallable, Category bool Returns true if an element is parented to another element
Public function Const bool

IsParentedTo ( FRigBaseElement* InChild,
FRigBaseElement* InParent,
const TElementDependencyMap& InDependencyMap
)

 Returns true if an element is parented to another element
Public function Const bool

IsParentedTo ( int32 InChildIndex,
int32 InParentIndex,
const TElementDependencyMap& InDependencyMap
)

 Returns true if an element is parented to another element
Public function Const bool

IsProcedural ( const FRigBaseElement* InElement
)

 Returns true if the provided element is procedural.
Public function Const UFunction BlueprintCallable, Category bool

IsProcedural ( const FRigElementKey& InKey
)

 Returns true if the provided element is procedural.
Public function Const bool

IsSelected ( int32 InIndex
)

  
Public function Const UFunction BlueprintCallable, Category bool Returns true if a given element is selected
Public function Const UFunction BlueprintCallable, Category bool

IsSelectedByIndex ( int32 InIndex
)

 Returns true if a given element is selected
Public function Const bool Returns true if a hierarchy will record any change. This is used for debugging purposes.
Public function Const UFunction BlueprintCallable, Category bool

IsValidIndex ( int32 InElementIndex
)

 Returns true if the provided element index is valid
Public function void

Load ( FArchive& Ar
)

  
Public function Static UFunction BlueprintCallable, Category FRigControlValue

MakeControlValueFromBool ( bool InValue
)

 Creates a rig control value from a bool value
Public function Static UFunction BlueprintCallable, Category FRigControlValue Creates a rig control value from a FEulerTransform value
Public function Static UFunction BlueprintCallable, Category FRigControlValue

MakeControlValueFromFloat ( float InValue
)

 Creates a rig control value from a float value
Public function Static UFunction BlueprintCallable, Category FRigControlValue

MakeControlValueFromInt ( int32 InValue
)

 Creates a rig control value from a int32 value
Public function Static UFunction BlueprintCallable, Category FRigControlValue

MakeControlValueFromRotator ( FRotator InValue
)

 Creates a rig control value from a FRotator value
Public function Static UFunction BlueprintCallable, Category FRigControlValue

MakeControlValueFromTransform ( FTransform InValue
)

 Creates a rig control value from a FTransform value
Public function Static UFunction BlueprintCallable, Category FRigControlValue Creates a rig control value from a FTransformNoScale value
Public function Static UFunction BlueprintCallable, Category FRigControlValue

MakeControlValueFromVector ( FVector InValue
)

 Creates a rig control value from a FVector value
Public function Static UFunction BlueprintCallable, Category FRigControlValue

MakeControlValueFromVector2D ( FVector2D InValue
)

 Creates a rig control value from a FVector2D value
Public function void

Notify ( ERigHierarchyNotification InNotifType,
const FRigBaseElement* InElement
)

  
Public function Const int32

Num ( ERigElementType InElementType
)

 Returns the number of elements in the Hierarchy.
Public function Const UFunction BlueprintCallable, Category int32

Num ()

 Returns the number of elements in the Hierarchy.
Public function FRigEventDelegate & Returns the delegate to listen to for events coming from this hierarchy
Public function FRigHierarchyMetadataChangedDelegate & Returns the MetadataChanged event, which can be used to track metadata changes Note: This notification has a very high volume - so the consequences of subscribing to it may cause performance slowdowns.
Protected function Static void

OnMetadataChanged_Static ( const FRigElementKey& InKey,
const FName& InName,
URigHierarchy* InHierarchy
)

  
Public function FRigHierarchyMetadataTagChangedDelegate & Returns the MetadataTagChanged event, which can be used to track metadata tag changes Note: This notification has a very high volume - so the consequences of subscribing to it may cause performance slowdowns.
Protected function Static void

OnMetadataTagChanged_Static ( const FRigElementKey& InKey,
const FName& InTag,
bool bAdded,
URigHierarchy* InHierarchy
)

  
Public function FRigHierarchyModifiedEvent & Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy.
Public function FRigHierarchyUndoRedoTransformEvent & Returns the event fired during undo / redo
Public function bool

Redo ()

 Performs redo for one transform change
Public function void Add dependent hierarchies that listens to changes made to this hierarchy Note: By default, only changes to the initial states of this hierarchy is mirrored to the listening hierarchies
Public function UFunction BlueprintCallable, Category bool Removes all of the metadata under a given item
Public function UFunction BlueprintCallable, Category bool

RemoveMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Removes the metadata under a given element
Public function UFunction BlueprintCallable, Category void

Reset ()

 Clears the whole hierarchy and removes all elements.
Public function UFunction BlueprintCallable, Category void Resets all curves to 0.0
Public function void Resets the current pose of all elements to the initial / ref pose.
Public function UFunction BlueprintCallable, Category void Resets the current pose of a filtered list of elements to the initial / ref pose.
Public function UFunction BlueprintCallable, Category void Resets the hierarchy to the state of its default.
Public function void Clears the undo / redo stack of this hierarchy
Protected function Static int32  
Public function Static void

SanitizeName ( FString& InOutName
)

 Sanitizes a name by removing invalid characters.
Public function void

Save ( FArchive& Ar
)

  
Public function UFunction BlueprintCallable, Category void

SendAutoKeyEvent ( FRigElementKey InElement,
float InOffsetInSeconds,
bool bAsynchronous
)

 Sends an autokey event from the hierarchy to the world
Public function void

SendEvent ( const FRigEventContext& InEvent,
bool bAsynchronous
)

 Sends an event from the hierarchy to the world
Public function UFunction BlueprintCallable, Category bool

SetBoolArrayMetadata ( FRigElementKey InItem,
FName InMetadataName,
TArray< bool > InValue
)

 Sets the metadata to a bool array value
Public function UFunction BlueprintCallable, Category bool

SetBoolMetadata ( FRigElementKey InItem,
FName InMetadataName,
bool InValue
)

 Sets the metadata to a bool value
Public function UFunction BlueprintCallable, Category void

SetControlOffsetTransform ( FRigElementKey InKey,
FTransform InTransform,
bool bInitial,
bool bAffectChildren,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Sets the offset transform for a given control element by key
Public function void

SetControlOffsetTransform ( FRigControlElement* InControlElement,
const FTransform& InTransform,
const ERigTransformType::Type InTransformType,
bool bAffectChildren,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands
)

 Sets the offset transform for a given control element
Public function UFunction BlueprintCallable, Category void

SetControlOffsetTransformByIndex ( int32 InElementIndex,
FTransform InTransform,
bool bInitial,
bool bAffectChildren,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Sets the local offset transform for a given control element by index
Public function UFunction BlueprintCallable, Category void

SetControlPreferredEulerAngles ( FRigElementKey InKey,
const FVector& InEulerAngles,
EEulerRotationOrder InRotationOrder,
bool bInitial,
bool bFixEulerFlips
)

 Sets a control's preferred euler angles (local transform rotation)
Public function void

SetControlPreferredEulerAngles ( FRigControlElement* InControlElement,
const FVector& InEulerAngles,
EEulerRotationOrder InRotationOrder,
bool bInitial,
bool bFixEulerFlips
)

 Sets a control's preferred euler angles (local transform rotation)
Public function UFunction BlueprintCallable, Category void

SetControlPreferredEulerAnglesByIndex ( int32 InElementIndex,
const FVector& InEulerAngles,
EEulerRotationOrder InRotationOrder,
bool bInitial,
bool bFixEulerFlips
)

 Sets a control's preferred euler angles (local transform rotation)
Public function void

SetControlPreferredRotationOrder ( FRigControlElement* InControlElement,
EEulerRotationOrder InRotationOrder
)

 Sets a control's preferred euler rotation order
Public function UFunction BlueprintCallable, Category void

SetControlPreferredRotationOrder ( FRigElementKey InKey,
EEulerRotationOrder InRotationOrder
)

 Sets a control's preferred euler rotation order
Public function UFunction BlueprintCallable, Category void

SetControlPreferredRotationOrderByIndex ( int32 InElementIndex,
EEulerRotationOrder InRotationOrder
)

 Sets a control's preferred euler rotation order
Public function UFunction BlueprintCallable, Category void

SetControlPreferredRotator ( FRigElementKey InKey,
const FRotator& InRotator,
bool bInitial,
bool bFixEulerFlips
)

 Sets a control's preferred rotator (local transform rotation)
Public function void

SetControlPreferredRotator ( FRigControlElement* InControlElement,
const FRotator& InRotator,
bool bInitial,
bool bFixEulerFlips
)

 Sets a control's preferred rotator (local transform rotation)
Public function UFunction BlueprintCallable, Category void

SetControlPreferredRotatorByIndex ( int32 InElementIndex,
const FRotator& InRotator,
bool bInitial,
bool bFixEulerFlips
)

 Sets a control's preferred rotator (local transform rotation)
Public function UFunction BlueprintCallable, Category void

SetControlSettings ( FRigElementKey InKey,
FRigControlSettings InSettings,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands
)

 Sets the control settings for a given control element by key
Public function void

SetControlSettings ( FRigControlElement* InControlElement,
FRigControlSettings InSettings,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands
)

 Sets the control settings for a given control element
Public function UFunction BlueprintCallable, Category void

SetControlSettingsByIndex ( int32 InElementIndex,
FRigControlSettings InSettings,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands
)

 Sets the control settings for a given control element by index
Public function void

SetControlShapeTransform ( FRigControlElement* InControlElement,
const FTransform& InTransform,
const ERigTransformType::Type InTransformType,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands
)

 Sets the shape transform for a given control element
Public function UFunction BlueprintCallable, Category void

SetControlShapeTransform ( FRigElementKey InKey,
FTransform InTransform,
bool bInitial,
bool bSetupUndo
)

 Sets the shape transform for a given control element by key
Public function UFunction BlueprintCallable, Category void

SetControlShapeTransformByIndex ( int32 InElementIndex,
FTransform InTransform,
bool bInitial,
bool bSetupUndo
)

 Sets the local shape transform for a given control element by index
Public function void

SetControlSpecifiedEulerAngle ( FRigControlElement* InControlElement,
const FVector& InEulerAngle,
bool bIsInitial
)

  
Public function void

SetControlValue ( FRigControlElement* InControlElement,
const FRigControlValue& InValue,
ERigControlValueType InValueType,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands,
bool bFixEulerFlips
)

 Sets a control's current value
Public function Const void

SetControlValue ( FRigControlElement* InControlElement,
const T& InValue,
ERigControlValueType InValueType,
bool bSetupUndo,
bool bForce
)

  
Public function void

SetControlValue ( int32 InElementIndex,
const FRigControlValue& InValue,
ERigControlValueType InValueType,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Sets a control's current value given its index
Public function Const void

SetControlValue ( FRigElementKey InKey,
const T& InValue,
ERigControlValueType InValueType,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Sets a control's current value given its key
Public function UFunction BlueprintCallable, Category void

SetControlValue ( FRigElementKey InKey,
FRigControlValue InValue,
ERigControlValueType InValueType,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Sets a control's current value given its key
Public function void

SetControlValue ( int32 InElementIndex,
const FVector2D& InValue,
ERigControlValueType InValueType,
bool bSetupUndo
)

  
Public function void

SetControlValue ( int32 InElementIndex,
const T& InValue,
ERigControlValueType InValueType,
bool bSetupUndo
)

 Sets a control's current value given its index
Public function UFunction BlueprintCallable, Category void

SetControlValueByIndex ( int32 InElementIndex,
FRigControlValue InValue,
ERigControlValueType InValueType,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Sets a control's current value given its index
Public function void

SetControlVisibility ( int32 InElementIndex,
bool bVisibility
)

  
Public function UFunction BlueprintCallable, Category void

SetControlVisibility ( FRigElementKey InKey,
bool bVisibility
)

 Sets a control's current visibility based on a key
Public function void

SetControlVisibility ( FRigControlElement* InControlElement,
bool bVisibility
)

 Sets a control's current visibility
Public function UFunction BlueprintCallable, Category void

SetControlVisibilityByIndex ( int32 InElementIndex,
bool bVisibility
)

 Sets a control's current visibility based on a key
Public function void

SetCurveValue ( int32 InElementIndex,
float InValue,
bool bSetupUndo
)

 TODO: Deprecate?
Public function void

SetCurveValue ( FRigCurveElement* InCurveElement,
float InValue,
bool bSetupUndo,
bool bForce
)

 Sets a curve's value
Public function UFunction BlueprintCallable, Category void

SetCurveValue ( FRigElementKey InKey,
float InValue,
bool bSetupUndo
)

 Sets a curve's value given its key
Public function UFunction BlueprintCallable, Category void

SetCurveValueByIndex ( int32 InElementIndex,
float InValue,
bool bSetupUndo
)

 Sets a curve's value given its index
Public function UFunction BlueprintCallable, Category bool

SetFloatArrayMetadata ( FRigElementKey InItem,
FName InMetadataName,
TArray< float > InValue
)

 Sets the metadata to a float array value
Public function UFunction BlueprintCallable, Category bool

SetFloatMetadata ( FRigElementKey InItem,
FName InMetadataName,
float InValue
)

 Sets the metadata to a float value
Public function UFunction BlueprintCallable, Category void

SetGlobalTransform ( FRigElementKey InKey,
FTransform InTransform,
bool bInitial,
bool bAffectChildren,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Sets the global current or initial transform for a given key.
Public function void

SetGlobalTransform ( int32 InElementIndex,
const FTransform& InTransform,
bool bAffectChildren,
bool bSetupUndo
)

  
Public function UFunction BlueprintCallable, Category void

SetGlobalTransformByIndex ( int32 InElementIndex,
FTransform InTransform,
bool bInitial,
bool bAffectChildren,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Sets the global current or initial transform for a given element index.
Public function Const void

SetInitialControlValue ( int32 InElementIndex,
const T& InValue,
bool bSetupUndo
)

 Sets a control's initial value given its index
Public function void

SetInitialControlValue ( int32 InElementIndex,
const FRigControlValue& InValue,
bool bSetupUndo
)

 Sets a control's initial value given its index
Public function void

SetInitialGlobalTransform ( const FRigElementKey& InKey,
const FTransform& InTransform,
bool bAffectChildren,
bool bSetupUndo
)

  
Public function void

SetInitialGlobalTransform ( int32 InElementIndex,
const FTransform& InTransform,
bool bAffectChildren,
bool bSetupUndo
)

  
Public function void

SetInitialLocalTransform ( const FRigElementKey& InKey,
const FTransform& InTransform,
bool bAffectChildren,
bool bSetupUndo,
bool bPrintPythonCommands
)

  
Public function void

SetInitialLocalTransform ( int32 InElementIndex,
const FTransform& InTransform,
bool bAffectChildren,
bool bSetupUndo,
bool bPrintPythonCommands
)

  
Public function UFunction BlueprintCallable, Category bool

SetInt32ArrayMetadata ( FRigElementKey InItem,
FName InMetadataName,
TArray< int32 > InValue
)

 Sets the metadata to a int32 array value
Public function UFunction BlueprintCallable, Category bool

SetInt32Metadata ( FRigElementKey InItem,
FName InMetadataName,
int32 InValue
)

 Sets the metadata to a int32 value
Public function UFunction BlueprintCallable, Category bool

SetLinearColorArrayMetadata ( FRigElementKey InItem,
FName InMetadataName,
TArray< FLinearColor > InValue
)

 Sets the metadata to a FLinearColor array value
Public function UFunction BlueprintCallable, Category bool

SetLinearColorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FLinearColor InValue
)

 Sets the metadata to a FLinearColor value
Public function void

SetLocalTransform ( int32 InElementIndex,
const FTransform& InTransform,
bool bAffectChildren,
bool bSetupUndo,
bool bPrintPythonCommands
)

  
Public function UFunction BlueprintCallable, Category void

SetLocalTransform ( FRigElementKey InKey,
FTransform InTransform,
bool bInitial,
bool bAffectChildren,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Sets the local current or initial transform for a given key.
Public function UFunction BlueprintCallable, Category void

SetLocalTransformByIndex ( int32 InElementIndex,
FTransform InTransform,
bool bInitial,
bool bAffectChildren,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Sets the local current or initial transform for a given element index.
Public function UFunction BlueprintCallable, Category bool

SetNameArrayMetadata ( FRigElementKey InItem,
FName InMetadataName,
TArray< FName > InValue
)

 Sets the metadata to a FName array value
Public function UFunction BlueprintCallable, Category bool

SetNameMetadata ( FRigElementKey InItem,
FName InMetadataName,
FName InValue
)

 Sets the metadata to a FName value
Public function bool

SetParentWeight ( FRigBaseElement* InChild,
int32 InParentIndex,
FRigElementWeight InWeight,
bool bInitial,
bool bAffectChildren
)

 Sets the weight of a parent below a multi parent element
Public function bool

SetParentWeight ( FRigBaseElement* InChild,
const FRigBaseElement* InParent,
FRigElementWeight InWeight,
bool bInitial,
bool bAffectChildren
)

 Sets the weight of a parent below a multi parent element
Public function UFunction BlueprintCallable, Category bool

SetParentWeight ( FRigElementKey InChild,
FRigElementKey InParent,
FRigElementWeight InWeight,
bool bInitial,
bool bAffectChildren
)

 Sets the weight of a parent below a multi parent element
Public function bool

SetParentWeightArray ( FRigBaseElement* InChild,
const TArrayView< const FRigElementWeight >& InWeights,
bool bInitial,
bool bAffectChildren
)

 Sets the all of the weights of the parents of a multi parent element
Public function UFunction BlueprintCallable, Category bool

SetParentWeightArray ( FRigElementKey InChild,
TArray< FRigElementWeight > InWeights,
bool bInitial,
bool bAffectChildren
)

 Sets the all of the weights of the parents of a multi parent element
Public function bool

SetParentWeightArray ( FRigBaseElement* InChild,
const TArray< FRigElementWeight >& InWeights,
bool bInitial,
bool bAffectChildren
)

 Sets the all of the weights of the parents of a multi parent element
Public function void

SetPose ( const FRigPose& InPose,
ERigTransformType::Type InTransformType
)

 Sets the current / initial pose of the hierarchy
Public function void

SetPose ( const FRigPose& InPose,
ERigTransformType::Type InTransformType,
ERigElementType InElementType,
const FRigElementKeyCollection& InItems,
float InWeight
)

 Sets the current / initial pose of the hierarchy
Public function void

SetPose ( const FRigPose& InPose,
ERigTransformType::Type InTransformType,
ERigElementType InElementType,
const TArrayView< const FRigElementKey >& InItems,
float InWeight
)

 Sets the current / initial pose of the hierarchy
Public function UFunction BlueprintCallable, Category, Meta void Sets the current / initial pose of the hierarchy
Public function UFunction BlueprintCallable, Category bool

SetQuatArrayMetadata ( FRigElementKey InItem,
FName InMetadataName,
TArray< FQuat > InValue
)

 Sets the metadata to a FQuat array value
Public function UFunction BlueprintCallable, Category bool

SetQuatMetadata ( FRigElementKey InItem,
FName InMetadataName,
FQuat InValue
)

 Sets the metadata to a FQuat value
Public function UFunction BlueprintCallable, Category bool Sets the metadata to a FRigElementKey array value
Public function UFunction BlueprintCallable, Category bool

SetRigElementKeyMetadata ( FRigElementKey InItem,
FName InMetadataName,
FRigElementKey InValue
)

 Sets the metadata to a FRigElementKey value
Public function UFunction BlueprintCallable, Category bool

SetRotatorArrayMetadata ( FRigElementKey InItem,
FName InMetadataName,
TArray< FRotator > InValue
)

 Sets the metadata to a FRotator array value
Public function UFunction BlueprintCallable, Category bool

SetRotatorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FRotator InValue
)

 Sets the metadata to a FRotator value
Public function UFunction BlueprintCallable, Category bool

SetTag ( FRigElementKey InItem,
FName InTag
)

 Sets a tag on an element in the hierarchy
Public function void

SetTransform ( FRigTransformElement* InTransformElement,
const FTransform& InTransform,
const ERigTransformType::Type InTransformType,
bool bAffectChildren,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands
)

 Sets a transform for a given element based on the transform type
Public function UFunction BlueprintCallable, Category bool

SetTransformArrayMetadata ( FRigElementKey InItem,
FName InMetadataName,
TArray< FTransform > InValue
)

 Sets the metadata to a FTransform array value
Public function UFunction BlueprintCallable, Category bool

SetTransformMetadata ( FRigElementKey InItem,
FName InMetadataName,
FTransform InValue
)

 Sets the metadata to a FTransform value
Public function void

SetUsePreferredRotationOrder ( FRigControlElement* InControlElement,
bool bVal
)

  
Public function UFunction BlueprintCallable, Category bool

SetVectorArrayMetadata ( FRigElementKey InItem,
FName InMetadataName,
TArray< FVector > InValue
)

 Sets the metadata to a FVector array value
Public function UFunction BlueprintCallable, Category bool

SetVectorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FVector InValue
)

 Sets the metadata to a FVector value
Public function Const bool

ShouldBeGrouped ( const FRigElementKey& InKey
)

 Returns true if the control should be grouped in editor
Public function Const bool

ShouldBeGrouped ( const FRigControlElement* InControlElement
)

 Returns true if the control should be grouped in editor
Public function Const UFunction BlueprintCallable, Category TArray< FRigElementKey >

SortKeys ( const TArray< FRigElementKey >& InKeys
)

 Sorts the input key list by traversing the hierarchy
Public function void Starts an interaction on the rig. This will cause all transform actions happening to be merged
Public function void

StorePoseForTrace ( const FString& InPrefix
)

 Stores the current pose for tracing
Public function bool

SwitchToDefaultParent ( FRigBaseElement* InChild,
bool bInitial,
bool bAffectChildren
)

 Switches a multi parent element to its first parent This sets the new parent's weight to 1.0 and disables weights for all other potential parents.
Public function UFunction BlueprintCallable, Category bool

SwitchToDefaultParent ( FRigElementKey InChild,
bool bInitial,
bool bAffectChildren
)

 Switches a multi parent element to its first parent
Public function bool

SwitchToParent ( FRigBaseElement* InChild,
int32 InParentIndex,
bool bInitial,
bool bAffectChildren
)

 Switches a multi parent element to a single parent.
Public function UFunction BlueprintCallable, Category bool

SwitchToParent ( FRigElementKey InChild,
FRigElementKey InParent,
bool bInitial,
bool bAffectChildren
)

 Switches a multi parent element to a single parent.
Public function bool

SwitchToParent ( FRigBaseElement* InChild,
FRigBaseElement* InParent,
bool bInitial,
bool bAffectChildren,
const TElementDependencyMap& InDependencyMap,
FString* OutFailureReason
)

 Switches a multi parent element to a single parent.
Public function bool

SwitchToParent ( FRigElementKey InChild,
FRigElementKey InParent,
bool bInitial,
bool bAffectChildren,
const TElementDependencyMap& InDependencyMap,
FString* OutFailureReason
)

  
Public function UFunction BlueprintCallable, Category bool

SwitchToWorldSpace ( FRigElementKey InChild,
bool bInitial,
bool bAffectChildren
)

 Switches a multi parent element to world space. This injects a world space reference.
Public function bool

SwitchToWorldSpace ( FRigBaseElement* InChild,
bool bInitial,
bool bAffectChildren
)

 Switches a multi parent element to world space. This injects a world space reference.
Public function void

TraceFrames ( int32 InNumFramesToTrace
)

 Tells this hierarchy to trace a series of frames
Public function Const void

Traverse ( TFunction< void(FRigBaseElement*, bool&)> PerElementFunction,
bool bTowardsChildren
)

 Helper function to traverse the hierarchy from the root
Public function Const void

Traverse ( FRigBaseElement* InElement,
bool bTowardsChildren,
TFunction< void(FRigBaseElement*, bool&)> PerElementFunction
)

 Helper function to traverse the hierarchy
Public function bool

Undo ()

 Performs undo for one transform change
Public function void Remove dependent hierarchies that listens to changes made to this hierarchy
Public function UFunction BlueprintCallable, Category void

UnsetCurveValue ( FRigElementKey InKey,
bool bSetupUndo
)

 Sets a curve's value given its key
Public function void

UnsetCurveValue ( FRigCurveElement* InCurveElement,
bool bSetupUndo,
bool bForce
)

 Unsets a curve's value. Basically the curve's value becomes meaningless.
Public function UFunction BlueprintCallable, Category void

UnsetCurveValueByIndex ( int32 InElementIndex,
bool bSetupUndo
)

 Sets a curve's value given its index
Public function void

UnsetCurveValues ( bool bSetupUndo
)

 Resets all curves to be unset (defaulting to 0.0)
Public function void

UpdateReferences ( const FRigVMExecuteContext* InContext
)

 Update all elements that depend on external references

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
TElementDependencyMap  
TElementDependencyMapPair  
TInstructionSliceElement  

Constants

Name Description
bEnableValidityCheckbyDefault  
EmptyElementArray Static empty element array used for ref returns.
TagMetadataName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page