URigHierarchy

API > API/Plugins > API/Plugins/ControlRig

   
Name URigHierarchy
Type class
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h
Include Path #include "Rigs/RigHierarchy.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class URigHierarchy : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

URigHierarchy()

   Rigs/RigHierarchy.h  

Structs

Name Remarks
FChildElementOffsetAndCount A quick-lookup cache for elements' children.
FConstraintIndex  
FMetadataStorage  
FQueuedNotification  
FRigHierarchyListener This is mainly used for propagating changes between hierarchies in the direction of blueprint -> CDO -> other instances

Constants

Name Type Remarks Include Path
bEnableValidityCheckbyDefault bool   Rigs/RigHierarchy.h
DefaultParentKeyLabel const FLazyName   Rigs/RigHierarchy.h
DesiredKeyMetadataName const FLazyName   Rigs/RigHierarchy.h
DesiredNameMetadataName const FLazyName   Rigs/RigHierarchy.h
ModuleMetadataName const FLazyName   Rigs/RigHierarchy.h
NameSpaceMetadataName_Deprecated const FLazyName   Rigs/RigHierarchy.h
ShortModuleNameMetadataName_Deprecated const FLazyName   Rigs/RigHierarchy.h
ShortNameMetadataName_Deprecated const FLazyName   Rigs/RigHierarchy.h
TagMetadataName const FLazyName   Rigs/RigHierarchy.h
WorldSpaceKeyLabel const FLazyName   Rigs/RigHierarchy.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bEnableDirtyPropagation bool If set to false the dirty flag propagation will be disabled Rigs/RigHierarchy.h
  • Transient
bForcePropagation bool A bool to disable any propagation checks and force propagation Rigs/RigHierarchy.h  
bIsControllerAvailable bool   Rigs/RigHierarchy.h
  • Transient
bIsCopyingHierarchy bool   Rigs/RigHierarchy.h  
bIsInteracting bool Manages merging transform actions into one during an interaction Rigs/RigHierarchy.h  
bPropagatingChange bool A bool to guard against circular dependencies among listening hierarchies Rigs/RigHierarchy.h  
bRecordCurveChanges bool   Rigs/RigHierarchy.h  
bRecordInstructionsAtRuntime bool   Rigs/RigHierarchy.h  
bSuspendMetadataNotifications bool If set to true all metadata changes notifs coming from this hierarchy will be suspended Rigs/RigHierarchy.h  
bSuspendNameSpaceKeyWarnings bool If set to true all name space key related warnings will be suspended Rigs/RigHierarchy.h  
bSuspendNotifications bool If set to true all notifs coming from this hierarchy will be suspended Rigs/RigHierarchy.h  
bTransactingForTransformChange bool A flag to indicate if the next serialize should contain only transform changes Rigs/RigHierarchy.h  
ChangedCurveIndices TArray< int32 >   Rigs/RigHierarchy.h  
ChildElementCache TArray< FRigBaseElement * >   Rigs/RigHierarchy.h  
ChildElementCacheTopologyVersion uint32 The topology version at which the child element cache was constructed. Rigs/RigHierarchy.h  
ChildElementOffsetAndCountCache TArray< FChildElementOffsetAndCount >   Rigs/RigHierarchy.h  
ComponentIndexLookup TMap< FRigComponentKey, int32 > Managed lookup from Component Key to Index. Rigs/RigHierarchy.h  
DefaultHierarchyPtr TWeakObjectPtr< URigHierarchy >   Rigs/RigHierarchy.h  
DismissDependencyDelegate FRigHierarchyDismissDependencyDelegate   Rigs/RigHierarchy.h  
ElementBeingDestroyed const FRigBaseElement * The currently destroyed element - used to avoid notification storms Rigs/RigHierarchy.h  
ElementComponents TArray< FInstancedStruct > Element component storage. Rigs/RigHierarchy.h  
ElementCurves FRigReusableElementStorage< float > Per element curve storage. Rigs/RigHierarchy.h  
ElementDependencyCache THierarchyCache< TMap< TTuple< int32, int32 >, bool > >   Rigs/RigHierarchy.h  
ElementDirtyStates FRigReusableElementStorage< bool > Per element dirty state storage. Rigs/RigHierarchy.h  
ElementIndexLookup TMap< FRigElementKey, int32 > Managed lookup from Element Key to Index. Rigs/RigHierarchy.h  
ElementKeyRedirector FRigElementKeyRedirector *   Rigs/RigHierarchy.h  
ElementMetadata FRigReusableElementStorage< FMetadataStorage > Element metadata storage. Rigs/RigHierarchy.h  
Elements TArray< FRigBaseElement * > Storage for the elements. Rigs/RigHierarchy.h  
ElementsLock FTransactionallySafeCriticalSection   Rigs/RigHierarchy.h  
ElementsPerType TArray< TArray< FRigBaseElement * > > Storage for the elements. Rigs/RigHierarchy.h  
ElementsToRetainLocalTransform TArray< int32 >   Rigs/RigHierarchy.h  
ElementTransformRanges TArray< TTuple< int32, int32 > > A list of ranges which can be used to copy all poses from initial to current, for example. Rigs/RigHierarchy.h  
ElementTransforms FRigReusableElementStorage< FTransform > Per element pose storage. Rigs/RigHierarchy.h  
EventDelegate FRigEventDelegate   Rigs/RigHierarchy.h  
ExecuteContext const FRigVMExtendedExecuteContext *   Rigs/RigHierarchy.h  
ExecuteContextLock FTransactionallySafeCriticalSection NOTE: it is not safe to read or write the execute context without locking it first as the FRigHierarchyExecuteContextBracket can change the context from the main thread (from sequencer for example) at the same time that a control rig is being evaluated on an animation thread. Rigs/RigHierarchy.h  
HierarchyController TObjectPtr< URigHierarchyController >   Rigs/RigHierarchy.h
  • Transient
HierarchyForSelectionPtr TWeakObjectPtr< URigHierarchy >   Rigs/RigHierarchy.h  
IsDependentOnLock FTransactionallySafeCriticalSection   Rigs/RigHierarchy.h  
KeyCollectionCache TMap< uint32, FRigElementKeyCollection >   Rigs/RigHierarchy.h  
LastInteractedKey FRigElementKey Stores the last key being interacted on Rigs/RigHierarchy.h  
ListeningHierarchies TArray< FRigHierarchyListener >   Rigs/RigHierarchy.h  
MaxNameLength int32 The max length for an element / component name within this hierarchy. Rigs/RigHierarchy.h  
meta   Returns bone element for a given key, for scripting purpose only, for cpp usage, use Find() Rigs/RigHierarchy.h  
MetadataChangedDelegate FRigHierarchyMetadataChangedDelegate   Rigs/RigHierarchy.h  
MetadataTagChangedDelegate FRigHierarchyMetadataTagChangedDelegate   Rigs/RigHierarchy.h  
MetadataTagVersion uint16 The metadata version of the hierarchy changes when metadata is being created or removed (not when the metadata values changes) Rigs/RigHierarchy.h
  • Transient
MetadataVersion uint32 The metadata version of the hierarchy changes when metadata is being created or removed (not when the metadata values changes) Rigs/RigHierarchy.h
  • Transient
ModifiedEvent FRigHierarchyModifiedEvent   Rigs/RigHierarchy.h  
ModifiedEventDynamic FRigHierarchyModifiedDynamicEvent   Rigs/RigHierarchy.h
  • BlueprintReadOnly
  • Category=RigHierarchy
  • Meta=(ScriptName="ModifiedEvent", AllowPrivateAccess="true")
NonUniqueShortNamesCache THierarchyCache< TSet< FRigElementKey > >   Rigs/RigHierarchy.h  
OrderedSelection TArray< FRigHierarchyKey >   Rigs/RigHierarchy.h  
OrphanedBatchHeads TArray< FRigBaseElement * > Batch heads (OwnedInstances > 1) removed from Elements via RemoveElement. Rigs/RigHierarchy.h  
ParentWeightVersion uint32 The parent weight version of this hierarchy changes whenever parents are added / removed or when the weights of a parent relationship changes. Rigs/RigHierarchy.h
  • Transient
PoseAdapter TSharedPtr< FRigHierarchyPoseAdapter >   Rigs/RigHierarchy.h  
PoseVersionPerElement TArray< int32 >   Rigs/RigHierarchy.h  
PreviousHierarchyNameMap TMap< FRigHierarchyKey, FRigHierarchyKey > We save this so Sequencer can remap this after load Rigs/RigHierarchy.h  
PreviousHierarchyParentMap TMap< FRigHierarchyKey, FRigHierarchyKey >   Rigs/RigHierarchy.h  
QueuedNotifications TQueue< FQueuedNotification, EQueueMode::SingleThreaded >   Rigs/RigHierarchy.h  
ReceivedNameSpaceBasedKeys TArray< FRigElementKey >   Rigs/RigHierarchy.h  
ResetPoseHash int32   Rigs/RigHierarchy.h  
ResetPoseIsFilteredOut TArray< bool >   Rigs/RigHierarchy.h  
RuleManager TObjectPtr< UModularRigRuleManager >   Rigs/RigHierarchy.h
  • Transient
SelectedKeysBeforeUndo TArray< FRigHierarchyKey > The keys that were selected before undo / redo. Rigs/RigHierarchy.h  
TopologyVersion uint32 The topology version of the hierarchy changes when elements are added, removed, re-parented or renamed. Rigs/RigHierarchy.h
  • Transient
TransformRedoStack TArray< FRigTransformStackEntry > The stack of actions to undo Rigs/RigHierarchy.h  
TransformStackIndex int32 Undo redo related. Rigs/RigHierarchy.h  
TransformUndoStack TArray< FRigTransformStackEntry > The stack of actions to undo. Note: This is also used when performing traces on the hierarchy. Rigs/RigHierarchy.h  
UndoRedoEvent FRigHierarchyUndoRedoTransformEvent The event fired during undo / redo Rigs/RigHierarchy.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddCachedCollection ( uint32 InHash,
const FRigElementKeyCollection& InCollection
) const

   Rigs/RigHierarchy.h  

TArray< FRigBaseElement * >::RangedForIteratorType begin()

 Iterators Rigs/RigHierarchy.h  

bool CanAddComponent ( FRigElementKey InElementKey,
const UScriptStruct* InComponentStruct,
FString* OutFailureReason
) const

   Rigs/RigHierarchy.h  

bool CanAddComponent ( FRigElementKey InElementKey,
const FRigBaseComponent* InComponent,
FString* OutFailureReason
) const

   Rigs/RigHierarchy.h  

void CleanupInvalidCaches()

 Cleans up caches after load Rigs/RigHierarchy.h  

void CleanupListeningHierarchies()

 Cleanup dependent hierarchies that are marked as garbage Rigs/RigHierarchy.h  

void ClearListeningHierarchy()

 Remove all dependent hierarchies Rigs/RigHierarchy.h  

bool Contains ( const FRigElementKey& InKey
) const

 Returns true if the provided element key is valid as a certain typename Rigs/RigHierarchy.h  

bool Contains ( const FRigElementKey& InKey
) const

 Returns true if the provided element key is valid Rigs/RigHierarchy.h  

bool Contains_ForBlueprint ( FRigElementKey InKey
) const

 Returns true if the provided element key is valid Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Contains", ScriptName="Contains")

void CopyAllMetadataFromElement ( FRigBaseElement* InTargetElement,
const FRigBaseElement* InSourceElement
)

   Rigs/RigHierarchy.h  

void CopyHierarchy ( URigHierarchy* InHierarchy
)

 Copies the contents of a hierarchy onto this one Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

TMap< FRigElementKey, URigHierarchy::FMetadataStorage > CopyMetadata()

   Rigs/RigHierarchy.h  

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

 Copies the contents of a hierarchy onto this one Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void DumpTransformStackToFile ( FString* OutFilePath
)

 Dumps the content of the transform stack to a string Rigs/RigHierarchy.h  

TArray< FRigBaseElement * >::RangedForIteratorType end()

   Rigs/RigHierarchy.h  

void EnsureCacheValidity()

 Performs validation of the cache within the hierarchy on any mutation. Rigs/RigHierarchy.h  

const FRigBaseElement * Find ( const FRigElementKey& InKey
) const

 Returns an element for a given key or nullptr. Rigs/RigHierarchy.h  

T * Find ( const FRigElementKey& InKey
)

 Returns an element for a given key or nullptr. Rigs/RigHierarchy.h  

const T * Find ( const FRigElementKey& InKey,
bool bFollowRedirector
) const

 Returns an element for a given key or nullptr. Rigs/RigHierarchy.h  

FRigBaseElement * Find ( const FRigElementKey& InKey
)

 Returns an element for a given key or nullptr. Rigs/RigHierarchy.h  

const FRigElementKeyCollection * FindCachedCollection ( uint32 InHash
) const

   Rigs/RigHierarchy.h  
Returns an element for a given key and raises for invalid results. Rigs/RigHierarchy.h  

const FRigBaseElement * FindChecked ( const FRigElementKey& InKey
) const

 Returns an element for a given key and raises for invalid results. Rigs/RigHierarchy.h  

const FRigBaseComponent * FindComponent ( const FRigComponentKey& InKey
) const

 Returns a component for a given key or nullptr. Rigs/RigHierarchy.h  
Returns a component for a given key or nullptr. Rigs/RigHierarchy.h  

FRigBaseMetadata * FindMetadataForElement ( const FRigBaseElement* InElement,
const FName& InName,
ERigMetadataType InType
)

 Attempts to find element's metadata of the given name and type. Rigs/RigHierarchy.h  

const FRigBaseMetadata * FindMetadataForElement ( const FRigBaseElement* InElement,
const FName& InName,
ERigMetadataType InType
) const

   Rigs/RigHierarchy.h  

FRigElementKeyCollection & FindOrAddCachedCollection ( uint32 InHash
) const

   Rigs/RigHierarchy.h  

void ForEach ( TFunctionRef< bool(FRigBaseElement*)> PerElementFunction
) const

 Iterator function to invoke a lambda / TFunctionRef for each element Rigs/RigHierarchy.h  

void ForEach ( TFunctionRef< bool(T*)> PerElementFunction
) const

 Filtered template Iterator function to invoke a lambda / TFunctionRef for each element of a given type. Rigs/RigHierarchy.h  

T * Get ( int32 InIndex
)

 Returns an element at a given index or nullptr. Rigs/RigHierarchy.h  

const T * Get ( int32 InIndex
) const

 Returns an element at a given index or nullptr. Rigs/RigHierarchy.h  

FRigBaseElement * Get ( int32 InIndex
)

 Returns an element at a given index or nullptr. Rigs/RigHierarchy.h  

const FRigBaseElement * Get ( int32 InIndex
) const

 Returns an element at a given index or nullptr. Rigs/RigHierarchy.h  

TArray< FRigComponentKey > GetAllComponentKeys()

   Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

const TArray< int32 > & GetChangedCurveIndices()

 Returns all changed curve values Rigs/RigHierarchy.h  

const T * GetChecked ( int32 InIndex
) const

 Returns an element at a given index. Rigs/RigHierarchy.h  

T * GetChecked ( int32 InIndex
)

 Returns an element at a given index. Rigs/RigHierarchy.h  

FRigBaseComponent * GetComponent ( int32 InIndex
)

 Returns a component at a given index or nullptr. Rigs/RigHierarchy.h  

const T * GetComponent ( int32 InIndex
) const

 Returns a component at a given index or nullptr. Rigs/RigHierarchy.h  

T * GetComponent ( int32 InIndex
)

 Returns a component at a given index or nullptr. Rigs/RigHierarchy.h  

const FRigBaseComponent * GetComponent ( int32 InIndex
) const

 Returns a component at a given index or nullptr. Rigs/RigHierarchy.h  

const T * GetComponentChecked ( int32 InIndex
) const

 Returns a component at a given index. Rigs/RigHierarchy.h  

T * GetComponentChecked ( int32 InIndex
)

 Returns a component at a given index. Rigs/RigHierarchy.h  

FString GetComponentContent ( FRigElementKey InElement,
int32 InComponentIndex
) const

   Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

int32 GetComponentIndex ( const FRigComponentKey& InComponentKey,
bool bFollowRedirector
) const

 Returns the index of a component or INDEX_NONE Rigs/RigHierarchy.h  

FRigComponentKey GetComponentKey ( FRigElementKey InElement,
int32 InComponentIndex
) const

   Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

TArray< FRigComponentKey > GetComponentKeys ( FRigElementKey InElement
) const

   Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FName GetComponentName ( FRigElementKey InElement,
int32 InComponentIndex
) const

   Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

TArray< const T * > GetComponents ()

 Returns all components of the template type Rigs/RigHierarchy.h  

TArray< const FRigBaseComponent * > GetComponents ( const UScriptStruct* InComponentStruct
) const

 Returns all components of a given type Rigs/RigHierarchy.h  

UScriptStruct * GetComponentType ( FRigElementKey InElement,
int32 InComponentIndex
) const

   Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

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

 Returns the global offset transform for a given control element. Rigs/RigHierarchy.h  

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

 Returns the global shape transform for a given control element. Rigs/RigHierarchy.h  

FRigControlValue GetControlValue ( FRigControlElement* InControlElement,
ERigControlValueType InValueType,
bool bUsePreferredAngles
) const

 Returns a control's current value Rigs/RigHierarchy.h  

FVector2D GetControlValue ( FRigControlElement* InControlElement,
ERigControlValueType InValueType
) const

   Rigs/RigHierarchy.h  

T GetControlValue ( FRigControlElement* InControlElement,
ERigControlValueType InValueType
) const

   Rigs/RigHierarchy.h  

float GetCurveValue ( FRigCurveElement* InCurveElement
) const

 Returns a curve's value. If the curve value is not set, returns Rigs/RigHierarchy.h  

URigHierarchy * GetDefaultHierarchy()

 Returns the default hierarchy for this hierarchy (or nullptr) Rigs/RigHierarchy.h  

FRigElementHandle GetHandle ( const FRigElementKey& InKey
) const

 Returns a handle to an existing element Rigs/RigHierarchy.h  

int32 GetIndex ( const FRigElementKey& InKey,
bool bFollowRedirector
) const

 Returns the index of an element given its key Rigs/RigHierarchy.h  

int32 GetIndex_ForBlueprint ( FRigElementKey InKey
) const

 Returns the index of an element given its key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get Index", ScriptName="GetIndex")

TArray< int32 > GetIndices ( const TArray< FRigElementKey >& InKeys
) const

 Returns the indices of an array of keys Rigs/RigHierarchy.h  

FRigElementKey GetKey ( int32 InElementIndex
) const

 Returns the key of an element given its index Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FRigElementKeyAndIndex GetKeyAndIndex ( int32 InIndex
) const

 Returns the key and index pair of an element given its index Rigs/RigHierarchy.h  
Returns the key and index pair of an element given its key Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetKeys ( const TArray< int32 > InElementIndices
) const

 Returns the keys of an array of indices Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

int32 GetLocalIndex ( const FRigElementKey& InKey
) const

 Returns the index of an element given its key within its default parent (or root) Rigs/RigHierarchy.h  

int32 GetLocalIndex ( const FRigBaseElement* InElement
) const

 Returns the index of an element given its key within its default parent (or root) Rigs/RigHierarchy.h  

int32 GetLocalIndex_ForBlueprint ( FRigElementKey InKey
) const

 Returns the index of an element given its key within its default parent (or root) Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get Local Index", ScriptName="GetLocalIndex")

FString GetMessageFromDependencyChain ( const FRigHierarchyDependencyChain& InDependencyChain
) const

 Helper function to convert a dependency chain into a message string. Rigs/RigHierarchy.h  

FRigBaseMetadata * GetMetadataForElement ( FRigBaseElement* InElement,
const FName& InName,
ERigMetadataType InType,
bool bInNotify
)

 Returns a metadata ptr to the given element's metadata. Rigs/RigHierarchy.h  

uint32 GetNameHash()

 Returns a hash for the hierarchy representing all names as well as the topology version. Rigs/RigHierarchy.h  

int32 GetNextSpawnIndex()

   Rigs/RigHierarchy.h  

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

 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. Rigs/RigHierarchy.h  

FName GetPreviousHierarchyName ( const FRigHierarchyKey& InKey
) const

 Returns the previous name of an element or a component prior to a rename operation Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FRigHierarchyKey GetPreviousHierarchyParent ( const FRigHierarchyKey& InKey
) const

 Returns the previous parent of an element or a component prior to a reparent operation Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FName GetPreviousName ( const FRigElementKey& InKey
) const

 Returns the previous name of an element prior to a rename operation Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

const TMap< FRigHierarchyKey, FRigHierarchyKey > & GetPreviousNameMap()

 Returns the previous name map used by this hierarchy Rigs/RigHierarchy.h  

FRigElementKey GetPreviousParent ( const FRigElementKey& InKey
) const

 Returns the previous parent of an element prior to a reparent operation Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool & GetRecordCurveChangesFlag()

 Returns the flag used decide if we should be recording curve changes Rigs/RigHierarchy.h  

int32 GetSpawnIndex ( const FRigHierarchyKey& InKey
) const

 Returns the spawn index of an element / component given its key. Rigs/RigHierarchy.h  

bool & GetSuspendNotificationsFlag()

 Returns a reference to the suspend notifications flag Rigs/RigHierarchy.h  

uint32 GetTopologyHash ( bool bIncludeTopologyVersion,
bool bIncludeTransientControls
) const

 Returns a hash representing the topological state of the hierarchy Rigs/RigHierarchy.h  

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

 Returns a transform based on a given transform type Rigs/RigHierarchy.h  

bool HasExecuteContext()

 Returns true if the hierarchy currently has an execute context / the rig is running Rigs/RigHierarchy.h  

bool HasMetadata ( const FRigBaseElement* InElement
) const

 Attempts to find if the element has any metadata. Rigs/RigHierarchy.h  

bool HasOnlyUniqueShortNames ( ERigElementType InElementType
) const

 Returns true if this hierarchy has unique short names for a given element type. Rigs/RigHierarchy.h  

bool HasUniqueShortName ( const FRigBaseElement* InElement
) const

   Rigs/RigHierarchy.h  

bool HasUniqueShortName ( ERigElementType InElementType,
const FRigName& InName
) const

 Returns true if in this hierarchy a given short name is unique Rigs/RigHierarchy.h  

bool HasUniqueShortName ( ERigElementType InElementType,
const FString& InName
) const

   Rigs/RigHierarchy.h  

bool IsAnimatable ( const FRigControlElement* InControlElement
) const

 Returns true if the control is animatable Rigs/RigHierarchy.h  

bool IsAnimatable ( const FRigElementKey& InKey
) const

 Returns true if the control is animatable Rigs/RigHierarchy.h  

bool IsCopyingHierarchy()

   Rigs/RigHierarchy.h  

bool IsCurveValueSet ( FRigCurveElement* InCurveElement
) const

 Returns whether a curve's value is set. If the curve value is not set, returns false. Rigs/RigHierarchy.h  

bool IsParentedTo ( FRigBaseElement* InChild,
FRigBaseElement* InParent,
const IRigDependenciesProvider& InDependencyProvider,
FRigHierarchyDependencyChain* OutDependencyChain,
bool bConsiderInactiveParents
) const

 Returns true if an element is parented to another element Rigs/RigHierarchy.h  

bool IsProcedural ( const FRigElementKey& InKey
) const

 Returns true if the provided element is procedural. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool IsProcedural ( const FRigComponentKey& InKey
) const

 Returns true if the provided component is procedural. Rigs/RigHierarchy.h  

bool IsProcedural ( const FRigHierarchyKey& InKey
) const

 Returns true if the provided component or element is procedural. Rigs/RigHierarchy.h  

bool IsProcedural ( const FRigBaseElement* InElement
) const

 Returns true if the provided element is procedural. Rigs/RigHierarchy.h  

bool IsProcedural ( const FRigBaseComponent* InComponent
) const

 Returns true if the provided component is procedural. Rigs/RigHierarchy.h  

bool IsTracingChanges()

 Returns true if a hierarchy will record any change. This is used for debugging purposes. Rigs/RigHierarchy.h  

bool IsValidIndex ( int32 InElementIndex
) const

 Returns true if the provided element index is valid Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void Load ( FArchive& Ar
)

   Rigs/RigHierarchy.h  

void Notify ( ERigHierarchyNotification InNotifType,
const FRigNotificationSubject& InSubject
)

   Rigs/RigHierarchy.h  

int32 Num ()

 Returns the number of elements in the Hierarchy. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

int32 Num ( ERigElementType InElementType
) const

 Returns the number of elements in the Hierarchy. Rigs/RigHierarchy.h  

int32 NumComponents ()

 Returns the count of all components Rigs/RigHierarchy.h  

int32 NumComponents ()

 Returns the count of all components of the template type Rigs/RigHierarchy.h  

int32 NumComponents ( const UScriptStruct* InComponentStruct
) const

 Returns the count of all components of a given type Rigs/RigHierarchy.h  

int32 NumComponents ( FRigElementKey InElement
) const

   Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FRigElementKey PatchElementKeyInLookup ( const FRigElementKey& InKey,
const TMap< FRigHierarchyModulePath, FName >* InModulePathToName
) const

   Rigs/RigHierarchy.h  

void PatchElementMetadata ( const TMap< FRigHierarchyModulePath, FName >& InModulePathToName
)

   Rigs/RigHierarchy.h  

void PatchModularRigComponentKeys ( const TMap< FRigHierarchyModulePath, FName >& InModulePathToName
)

   Rigs/RigHierarchy.h  

void PatchZeroWeightAnimationChannels()

   Rigs/RigHierarchy.h  

void PropagateMetadata ( const FRigElementKey& InKey,
const FName& InName,
bool bNotify
)

   Rigs/RigHierarchy.h  

void PropagateMetadata ( const FRigBaseElement* InElement,
const FName& InName,
bool bNotify
)

   Rigs/RigHierarchy.h  

void RegisterListeningHierarchy ( URigHierarchy* InHierarchy
)

 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 Rigs/RigHierarchy.h  
  Rigs/RigHierarchy.h  

bool RemoveAllMetadataForElement ( FRigBaseElement* InElement
)

   Rigs/RigHierarchy.h  

bool RemoveMetadataForElement ( FRigBaseElement* InElement,
const FName& InName
)

 Removes the named meta data for the given element, regardless of type. Rigs/RigHierarchy.h  

void Reset()

 Clears the whole hierarchy and removes all elements. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void ResetChangedCurveIndices()

 Returns all changed curve values Rigs/RigHierarchy.h  

void ResetCurveValues()

 Resets all curves to 0.0 Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
Resets the current pose of all elements to the initial / ref pose. Rigs/RigHierarchy.h  

void ResetPoseToInitial ( ERigElementType InTypeFilter
)

 Resets the current pose of a filtered list of elements to the initial / ref pose. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void ResetToDefault ()

 Resets the hierarchy to the state of its default. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void ResetTransformStack()

 Clears the undo / redo stack of this hierarchy Rigs/RigHierarchy.h  

void Save ( FArchive& Ar
)

   Rigs/RigHierarchy.h  

void SetConnectorSettings ( FRigConnectorElement* InConnectorElement,
FRigConnectorSettings InSettings,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands
)

 Sets the connector settings for a given connector element Rigs/RigHierarchy.h  

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 Rigs/RigHierarchy.h  

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

 Sets the control settings for a given control element Rigs/RigHierarchy.h  

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 Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

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

 Sets a control's current value Rigs/RigHierarchy.h  

void SetControlVisibility ( FRigControlElement* InControlElement,
bool bVisibility
)

 Sets a control's current visibility Rigs/RigHierarchy.h  

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

 Sets a curve's value Rigs/RigHierarchy.h  

bool SetMetadata ( const TMap< FRigElementKey, URigHierarchy::FMetadataStorage >& InMetadata
)

   Rigs/RigHierarchy.h  

void SetPreferredEulerAnglesFromValue ( FRigControlElement* InControlElement,
const FRigControlValue& InValue,
const ERigControlValueType& InValueType,
bool bFixEulerFlips
) const

 Sets a control's preferred euler angle. Rigs/RigHierarchy.h  

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 Rigs/RigHierarchy.h  

bool ShouldBeGrouped ( const FRigControlElement* InControlElement
) const

 Returns true if the control should be grouped in editor Rigs/RigHierarchy.h  

bool ShouldBeGrouped ( const FRigElementKey& InKey
) const

 Returns true if the control should be grouped in editor Rigs/RigHierarchy.h  

void StorePoseForTrace ( const FString& InPrefix
)

 Stores the current pose for tracing Rigs/RigHierarchy.h  

void TraceFrames ( int32 InNumFramesToTrace
)

 Tells this hierarchy to trace a series of frames Rigs/RigHierarchy.h  

void UnregisterListeningHierarchy ( URigHierarchy* InHierarchy
)

 Remove dependent hierarchies that listens to changes made to this hierarchy Rigs/RigHierarchy.h  

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

 Unsets a curve's value. Basically the curve's value becomes meaningless. Rigs/RigHierarchy.h  

void UnsetCurveValues ( bool bSetupUndo
)

 Resets all curves to be unset (defaulting to 0.0) Rigs/RigHierarchy.h  

void UpdateReferences ( const FRigVMExecuteContext* InContext
)

 Update all elements that depend on external references Rigs/RigHierarchy.h  

bool UsesPreferredEulerAngles()

   Rigs/RigHierarchy.h  

Public Virtual

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Rigs/RigHierarchy.h  

virtual void PostEditUndo()

   Rigs/RigHierarchy.h  

virtual void PostLoad()

   Rigs/RigHierarchy.h  

virtual void PreEditUndo()

   Rigs/RigHierarchy.h  

virtual void Serialize ( FArchive& Ar
)

   Rigs/RigHierarchy.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   Rigs/RigHierarchy.h  

static void CheckTraceFormatIfRequired()

 Updates the format for trace floating point numbers Rigs/RigHierarchy.h  

static void ComputeParentConstraintIndices ( const FRigElementParentConstraintArray& InConstraints,
ERigTransformType::Type InTransformType,
FConstraintIndex& OutFirstConstraint,
FConstraintIndex& OutSecondConstraint,
FConstraintIndex& OutNumConstraintsAffecting,
FRigElementWeight& OutTotalWeight
)

   Rigs/RigHierarchy.h  

static TArray< FString > ConnectorSettingsToPythonCommands ( const FRigConnectorSettings& Settings,
const FString& NameSettings
)

   Rigs/RigHierarchy.h  

static TArray< FString > ControlSettingsToPythonCommands ( const FRigControlSettings& Settings,
const FString& NameSettings
)

   Rigs/RigHierarchy.h  

static void ConvertElements ( RangeType InElements,
TArray< ElementType* >& OutElements,
bool bFilterNull
)

   Rigs/RigHierarchy.h  

static TArray< ElementType * > ConvertElements ( RangeType InElements,
bool bFilterNull
)

   Rigs/RigHierarchy.h  

static void ConvertElementsToIndices ( RangeType InElements,
TArray< int32 >& OutIndices
)

   Rigs/RigHierarchy.h  

static TArray< int32 > ConvertElementsToIndices ( RangeType InElements
)

   Rigs/RigHierarchy.h  

static TArray< FRigElementKey > ConvertElementsToKeys ( RangeType InElements
)

   Rigs/RigHierarchy.h  

static void ConvertElementsToKeys ( RangeType InElements,
TArray< FRigElementKey >& OutKeys
)

   Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

static int32 ElementToFlatIndex()

   Rigs/RigHierarchy.h  

static ERigElementType FlatIndexToRigElementType ( int32 InIndex
)

   Rigs/RigHierarchy.h  
Returns the pin type to use for a control type Rigs/RigHierarchy.h  

static int32 GetDefaultMaxNameLength()

 Returns the max allowed length for a name within the hierarchy. Rigs/RigHierarchy.h  

static FRigElementKey GetDefaultParentKey()

   Rigs/RigHierarchy.h  

static FEulerTransform GetEulerTransformFromControlValue ( FRigControlValue InValue
)

 Returns the contained FEulerTransform value from a a Rig Control Value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static float GetFloatFromControlValue ( FRigControlValue InValue
)

 Returns the contained float value from a a Rig Control Value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static int32 GetIntFromControlValue ( FRigControlValue InValue
)

 Returns the contained int32 value from a a Rig Control Value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FRotator GetRotatorFromControlValue ( FRigControlValue InValue
)

 Returns the contained FRotator value from a a Rig Control Value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FRigName GetSanitizedName ( const FRigName& InName,
bool bAllowNameSpaces,
int32 InMaxNameLength
)

 Sanitizes a name by removing invalid characters. Rigs/RigHierarchy.h  

static FTransform GetTransformFromControlValue ( FRigControlValue InValue
)

 Returns the contained FTransform value from a a Rig Control Value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FTransformNoScale GetTransformNoScaleFromControlValue ( FRigControlValue InValue
)

 Returns the contained FTransformNoScale value from a a Rig Control Value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static const TArray< FString > & GetTransformTypeStrings()

   Rigs/RigHierarchy.h  

static FName GetUniqueName ( const FName& InName,
TFunction< bool(const FName&)> IsNameAvailablePredicate
)

   Rigs/RigHierarchy.h  

static FVector2D GetVector2DFromControlValue ( FRigControlValue InValue
)

 Returns the contained FVector2D value from a a Rig Control Value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FVector GetVectorFromControlValue ( FRigControlValue InValue
)

 Returns the contained FVector value from a a Rig Control Value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static float GetWeightForLerp ( const float WeightA,
const float WeightB
)

   Rigs/RigHierarchy.h  

static FRigElementKey GetWorldSpaceReferenceKey()

   Rigs/RigHierarchy.h  

static void IntegrateParentConstraintQuat ( int32& OutNumMixedRotations,
FQuat& OutFirstRotation,
FQuat& OutMixedRotation,
const FTransform& InTransform,
float InWeight
)

   Rigs/RigHierarchy.h  

static void IntegrateParentConstraintVector ( FVector& OutVector,
const FTransform& InTransform,
float InWeight,
bool bIsLocation
)

   Rigs/RigHierarchy.h  

static FString JoinNameSpace_Deprecated ( const FString& InLeft,
const FString& InRight
)

 Returns the two name sections with the right namespace separator Rigs/RigHierarchy.h  

static FRigName JoinNameSpace_Deprecated ( const FRigName& InLeft,
const FRigName& InRight
)

   Rigs/RigHierarchy.h  

static FRigControlValue MakeControlValueFromBool ( bool InValue
)

 Creates a rig control value from a bool value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FRigControlValue MakeControlValueFromEulerTransform ( FEulerTransform InValue
)

 Creates a rig control value from a FEulerTransform value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FRigControlValue MakeControlValueFromFloat ( float InValue
)

 Creates a rig control value from a float value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FRigControlValue MakeControlValueFromInt ( int32 InValue
)

 Creates a rig control value from a int32 value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FRigControlValue MakeControlValueFromRotator ( FRotator InValue
)

 Creates a rig control value from a FRotator value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FRigControlValue MakeControlValueFromTransform ( FTransform InValue
)

 Creates a rig control value from a FTransform value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FRigControlValue MakeControlValueFromTransformNoScale ( FTransformNoScale InValue
)

 Creates a rig control value from a FTransformNoScale value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FRigControlValue MakeControlValueFromVector ( FVector InValue
)

 Creates a rig control value from a FVector value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static FRigControlValue MakeControlValueFromVector2D ( FVector2D InValue
)

 Creates a rig control value from a FVector2D value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

static int32 RigElementTypeToFlatIndex ( ERigElementType InElementType
)

   Rigs/RigHierarchy.h  

static void SanitizeName ( FRigName& InOutName,
bool bAllowNameSpaces,
int32 InMaxNameLength
)

 Sanitizes a name by removing invalid characters. Rigs/RigHierarchy.h  

static TPair< FString, FString > SplitNameSpace_Deprecated ( const FString& InNameSpacedPath,
bool bFromEnd
)

 Returns the two name sections with the right namespace separator Rigs/RigHierarchy.h  

static TPair< FRigName, FRigName > SplitNameSpace_Deprecated ( const FRigName& InNameSpacedPath,
bool bFromEnd
)

   Rigs/RigHierarchy.h  

static bool SplitNameSpace_Deprecated ( const FString& InNameSpacedPath,
FString* OutNameSpace,
FString* OutName,
bool bFromEnd
)

   Rigs/RigHierarchy.h  

static bool SplitNameSpace_Deprecated ( const FRigName& InNameSpacedPath,
FRigName* OutNameSpace,
FRigName* OutName,
bool bFromEnd
)

   Rigs/RigHierarchy.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page