1. Epic GamesDeveloper
  3. URigHierarchy

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  
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  
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  

bool CanCauseCycle ( FRigElementKey InChild,
FRigElementKey InParent,
const IRigDependenciesProvider& InDependencyProvider,
FString* OutFailureReason
) const

 Determines if relating the child element to the given parent would cause a cycle Rigs/RigHierarchy.h  

bool CanCauseCycle ( const FRigTransformElement* InChild,
const FRigTransformElement* InParent,
const IRigDependenciesProvider& InDependencyProvider,
FString* OutFailureReason
) const

 Determines if relating the child element to the given parent would cause a cycle Rigs/RigHierarchy.h  

bool CanSwitchToParent ( FRigElementKey InChild,
FRigElementKey InParent,
const IRigDependenciesProvider& InDependencyProvider,
FString* OutFailureReason
) const

 Determines if the element can be switched to a provided parent Rigs/RigHierarchy.h  

void CleanupInvalidCaches()

 Cleans up caches after load Rigs/RigHierarchy.h  

void ClearListeningHierarchy()

   Rigs/RigHierarchy.h  

bool Contains ( const FRigElementKey& InKey
) const

 Returns true if the provided element key is valid 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_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 EndInteraction()

 Starts an interaction on the rig. This will cause all transform actions happening to be merged Rigs/RigHierarchy.h  

void EnsureCacheValidity()

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

FRigBaseElement * 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  

T * Find ( const FRigElementKey& InKey
)

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

const FRigBaseElement * Find ( const FRigElementKey& InKey
) const

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

const FRigElementKeyCollection * FindCachedCollection ( uint32 InHash
) const

   Rigs/RigHierarchy.h  

T * FindChecked ( const FRigElementKey& InKey
)

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

const T * FindChecked ( const FRigElementKey& InKey
) const

 Returns an element for a given key. 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  
Returns a component for a given key or nullptr. Rigs/RigHierarchy.h  

const FRigBaseComponent * FindComponent ( const FRigComponentKey& InKey
) const

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

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

   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  

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  

const FRigBaseElement * Get ( int32 InIndex
) const

 Returns an element at a given index or nullptr. 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  

FRigBaseElementChildrenArray GetActiveChildren ( const FRigBaseElement* InElement,
bool bRecursive
) const

 Returns the child elements of a given element key Rigs/RigHierarchy.h  

int32 GetActiveParent ( int32 InIndex
) const

 Get the current active parent for a given element index. Rigs/RigHierarchy.h  

FRigBaseElement * GetActiveParent ( const FRigBaseElement* InElement
) const

 Get the current active parent for the passed in key. Rigs/RigHierarchy.h  

FRigElementKey GetActiveParent ( const FRigElementKey& InKey,
bool bReferenceKey
) const

 Get the current active parent for the passed in key. Rigs/RigHierarchy.h  

TArray< FRigComponentKey > GetAllComponentKeys()

   Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

TArray< FRigElementKey > GetAllKeys ( bool bTraverse,
ERigElementType InElementType
) const

 Returns all element keys of this hierarchy Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetAllKeys_ForBlueprint ( bool bTraverse
) const

 Returns all element keys of this hierarchy Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get All Keys", ScriptName="GetAllKeys")

TArray< FRigElementKey > GetAnimationChannels ( FRigElementKey InKey,
bool bOnlyDirectChildren
) const

 Returns the animation channels of a given element key Rigs/RigHierarchy.h  

TArray< int32 > GetAnimationChannels ( int32 InIndex,
bool bOnlyDirectChildren
) const

 Returns the animation channels of a given element index Rigs/RigHierarchy.h  

TArray< FRigControlElement * > GetAnimationChannels ( const FRigControlElement* InElement,
bool bOnlyDirectChildren
) const

 Returns the animation channels of a given element Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetBoneKeys ( bool bTraverse
) const

 Returns all Bone elements Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get Bones", ScriptName="GetBones")

TArray< FRigBoneElement * > GetBones ( bool bTraverse
) const

 Returns all Bone elements Rigs/RigHierarchy.h  

TArray< FRigBaseElement * > & GetBonesFast()

 Returns all Bone elements without traversing the hierarchy Rigs/RigHierarchy.h  

TArray< bool > GetBoolArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
) const

 Queries and returns the value of bool array metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

bool GetBoolMetadata ( FRigElementKey InItem,
FName InMetadataName,
bool DefaultValue
) const

 Queries and returns the value of bool metadata 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  

FRigBaseElementChildrenArray GetChildren ( const FRigBaseElement* InElement,
bool bRecursive
) const

 Returns the child elements of a given element Rigs/RigHierarchy.h  

TConstArrayView< FRigBaseElement * > GetChildren ( const FRigBaseElement* InElement
) const

 Returns the child elements of a given element Rigs/RigHierarchy.h  
  Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetChildren ( FRigElementKey InKey,
bool bRecursive
) const

 Returns the child elements of a given element key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

TArray< int32 > GetChildren ( int32 InIndex,
bool bRecursive
) const

 Returns the child elements of a given element index Rigs/RigHierarchy.h  

FRigBaseComponent * 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  

T * 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 * GetComponentChecked ( int32 InIndex
)

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

const T * GetComponentChecked ( int32 InIndex
) const

 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 FRigBaseComponent * > GetComponents ( const UScriptStruct* InComponentStruct
) const

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

TArray< const T * > GetComponents ()

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

UScriptStruct * GetComponentType ( FRigElementKey InElement,
int32 InComponentIndex
) const

   Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

TArray< FRigElementKey > GetConnectorKeys ( bool bTraverse
) const

 Returns all Connector elements Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get Connectors", ScriptName="GetConnectors")

TArray< FRigConnectorElement * > GetConnectors ( bool bTraverse
) const

 Returns all Connector elements Rigs/RigHierarchy.h  

TArray< FRigConnectorState > GetConnectorStates()

 Returns all of the connectors' state Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FVector GetControlAnglesFromQuat ( const FRigControlElement* InControlElement,
const FQuat& InQuat,
bool bUseRotationOrder
) const

   Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetControlKeys ( bool bTraverse
) const

 Returns all Control elements Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get Controls", ScriptName="GetControls")

URigHierarchyController * GetController ( bool bCreateIfNeeded
)

 Returns a controller for this hierarchy. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

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

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

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

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

 Returns a control's preferred euler angles (local transform rotation) Rigs/RigHierarchy.h  

FVector GetControlPreferredEulerAngles ( FRigElementKey InKey,
EEulerRotationOrder InRotationOrder,
bool bInitial
) const

 Returns a control's preferred euler angles (local transform rotation) Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FVector GetControlPreferredEulerAnglesByIndex ( int32 InElementIndex,
EEulerRotationOrder InRotationOrder,
bool bInitial
) const

 Returns a control's preferred euler angles (local transform rotation) Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

EEulerRotationOrder GetControlPreferredEulerRotationOrder ( const FRigControlElement* InControlElement,
bool bFromSettings
) const

 Returns a control's preferred euler rotation order Rigs/RigHierarchy.h  
Returns a control's preferred euler rotation order Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

EEulerRotationOrder GetControlPreferredEulerRotationOrderByIndex ( int32 InElementIndex,
bool bFromSettings
) const

 Returns a control's preferred euler rotation order Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FRotator GetControlPreferredRotator ( FRigElementKey InKey,
bool bInitial
) const

 Returns a control's preferred rotator (local transform rotation) Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FRotator GetControlPreferredRotator ( const FRigControlElement* InControlElement,
bool bInitial
) const

 Returns a control's preferred rotator (local transform rotation) Rigs/RigHierarchy.h  

FRotator GetControlPreferredRotatorByIndex ( int32 InElementIndex,
bool bInitial
) const

 Returns a control's preferred rotator (local transform rotation) Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

   Rigs/RigHierarchy.h  

TArray< FRigControlElement * > GetControls ( bool bTraverse
) const

 Returns all Control elements 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  

FVector GetControlSpecifiedEulerAngle ( const FRigControlElement* InControlElement,
bool bIsInitial
) const

   Rigs/RigHierarchy.h  

T GetControlValue ( int32 InElementIndex,
ERigControlValueType InValueType
) const

 Returns a control's current value given its index 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  

FRigControlValue GetControlValue ( int32 InElementIndex,
ERigControlValueType InValueType
) const

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

T GetControlValue ( FRigElementKey InKey,
ERigControlValueType InValueType
) const

 Returns a control's current value given its key Rigs/RigHierarchy.h  
Returns a control's current value given its key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FRigControlValue GetControlValueByIndex ( int32 InElementIndex,
ERigControlValueType InValueType
) const

 Returns a control's current value given its index Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

TArray< FRigElementKey > GetCurveKeys()

 Returns all Curve elements Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get Curves", ScriptName="GetCurves")

TArray< FRigCurveElement * > GetCurves()

 Returns all Curve elements Rigs/RigHierarchy.h  

TArray< FRigBaseElement * > & GetCurvesFast()

 Returns all Curve elements without traversing the hierarchy Rigs/RigHierarchy.h  

float GetCurveValue ( FRigCurveElement* InCurveElement
) const

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

float GetCurveValue ( int32 InElementIndex
) const

 TODO: Deprecate? Rigs/RigHierarchy.h  

float GetCurveValue ( FRigElementKey InKey
) const

 Returns a curve's value given its key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

float GetCurveValueByIndex ( int32 InElementIndex
) const

 Returns a curve's value given its index Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

URigHierarchy * GetDefaultHierarchy()

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

FRigElementKey GetDefaultParent ( FRigElementKey InKey
) const

 Returns the default parent element's key of a given child key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FName GetDisplayLabelForParent ( const FRigElementKey& InChildKey,
const FRigElementKey& InParentKey
) const

 Returns the display label to use for the space given a parent key Rigs/RigHierarchy.h  
  Rigs/RigHierarchy.h  

FText GetDisplayNameForUI ( const FRigBaseElement* InElement,
EElementNameDisplayMode InNameMode
) const

 Returns the display label for an element to be used for the UI Rigs/RigHierarchy.h  

TArray< T * > GetElementsOfType ( bool bTraverse
) const

 Filtered accessor to retrieve all elements of a given type Rigs/RigHierarchy.h  

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

 Filtered accessor to retrieve all elements of a given type Rigs/RigHierarchy.h  

int32 GetFirstParent ( int32 InIndex
) const

 Returns the first parent element of a given element index Rigs/RigHierarchy.h  
Returns the first parent element of a given element key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FRigBaseElement * GetFirstParent ( const FRigBaseElement* InElement
) const

 Returns the first parent element of a given element Rigs/RigHierarchy.h  

TArray< float > GetFloatArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
) const

 Queries and returns the value of float array metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

float GetFloatMetadata ( FRigElementKey InItem,
FName InMetadataName,
float DefaultValue
) const

 Queries and returns the value of float metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FTransform GetGlobalControlOffsetTransform ( FRigElementKey InKey,
bool bInitial
) const

 Returns the global offset transform for a given control element. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FTransform GetGlobalControlOffsetTransformByIndex ( int32 InElementIndex,
bool bInitial
) const

 Returns the global offset transform for a given control element. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FTransform GetGlobalControlShapeTransform ( FRigElementKey InKey,
bool bInitial
) const

 Returns the global shape transform for a given control element. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FTransform GetGlobalControlShapeTransformByIndex ( int32 InElementIndex,
bool bInitial
) const

 Returns the global shape transform for a given control element. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FTransform GetGlobalTransform ( FRigElementKey InKey,
bool bInitial
) const

 Returns the global current or initial value for a given key. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FTransform GetGlobalTransform ( int32 InElementIndex
) const

   Rigs/RigHierarchy.h  

FTransform GetGlobalTransformByIndex ( int32 InElementIndex,
bool bInitial
) const

 Returns the global current or initial value for a element index. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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  

FRigControlValue GetInitialControlValue ( int32 InElementIndex
) const

 Returns a control's initial value given its index Rigs/RigHierarchy.h  

T GetInitialControlValue ( int32 InElementIndex
) const

 Returns a control's initial value given its index Rigs/RigHierarchy.h  

FTransform GetInitialGlobalTransform ( const FRigElementKey& InKey
) const

   Rigs/RigHierarchy.h  

FTransform GetInitialGlobalTransform ( int32 InElementIndex
) const

   Rigs/RigHierarchy.h  

FTransform GetInitialLocalTransform ( const FRigElementKey& InKey
) const

   Rigs/RigHierarchy.h  

FTransform GetInitialLocalTransform ( int32 InElementIndex
) const

   Rigs/RigHierarchy.h  

TArray< int32 > GetInt32ArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
) const

 Queries and returns the value of int32 array metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

int32 GetInt32Metadata ( FRigElementKey InItem,
FName InMetadataName,
int32 DefaultValue
) const

 Queries and returns the value of int32 metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

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

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

 Returns element keys of this hierarchy, filtered by a predicate. Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetKeysOfType ( bool bTraverse
) const

 Filtered accessor to retrieve all element keys of a given type Rigs/RigHierarchy.h  

TArray< FLinearColor > GetLinearColorArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
) const

 Queries and returns the value of FLinearColor array metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FLinearColor GetLinearColorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FLinearColor DefaultValue
) const

 Queries and returns the value of FLinearColor metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FTransform GetLocalControlShapeTransform ( FRigElementKey InKey,
bool bInitial
) const

 Returns the local shape transform for a given control element. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FTransform GetLocalControlShapeTransformByIndex ( int32 InElementIndex,
bool bInitial
) const

 Returns the local shape transform for a given control element. 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")

FTransform GetLocalTransform ( int32 InElementIndex
) const

   Rigs/RigHierarchy.h  

FTransform GetLocalTransform ( FRigElementKey InKey,
bool bInitial
) const

 Returns the local current or initial value for a given key. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FTransform GetLocalTransformByIndex ( int32 InElementIndex,
bool bInitial
) const

 Returns the local current or initial value for a element index. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

int32 GetMaxNameLength()

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

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  

TArray< FName > GetMetadataNames ( FRigElementKey InItem
) const

 Returns the name of metadata for a given element Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

uint32 GetMetadataTagVersion()

 Returns the metadata tag version of this hierarchy Rigs/RigHierarchy.h  

ERigMetadataType GetMetadataType ( FRigElementKey InItem,
FName InMetadataName
) const

 Returns the type of metadata given its name the item it is stored under Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

uint32 GetMetadataVersion()

 Returns the metadata version of this hierarchy Rigs/RigHierarchy.h  

FName GetModuleFName ( FRigElementKey InItem
) const

 Returns the name of the module an element belong to (or NAME_None in case the element doesn't belong to a module) Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FString GetModuleName ( FRigElementKey InItem
) const

 Returns the name of the module an element belong to (or an empty string in case the element doesn't belong to a module) Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FString GetModulePath ( FRigElementKey InItem
) const

 Returns the path of the module an element belong to (or an empty string in case the element doesn't belong to a module) Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated. Please use GetModuleName() instead.")

FName GetModulePathFName ( FRigElementKey InItem
) const

 Returns the path of the module an element belong to (or NAME_None in case the element doesn't belong to a module) Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated. Please use GetModuleFName() instead.")

FString GetModulePrefix ( FRigElementKey InItem
) const

 Returns the prefix of the module an element belong to (or an empty string in case the element doesn't belong to a module) Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

TArray< FName > GetNameArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
) const

 Queries and returns the value of FName array metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

uint32 GetNameHash()

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

FName GetNameMetadata ( FRigElementKey InItem,
FName InMetadataName,
FName DefaultValue
) const

 Queries and returns the value of FName metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FString GetNameSpace ( FRigElementKey InItem
) const

 Returns the namespace of an element belong to (or an empty string in case the element doesn't belong to a module / namespace) Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated. Please use GetModuleName() instead.")

FName GetNameSpaceFName ( FRigElementKey InItem
) const

 Returns the namespace of an element belong to (or NAME_None in case the element doesn't belong to a module / namespace) Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated. Please use GetModuleFName() instead.")

int32 GetNextSpawnIndex()

   Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetNullKeys ( bool bTraverse
) const

 Returns all Null elements Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get Nulls", ScriptName="GetNulls")

TArray< FRigNullElement * > GetNulls ( bool bTraverse
) const

 Returns all Null elements Rigs/RigHierarchy.h  

int32 GetNumberOfParents ( FRigElementKey InKey
) const

 Returns the number of parents of an element Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

int32 GetNumberOfParents ( int32 InIndex
) const

 Returns the number of parents of an element Rigs/RigHierarchy.h  

int32 GetNumberOfParents ( const FRigBaseElement* InElement
) const

 Returns the number of parents of an element Rigs/RigHierarchy.h  

FRigElementKey GetOrAddWorldSpaceReference()

 Adds the world space reference or returns it Rigs/RigHierarchy.h  

FRigBaseElementParentArray GetParents ( const FRigBaseElement* InElement,
bool bRecursive
) const

 Returns the parent elements of a given element Rigs/RigHierarchy.h  

TArray< int32 > GetParents ( int32 InIndex,
bool bRecursive
) const

 Returns the parent elements of a given element index Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetParents ( FRigElementKey InKey,
bool bRecursive
) const

 Returns the parent elements of a given element key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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  

FTransform GetParentTransform ( FRigElementKey InKey,
bool bInitial
) const

 Returns the global current or initial value for a given key. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FTransform GetParentTransformByIndex ( int32 InElementIndex,
bool bInitial
) const

 Returns the global current or initial value for a given element index. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Returns the weight of a parent below a multi parent element Rigs/RigHierarchy.h  

FRigElementWeight GetParentWeight ( FRigElementKey InChild,
FRigElementKey InParent,
bool bInitial
) const

 Returns the weight of a parent below a multi parent element Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Returns the weight of a parent below a multi parent element Rigs/RigHierarchy.h  

TArray< FRigElementWeight > GetParentWeightArray ( const FRigBaseElement* InChild,
bool bInitial
) const

 Returns the weights of all parents below a multi parent element Rigs/RigHierarchy.h  

TArray< FRigElementWeight > GetParentWeightArray ( FRigElementKey InChild,
bool bInitial
) const

 Returns the weights of all parents below a multi parent element Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

uint32 GetParentWeightVersion()

 Returns the parent weight version of this hierarchy Rigs/RigHierarchy.h  

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

 Returns the current / initial pose of the hierarchy Rigs/RigHierarchy.h  

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

 Returns the current / initial pose of the hierarchy Rigs/RigHierarchy.h  

FRigPose GetPose ( bool bInitial,
bool bIncludeTransientControls
) const

 Returns the current / initial pose of the hierarchy Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

int32 GetPoseVersion ( const FRigTransformElement* InTransformElement
) const

 Returns the version of the transform / pose on the given element. Rigs/RigHierarchy.h  

int32 GetPoseVersion ( const FRigElementKey& InKey
) const

 Returns the version of the transform / pose on the element given its key. 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

TArray< FQuat > GetQuatArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
) const

 Queries and returns the value of FQuat array metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FQuat GetQuatMetadata ( FRigElementKey InItem,
FName InMetadataName,
FQuat DefaultValue
) const

 Queries and returns the value of FQuat metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

bool & GetRecordCurveChangesFlag()

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

TArray< FRigElementKey > GetReferenceKeys ( bool bTraverse
) const

 Returns all references Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get References", ScriptName="GetReferences")

TArray< FRigReferenceElement * > GetReferences ( bool bTraverse
) const

 Returns all references Rigs/RigHierarchy.h  

const FRigElementKey & GetResolvedTarget ( const FRigElementKey& InConnectorKey
) const

 Returns the first currently resolved target for given connector key Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetResolvedTargets ( const FRigElementKey& InConnectorKey
) const

 Returns all currently resolved targets for given connector key Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetRigElementKeyArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
) const

 Queries and returns the value of FRigElementKey array metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FRigElementKey GetRigElementKeyMetadata ( FRigElementKey InItem,
FName InMetadataName,
FRigElementKey DefaultValue
) const

 Queries and returns the value of FRigElementKey metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

TArray< FRigElementKey > GetRootElementKeys()

 Returns all root element keys Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get Root Elements", ScriptName="GetRootElements")

TArray< FRigBaseElement * > GetRootElements()

 Returns all root elements Rigs/RigHierarchy.h  

TArray< FRotator > GetRotatorArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
) const

 Queries and returns the value of FRotator array metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FRotator GetRotatorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FRotator DefaultValue
) const

 Queries and returns the value of FRotator metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

UModularRigRuleManager * GetRuleManager ( bool bCreateIfNeeded
)

 Returns a rule manager for this hierarchy Note: If the manager is not available this will return nullptr even if the bCreateIfNeeded flag is set to true. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

FRigName GetSafeNewComponentName ( const FRigElementKey& InElementKey,
const FRigName& InPotentialNewName
) const

 Returns a valid new name for a to-be-added element. Rigs/RigHierarchy.h  

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

 Returns a valid new display name for a control Rigs/RigHierarchy.h  

FRigName GetSafeNewName ( const FRigName& InPotentialNewName,
ERigElementType InType,
bool bAllowNameSpace
) const

 Returns a valid new name for a to-be-added element. Rigs/RigHierarchy.h  

TArray< const FRigBaseComponent * > GetSelectedComponents()

 Returns the selected components Rigs/RigHierarchy.h  

TArray< const FRigBaseElement * > GetSelectedElements ( ERigElementType InTypeFilter
) const

 Returns the selected elements @InTypeFilter The types to retrieve the selection for Rigs/RigHierarchy.h  

const TArray< FRigHierarchyKey > & GetSelectedHierarchyKeys()

   Rigs/RigHierarchy.h  

TArray< FRigHierarchyKey > GetSelectedHierarchyKeys_ForBlueprint()

 Returns the keys of selected elements and components Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get Selected Hierarchy Keys", ScriptName="GetSelectedHierarchyKeys")

TArray< FRigElementKey > GetSelectedKeys ( ERigElementType InTypeFilter
) const

 Returns the keys of selected elements @InTypeFilter The types to retrieve the selection for Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

TArray< FRigElementKey > GetSelectedKeysByPredicate ( TFunctionRef< bool(const FRigElementKey&)> InPredicate
) const

 Returns the keys of selected elements respecting the provided predicate @InPredicate A function that should return true when the element is desirable Rigs/RigHierarchy.h  

TArray< FRigElementKey > GetSocketKeys ( bool bTraverse
) const

 Returns all Socket elements Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Get Sockets", ScriptName="GetSockets")

TArray< FRigSocketElement * > GetSockets ( bool bTraverse
) const

 Returns all Socket elements Rigs/RigHierarchy.h  

TArray< FRigSocketState > GetSocketStates()

 Returns all of the sockets' state Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

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  

TArray< FName > GetTags ( FRigElementKey InItem
) const

 Returns the tags for a given item Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

uint32 GetTopologyHash ( bool bIncludeTopologyVersion,
bool bIncludeTransientControls
) const

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

uint32 GetTopologyVersion()

 Returns the topology version of this hierarchy Rigs/RigHierarchy.h  

uint32 GetTopologyVersionHash()

 Returns the hash of this hierarchy used for cached element keys Rigs/RigHierarchy.h  

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

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

TArray< FTransform > GetTransformArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
) const

 Queries and returns the value of FTransform array metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FTransform GetTransformMetadata ( FRigElementKey InItem,
FName InMetadataName,
FTransform DefaultValue
) const

 Queries and returns the value of FTransform metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

int32 GetTransformStackIndex()

 Returns the transform stack index Rigs/RigHierarchy.h  

TArray< FRigControlElement * > GetTransientControls()

 Returns all transient Control elements Rigs/RigHierarchy.h  

bool GetUsePreferredRotationOrder ( const FRigControlElement* InControlElement
) const

   Rigs/RigHierarchy.h  

TArray< FVector > GetVectorArrayMetadata ( FRigElementKey InItem,
FName InMetadataName
) const

 Queries and returns the value of FVector array metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

FVector GetVectorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FVector DefaultValue
) const

 Queries and returns the value of FVector metadata Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

bool HasAnythingSelectedByPredicate ( TFunctionRef< bool(const FRigElementKey&)> InPredicate
) const

 Returns true if any element is selected and respects the provided predicate @InPredicate A function that should return true when the element is desirable 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 HasTag ( FRigElementKey InItem,
FName InTag
) const

 Returns true if a given item has a certain tag Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

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 ( const FRigBaseElement* InElement
) const

   Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

void IncrementParentWeightVersion()

 Increments the parent weight version of this hierarchy Rigs/RigHierarchy.h  

void IncrementTopologyVersion()

 Increments the topology version 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 IsComponentNameAvailable ( const FRigElementKey& InElementKey,
const FRigName& InPotentialNewName,
FString* OutErrorMessage
) const

 Returns true if a given component name is available. Rigs/RigHierarchy.h  

bool IsComponentSelected ( FRigComponentKey InKey
) const

 Returns true if a given component is selected Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
Returns true if the hierarchy controller is currently available The controller may not be available during certain events. Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

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 IsCurveValueSet ( FRigElementKey InKey
) const

 Returns whether a curve's value is set, given its key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool IsCurveValueSetByIndex ( int32 InElementIndex
) const

 Returns a curve's value given its index Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Returns true if a given display name is available. Rigs/RigHierarchy.h  

bool IsHierarchyKeySelected ( FRigHierarchyKey InKey
) const

   Rigs/RigHierarchy.h  

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

 Returns true if a given name is available. Rigs/RigHierarchy.h  

bool IsParentedTo ( FRigElementKey InChild,
FRigElementKey InParent
) const

 Returns true if an element is parented to another element Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool IsParentedTo ( int32 InChildIndex,
int32 InParentIndex,
const IRigDependenciesProvider& InDependencyProvider,
FRigHierarchyDependencyChain* OutDependencyChain
) const

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

bool IsParentedTo ( FRigBaseElement* InChild,
FRigBaseElement* InParent,
const IRigDependenciesProvider& InDependencyProvider,
FRigHierarchyDependencyChain* OutDependencyChain
) 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 FRigBaseElement* InElement
) const

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

bool IsProcedural ( const FRigComponentKey& InKey
) const

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

bool IsProcedural ( const FRigBaseComponent* InComponent
) 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 IsSelected ( int32 InIndex
) const

   Rigs/RigHierarchy.h  

bool IsSelected ( FRigElementKey InKey
) const

 Returns true if a given element is selected Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool IsSelectedByIndex ( int32 InIndex
) const

 Returns true if a given element is selected Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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 LinkPoseAdapter ( TSharedPtr< FRigHierarchyPoseAdapter > InPoseAdapter
)

 Sets the pose adapter used for storage of pose data Rigs/RigHierarchy.h  

void Load ( FArchive& Ar
)

   Rigs/RigHierarchy.h  

void Notify ( ERigHierarchyNotification InNotifType,
const FRigNotificationSubject& InSubject
)

   Rigs/RigHierarchy.h  

int32 Num ( ERigElementType InElementType
) const

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

int32 Num ()

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

int32 NumComponents ( FRigElementKey InElement
) const

   Rigs/RigHierarchy.h
  • BlueprintPure
  • Category=URigHierarchy

int32 NumComponents ( const UScriptStruct* InComponentStruct
) const

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

int32 NumComponents ()

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

int32 NumComponents ()

 Returns the count of all components Rigs/RigHierarchy.h  

FRigHierarchyDismissDependencyDelegate & OnDependencyDismissed ()

 Returns the DependencyDismissed delegate. Rigs/RigHierarchy.h  

FRigEventDelegate & OnEventReceived()

 Returns the delegate to listen to for events coming from this hierarchy Rigs/RigHierarchy.h  

FRigHierarchyMetadataChangedDelegate & OnMetadataChanged ()

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

FRigHierarchyMetadataTagChangedDelegate & OnMetadataTagChanged ()

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

FRigHierarchyModifiedEvent & OnModified()

 Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy. Rigs/RigHierarchy.h  
Returns the event fired during undo / redo Rigs/RigHierarchy.h  

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 PropagateMetadata ( const FRigBaseElement* InElement,
const FName& InName,
bool bNotify
)

   Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

bool Redo()

 Performs redo for one transform change 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  
Removes all of the metadata under a given item Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  Rigs/RigHierarchy.h  

bool RemoveAllMetadataForElement ( FRigBaseElement* InElement
)

   Rigs/RigHierarchy.h  

bool RemoveMetadata ( FRigElementKey InItem,
FName InMetadataName
)

 Removes the metadata under a given element Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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  

TArray< FRigElementKey > RestoreConnectorsFromStates ( TArray< FRigConnectorState > InStates,
bool bSetupUndoRedo
)

 Try to restore the connectors from the state structs Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

TArray< FRigElementKey > RestoreSocketsFromStates ( TArray< FRigSocketState > InStates,
bool bSetupUndoRedo
)

 Try to restore the sockets from the state structs Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void Save ( FArchive& Ar
)

   Rigs/RigHierarchy.h  

void SendAutoKeyEvent ( FRigElementKey InElement,
float InOffsetInSeconds,
bool bAsynchronous
)

 Sends an autokey event from the hierarchy to the world Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void SendEvent ( const FRigEventContext& InEvent,
bool bAsynchronous
)

 Sends an event from the hierarchy to the world Rigs/RigHierarchy.h  

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

 Sets the metadata to a bool array value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetBoolMetadata ( FRigElementKey InItem,
FName InMetadataName,
bool InValue
)

 Sets the metadata to a bool value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void SetConnectorSettings ( FRigElementKey InKey,
FRigConnectorSettings InSettings,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands
)

 Sets the connector settings for a given connector element by key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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 SetConnectorSettingsByIndex ( int32 InElementIndex,
FRigConnectorSettings InSettings,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands
)

 Sets the connector settings for a given connector element by index Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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 SetControlOffsetTransform ( FRigElementKey InKey,
FTransform InTransform,
bool bInitial,
bool bAffectChildren,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Sets the offset transform for a given control element by key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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 Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets a control's preferred euler angles (local transform rotation) Rigs/RigHierarchy.h  

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

 Sets a control's preferred euler angles (local transform rotation) Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void SetControlPreferredEulerAngles ( FRigControlElement* InControlElement,
const FTransform& InTransform,
bool bIsInitial
)

   Rigs/RigHierarchy.h  

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

 Sets a control's preferred euler angles (local transform rotation) Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void SetControlPreferredRotationOrder ( FRigControlElement* InControlElement,
EEulerRotationOrder InRotationOrder
)

 Sets a control's preferred euler rotation order Rigs/RigHierarchy.h  
Sets a control's preferred euler rotation order Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void SetControlPreferredRotationOrderByIndex ( int32 InElementIndex,
EEulerRotationOrder InRotationOrder
)

 Sets a control's preferred euler rotation order Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets a control's preferred rotator (local transform rotation) Rigs/RigHierarchy.h  

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

 Sets a control's preferred rotator (local transform rotation) Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets a control's preferred rotator (local transform rotation) Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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 SetControlSettings ( FRigElementKey InKey,
FRigControlSettings InSettings,
bool bSetupUndo,
bool bForce,
bool bPrintPythonCommands
)

 Sets the control settings for a given control element by key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets the control settings for a given control element by index Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets the shape transform for a given control element by key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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 SetControlShapeTransformByIndex ( int32 InElementIndex,
FTransform InTransform,
bool bInitial,
bool bSetupUndo
)

 Sets the local shape transform for a given control element by index Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

   Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

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

 Sets a control's current value given its key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

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

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

 Sets a control's current value given its index 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 SetControlValue ( int32 InElementIndex,
const T& InValue,
ERigControlValueType InValueType,
bool bSetupUndo
)

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

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

 Sets a control's current value given its index Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void SetControlVisibility ( FRigElementKey InKey,
bool bVisibility
)

 Sets a control's current visibility based on a key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void SetControlVisibility ( int32 InElementIndex,
bool bVisibility
)

   Rigs/RigHierarchy.h  

void SetControlVisibility ( FRigControlElement* InControlElement,
bool bVisibility
)

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

void SetControlVisibilityByIndex ( int32 InElementIndex,
bool bVisibility
)

 Sets a control's current visibility based on a key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets a curve's value Rigs/RigHierarchy.h  

void SetCurveValue ( int32 InElementIndex,
float InValue,
bool bSetupUndo
)

 TODO: Deprecate? Rigs/RigHierarchy.h  

void SetCurveValue ( FRigElementKey InKey,
float InValue,
bool bSetupUndo
)

 Sets a curve's value given its key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void SetCurveValueByIndex ( int32 InElementIndex,
float InValue,
bool bSetupUndo
)

 Sets a curve's value given its index Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets the metadata to a float array value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetFloatMetadata ( FRigElementKey InItem,
FName InMetadataName,
float InValue
)

 Sets the metadata to a float value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

   Rigs/RigHierarchy.h  

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. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets a control's initial value given its index Rigs/RigHierarchy.h  

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

 Sets a control's initial value given its index Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

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

 Sets the metadata to a int32 array value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetInt32Metadata ( FRigElementKey InItem,
FName InMetadataName,
int32 InValue
)

 Sets the metadata to a int32 value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets the metadata to a FLinearColor array value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetLinearColorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FLinearColor InValue
)

 Sets the metadata to a FLinearColor value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

   Rigs/RigHierarchy.h  

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. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

int32 SetMaxNameLength ( int32 InMaxNameLength
)

 Sets the maximum allowed length for a name within the hierarchy. Rigs/RigHierarchy.h  

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

   Rigs/RigHierarchy.h  

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

 Sets the metadata to a FName array value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetNameMetadata ( FRigElementKey InItem,
FName InMetadataName,
FName InValue
)

 Sets the metadata to a FName value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets the weight of a parent below a multi parent element Rigs/RigHierarchy.h  

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

 Sets the weight of a parent below a multi parent element Rigs/RigHierarchy.h  

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

 Sets the weight of a parent below a multi parent element Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

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

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 Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

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

 Sets the current / initial pose of the hierarchy Rigs/RigHierarchy.h  

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

 Sets the current / initial pose of the hierarchy Rigs/RigHierarchy.h  

void SetPose_ForBlueprint ( FRigPose InPose
)

 Sets the current / initial pose of the hierarchy Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy
  • Meta=(DisplayName="Set Pose", ScriptName="SetPose")

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

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

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

 Sets the metadata to a FQuat array value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetQuatMetadata ( FRigElementKey InItem,
FName InMetadataName,
FQuat InValue
)

 Sets the metadata to a FQuat value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets the metadata to a FRigElementKey array value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetRigElementKeyMetadata ( FRigElementKey InItem,
FName InMetadataName,
FRigElementKey InValue
)

 Sets the metadata to a FRigElementKey value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Sets the metadata to a FRotator array value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetRotatorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FRotator InValue
)

 Sets the metadata to a FRotator value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetTag ( FRigElementKey InItem,
FName InTag
)

 Sets a tag on an element in the hierarchy Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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 SetTransformArrayMetadata ( FRigElementKey InItem,
FName InMetadataName,
TArray< FTransform > InValue
)

 Sets the metadata to a FTransform array value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetTransformMetadata ( FRigElementKey InItem,
FName InMetadataName,
FTransform InValue
)

 Sets the metadata to a FTransform value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void SetUsePreferredRotationOrder ( FRigControlElement* InControlElement,
bool bVal
)

   Rigs/RigHierarchy.h  

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

 Sets the metadata to a FVector array value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SetVectorMetadata ( FRigElementKey InItem,
FName InMetadataName,
FVector InValue
)

 Sets the metadata to a FVector value Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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  

TArray< FRigElementKey > SortKeys ( const TArray< FRigElementKey >& InKeys
) const

 Sorts the input key list by traversing the hierarchy Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void StartInteraction()

 Starts an interaction on the rig. This will cause all transform actions happening to be merged Rigs/RigHierarchy.h  

void StorePoseForTrace ( const FString& InPrefix
)

 Stores the current pose for tracing Rigs/RigHierarchy.h  

bool SwitchToDefaultParent ( FRigElementKey InChild,
bool bInitial,
bool bAffectChildren
)

 Switches a multi parent element to its first parent Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

bool SwitchToParent ( FRigElementKey InChild,
FRigElementKey InParent,
bool bInitial,
bool bAffectChildren,
const IRigDependenciesProvider& InDependencyProvider,
FString* OutFailureReason
)

   Rigs/RigHierarchy.h  

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

 Switches a multi parent element to a single parent. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

bool SwitchToParent ( FRigBaseElement* InChild,
FRigBaseElement* InParent,
bool bInitial,
bool bAffectChildren,
const IRigDependenciesProvider& InDependencyProvider,
FString* OutFailureReason
)

 Switches a multi parent element to a single parent. Rigs/RigHierarchy.h  

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

 Switches a multi parent element to a single parent. Rigs/RigHierarchy.h  

bool SwitchToWorldSpace ( FRigElementKey InChild,
bool bInitial,
bool bAffectChildren
)

 Switches a multi parent element to world space. This injects a world space reference. Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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

 Switches a multi parent element to world space. This injects a world space reference. Rigs/RigHierarchy.h  

void TraceFrames ( int32 InNumFramesToTrace
)

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

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

 Helper function to traverse the hierarchy from the root Rigs/RigHierarchy.h  

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

 Helper function to traverse the hierarchy Rigs/RigHierarchy.h  

bool Undo()

 Performs undo for one transform change Rigs/RigHierarchy.h  

void UnlinkPoseAdapter()

 Clears the pose adapter used for storage of pose data 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 UnsetCurveValue ( FRigElementKey InKey,
bool bSetupUndo
)

 Sets a curve's value given its key Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

void UnsetCurveValueByIndex ( int32 InElementIndex,
bool bSetupUndo
)

 Sets a curve's value given its index Rigs/RigHierarchy.h
  • BlueprintCallable
  • Category=URigHierarchy

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  

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 TArray< ElementType * > ConvertElements ( RangeType InElements,
bool bFilterNull
)

   Rigs/RigHierarchy.h  

static void ConvertElements ( RangeType InElements,
TArray< ElementType* >& OutElements,
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 void ConvertElementsToKeys ( RangeType InElements,
TArray< FRigElementKey >& OutKeys
)

   Rigs/RigHierarchy.h  

static TArray< FRigElementKey > ConvertElementsToKeys ( RangeType InElements
)

   Rigs/RigHierarchy.h  

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

   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 FRigName JoinNameSpace_Deprecated ( const FRigName& InLeft,
const FRigName& InRight
)

   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 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