URigHierarchy

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

ControlRig

Header

/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h

Include

#include "Rigs/RigHierarchy.h"

Syntax

UCLASS(BlueprintType)
class URigHierarchy : public UObject

Variables

Name Description

Protected variable

bool

 

bEnableCacheValidityCheck

Protected variable UProperty Transient

TObjectPtr< URi...

 

HierarchyForCacheValidation

Protected variable

int32

 

TraceFramesCaptured

Protected variable

int32

 

TraceFramesLeft

Protected variable

TMap< FName, FR...

 

TracePoses

Constructors

Name Description

Public function

URigHierarchy()

Destructors

Name Description

Public function Virtual

~URigHierarchy()

Functions

Name Description

Public function

TArray< FRig...

 

begin()

Iterators

Public function

bool

 

CanSwitchToParent

(
    FRigElementKey InChild,
    FRigElementKey InParent,
    const TElementDependencyMap& InDep...,
    FString* OutFailureReason
)

Determines if the element can be switched to a provided parent

Public function Static

void

 

CheckTraceFormatIfRequired()

Updates the format for trace floating point numbers

Public function

void

 

ClearListeningHierarchy()

Protected function Const

FTransform

 

ComputeLocalControlValue

(
    FRigControlElement* ControlEle...,
    const FTransform& InGlobalTransfor...,
    ERigTransformType::Type InTransform...
)

Protected function Static

void

 

ComputeParentConstraintIndices

(
    const FRigElementParentConstraintAr...,
    ERigTransformType::Type InTransform...,
    FConstraintIndex& OutFirstConstrai...,
    FConstraintIndex& OutSecondConstra...,
    FConstraintIndex& OutNumConstraint...,
    FRigElementWeight& OutTotalWeight
)

Public function Const

bool

 

Contains

(
    const FRigElementKey& InKey
)

Returns true if the provided element key is valid

Public function Const UFunction BlueprintCallable, Category, Meta

bool

 

Contains_ForBlueprint

(
    FRigElementKey InKey
)

Returns true if the provided element key is valid

Protected function Static

TArray< FStr...

 

ControlSettingsToPythonCommands

(
    const FRigControlSettings& Setting...,
    const FString& NameSettings
)

Public function UFunction BlueprintCallable, Category

void

 

CopyHierarchy

(
    URigHierarchy* InHierarchy
)

Copies the contents of a hierarchy onto this one

Public function UFunction BlueprintCallable, Category

void

 

CopyPose

(
    URigHierarchy* InHierarchy,
    bool bCurrent,
    bool bInitial
)

Copies the contents of a hierarchy onto this one

Public function

void

 

DumpTransformStackToFile

(
    FString* OutFilePath
)

Dumps the content of the transform stack to a string

Public function

TArray< FRig...

 

end()

Public function

void

 

EndInteraction()

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

Public function Const

const T *...

 

Find

(
    const FRigElementKey& InKey
)

Returns an element for a given key or nullptr.

Public function

T *

 

Find

(
    const FRigElementKey& InKey
)

Returns an element for a given key or nullptr.

Public function

FRigBaseElem...

 

Find

(
    const FRigElementKey& InKey
)

Returns an element for a given key or nullptr.

Public function Const

const FRigBa...

 

Find

(
    const FRigElementKey& InKey
)

Returns an element for a given key or nullptr.

Public function

FRigBaseElem...

 

FindChecked

(
    const FRigElementKey& InKey
)

Returns an element for a given key and raises for invalid results.

Public function

T *

 

FindChecked

(
    const FRigElementKey& InKey
)

Returns an element for a given key.

Public function Const

const T *...

 

FindChecked

(
    const FRigElementKey& InKey
)

Returns an element for a given key.

Public function Const

const FRigBa...

 

FindChecked

(
    const FRigElementKey& InKey
)

Returns an element for a given key and raises for invalid results.

Protected function Static

ERigElementT...

 

FlatIndexToRigElementType

(
    int32 InIndex
)

Public function Const

void

 

ForEach

(
    TFunction< bool> PerElemen...
)

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

Public function Const

void

 

ForEach

(
    TFunction< bool...
)

Iterator function to invoke a lambda / TFunction for each element

Public function

T *

 

Get

(
    int32 InIndex
)

Returns an element at a given index or nullptr.

Public function Const

const FRigBa...

 

Get

(
    int32 InIndex
)

Returns an element at a given index or nullptr.

Public function Const

const T *...

 

Get

(
    int32 InIndex
)

Returns an element at a given index or nullptr.

Public function

FRigBaseElem...

 

Get

(
    int32 InIndex
)

Returns an element at a given index or nullptr.

Public function Const

FRigElementK...

 

GetActiveParent

(
    const FRigElementKey& InKey
)

Get the current active for the passed in key.

Public function Const

TArray< FRig...

 

GetAllKeys

(
    bool bTraverse,
    ERigElementType InElementType
)

Returns all element keys of this hierarchy

Public function Const UFunction BlueprintCallable, Category, Meta

TArray< FRig...

 

GetAllKeys_ForBlueprint

(
    bool bTraverse
)

Returns all element keys of this hierarchy

Public function Const UFunction BlueprintCallable, Category, Meta

TArray< FRig...

 

GetBoneKeys

(
    bool bTraverse
)

Returns all Bone elements

Public function Const

TArray< FRig...

 

GetBones

(
    bool bTraverse
)

Returns all Bone elements

Public function Const

const T *...

 

GetChecked

(
    int32 InIndex
)

Returns an element at a given index.

Public function

T *

 

GetChecked

(
    int32 InIndex
)

Returns an element at a given index.

Public function Const

const FRigBa...

 

GetChildren

(
    const FRigBaseElement* InEleme...
)

Returns the child elements of a given element

Public function Const UFunction BlueprintCallable, Category

TArray< FRig...

 

GetChildren

(
    FRigElementKey InKey,
    bool bRecursive
)

Returns the child elements of a given element key

Public function Const

TArray< int3...

 

GetChildren

(
    int32 InIndex,
    bool bRecursive
)

Returns the child elements of a given element index

Public function Const

FRigBaseElem...

 

GetChildren

(
    const FRigBaseElement* InEleme...,
    bool bRecursive
)

Returns the child elements of a given element

Public function Const UFunction BlueprintCallable, Category, Meta

TArray< FRig...

 

GetControlKeys

(
    bool bTraverse
)

Returns all Control elements

Public function UFunction BlueprintCallable, Category

URigHierarch...

 

GetController

(
    bool bCreateIfNeeded
)

Returns a controller for this hierarchy

Public function Const

FTransform

 

GetControlOffsetTransform

(
    FRigControlElement* InControlE...,
    const ERigTransformType::Type InTra...
)

Returns the global offset transform for a given control element.

Public function Const

FString

 

GetControlPinDefaultValue

(
    FRigControlElement* InControlE...,
    bool bForEdGraph,
    ERigControlValueType InValueType
)

Returns the default value to use for a pin for a control

Public function Const

FEdGraphPinT...

 

GetControlPinType

(
    FRigControlElement* InControlE...
)

Returns the pin type to use for a control

Public function Const

TArray< FRig...

 

GetControls

(
    bool bTraverse
)

Returns all Control elements

Public function Const

FTransform

 

GetControlShapeTransform

(
    FRigControlElement* InControlE...,
    const ERigTransformType::Type InTra...
)

Returns the global shape transform for a given control element.

Public function Const

T

 

GetControlValue

(
    int32 InElementIndex,
    ERigControlValueType InValueType
)

Returns a control's current value given its index

Public function Const

T

 

GetControlValue

(
    FRigControlElement* InControlE...,
    ERigControlValueType InValueType
)

Public function Const

FRigControlV...

 

GetControlValue

(
    FRigControlElement* InControlE...,
    ERigControlValueType InValueType
)

Returns a control's current value

Public function Const

FRigControlV...

 

GetControlValue

(
    int32 InElementIndex,
    ERigControlValueType InValueType
)

Returns a control's current value given its index

Public function Const

T

 

GetControlValue

(
    FRigElementKey InKey,
    ERigControlValueType InValueType
)

Returns a control's current value given its key

Public function Const UFunction BlueprintCallable, Category

FRigControlV...

 

GetControlValue

(
    FRigElementKey InKey,
    ERigControlValueType InValueType
)

Returns a control's current value given its key

Public function Const

FVector2D

 

GetControlValue

(
    FRigControlElement* InControlE...,
    ERigControlValueType InValueType
)

Public function Const UFunction BlueprintCallable, Category

FRigControlV...

 

GetControlValueByIndex

(
    int32 InElementIndex,
    ERigControlValueType InValueType
)

Returns a control's current value given its index

Public function Const UFunction BlueprintCallable, Category, Meta

TArray< FRig...

 

GetCurveKeys()

Returns all Curve elements

Public function Const

TArray< FRig...

 

GetCurves()

Returns all Curve elements

Public function Const

float

 

GetCurveValue

(
    FRigCurveElement* InCurveEleme...
)

Returns a curve's value

Public function Const

float

 

GetCurveValue

(
    int32 InElementIndex
)

Public function Const UFunction BlueprintCallable, Category

float

 

GetCurveValue

(
    FRigElementKey InKey
)

Returns a curve's value given its key

Public function Const UFunction BlueprintCallable, Category

float

 

GetCurveValueByIndex

(
    int32 InElementIndex
)

Returns a curve's value given its index

Public function Static

FRigElementK...

 

GetDefaultParentKey()

Public function

TElementDepe...

 

GetDependenciesForVM

(
    URigVM* InVM,
    FName InEventName
)

Public function Const

TArray< T &#...

 

GetElementsOfType

(
    bool bTraverse
)

Filtered accessor to retrieve all elements of a given type

Public function Static UFunction BlueprintCallable, Category

FEulerTransf...

 

GetEulerTransformFromControlValue

(
    FRigControlValue InValue
)

Returns the contained FEulerTransform value from a a Rig Control Value

Public function Const

TArray< T &#...

 

GetFilteredElements

(
    TFunction< bool> InKeepEle...,
    bool bTraverse
)

Filtered accessor to retrieve all elements of a given type

Public function Const UFunction BlueprintCallable, Category

FRigElementK...

 

GetFirstParent

(
    FRigElementKey InKey
)

Returns the first parent element of a given element key

Public function Const

int32

 

GetFirstParent

(
    int32 InIndex
)

Returns the first parent element of a given element index

Public function Const

FRigBaseElem...

 

GetFirstParent

(
    const FRigBaseElement* InEleme...
)

Returns the first parent element of a given element

Public function Static UFunction BlueprintCallable, Category

float

 

GetFloatFromControlValue

(
    FRigControlValue InValue
)

Returns the contained float value from a a Rig Control Value

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetGlobalControlOffsetTransform

(
    FRigElementKey InKey,
    bool bInitial
)

Returns the global offset transform for a given control element.

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetGlobalControlOffsetTransformByIndex

(
    int32 InElementIndex,
    bool bInitial
)

Returns the global offset transform for a given control element.

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetGlobalControlShapeTransform

(
    FRigElementKey InKey,
    bool bInitial
)

Returns the global shape transform for a given control element.

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetGlobalControlShapeTransformByIndex

(
    int32 InElementIndex,
    bool bInitial
)

Returns the global shape transform for a given control element.

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetGlobalTransform

(
    FRigElementKey InKey,
    bool bInitial
)

Returns the global current or initial value for a given key.

Public function Const

FTransform

 

GetGlobalTransform

(
    int32 InElementIndex
)

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetGlobalTransformByIndex

(
    int32 InElementIndex,
    bool bInitial
)

Returns the global current or initial value for a element index.

Public function Const

int32

 

GetIndex

(
    const FRigElementKey& InKey
)

Returns the index of an element given its key

Public function Const UFunction BlueprintCallable, Category, Meta

int32

 

GetIndex_ForBlueprint

(
    FRigElementKey InKey
)

Returns the index of an element given its key

Public function Const

FRigControlV...

 

GetInitialControlValue

(
    int32 InElementIndex
)

Returns a control's initial value given its index

Public function Const

T

 

GetInitialControlValue

(
    int32 InElementIndex
)

Returns a control's initial value given its index

Public function Const

FTransform

 

GetInitialGlobalTransform

(
    int32 InElementIndex
)

Public function Const

FTransform

 

GetInitialGlobalTransform

(
    const FRigElementKey& InKey
)

Public function Const

FTransform

 

GetInitialLocalTransform

(
    int32 InElementIndex
)

Public function Const

FTransform

 

GetInitialLocalTransform

(
    const FRigElementKey& InKey
)

Public function Static UFunction BlueprintCallable, Category

int32

 

GetIntFromControlValue

(
    FRigControlValue InValue
)

Returns the contained int32 value from a a Rig Control Value

Public function Const UFunction BlueprintCallable, Category

FRigElementK...

 

GetKey

(
    int32 InElementIndex
)

Returns the key of an element given its index

Public function Const

TArray< FRig...

 

GetKeysOfType

(
    bool bTraverse
)

Filtered accessor to retrieve all element keys of a given type

Public function Const

FTransform

 

GetLocalTransform

(
    int32 InElementIndex
)

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetLocalTransform

(
    FRigElementKey InKey,
    bool bInitial
)

Returns the local current or initial value for a given key.

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetLocalTransformByIndex

(
    int32 InElementIndex,
    bool bInitial
)

Returns the local current or initial value for a element index.

Public function Static

int32

 

GetMaxNameLength()

Returns the max allowed length for a name within the hierarchy.

Public function Const UFunction BlueprintCallable, Category, Meta

TArray< FRig...

 

GetNullKeys

(
    bool bTraverse
)

Returns all Null elements

Public function Const

TArray< FRig...

 

GetNulls

(
    bool bTraverse
)

Returns all Null elements

Public function Const UFunction BlueprintCallable, Category

int32

 

GetNumberOfParents

(
    FRigElementKey InKey
)

Returns the number of parents of an element

Public function Const

int32

 

GetNumberOfParents

(
    const FRigBaseElement* InEleme...
)

Returns the number of parents of an element

Public function Const

int32

 

GetNumberOfParents

(
    int32 InIndex
)

Returns the number of parents of an element

Public function

FRigElementK...

 

GetOrAddWorldSpaceReference()

Adds the world space reference or returns it

Public function Const UFunction BlueprintCallable, Category

TArray< FRig...

 

GetParents

(
    FRigElementKey InKey,
    bool bRecursive
)

Returns the parent elements of a given element key

Public function Const

TArray< int3...

 

GetParents

(
    int32 InIndex,
    bool bRecursive
)

Returns the parent elements of a given element index

Public function Const

FRigBaseElem...

 

GetParents

(
    const FRigBaseElement* InEleme...,
    bool bRecursive
)

Returns the parent elements of a given element

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetParentTransform

(
    FRigElementKey InKey,
    bool bInitial
)

Returns the global current or initial value for a given key.

Public function Const

FTransform

 

GetParentTransform

(
    FRigBaseElement* InElement,
    const ERigTransformType::Type InTra...
)

Returns a transform for a given element's parent based on the transform type If the element does not have a parent FTransform::Identity will be returned.

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetParentTransformByIndex

(
    int32 InElementIndex,
    bool bInitial
)

Returns the global current or initial value for a given element index.

Public function Const UFunction BlueprintCallable, Category

FRigElementW...

 

GetParentWeight

(
    FRigElementKey InChild,
    FRigElementKey InParent,
    bool bInitial
)

Returns the weight of a parent below a multi parent element

Public function Const

FRigElementW...

 

GetParentWeight

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

Returns the weight of a parent below a multi parent element

Public function Const

FRigElementW...

 

GetParentWeight

(
    const FRigBaseElement* InChild,
    const FRigBaseElement* InParen...,
    bool bInitial
)

Returns the weight of a parent below a multi parent element

Public function Const

TArray< FRig...

 

GetParentWeightArray

(
    const FRigBaseElement* InChild,
    bool bInitial
)

Returns the weights of all parents below a multi parent element

Public function Const UFunction BlueprintCallable, Category

TArray< FRig...

 

GetParentWeightArray

(
    FRigElementKey InChild,
    bool bInitial
)

Returns the weights of all parents below a multi parent element

Public function Const

FRigPose

 

GetPose

(
    bool bInitial,
    ERigElementType InElementType,
    const TArrayView< const FRigElement...
)

Returns the current / initial pose of the hierarchy

Public function Const UFunction BlueprintCallable, Category

FRigPose

 

GetPose

(
    bool bInitial
)

Returns the current / initial pose of the hierarchy

Public function Const

FRigPose

 

GetPose

(
    bool bInitial,
    ERigElementType InElementType,
    const FRigElementKeyCollection& In...
)

Returns the current / initial pose of the hierarchy

Public function Const UFunction BlueprintCallable, Category

FName

 

GetPreviousName

(
    const FRigElementKey& InKey
)

Returns the previous name of an element prior to a rename operation

Public function Const UFunction BlueprintCallable, Category

FRigElementK...

 

GetPreviousParent

(
    const FRigElementKey& InKey
)

Returns the previous parent of an element prior to a reparent operation

Public function Const UFunction BlueprintCallable, Category, Meta

TArray< FRig...

 

GetReferenceKeys

(
    bool bTraverse
)

Returns all references

Public function Const

TArray< FRig...

 

GetReferences

(
    bool bTraverse
)

Returns all references

Public function Const

TArray< FRig...

 

GetRigidBodies

(
    bool bTraverse
)

Returns all RigidBody elements

Public function Const UFunction BlueprintCallable, Category, Meta

TArray< FRig...

 

GetRigidBodyKeys

(
    bool bTraverse
)

Returns all RigidBody elements

Public function Static UFunction BlueprintCallable, Category

FRotator

 

GetRotatorFromControlValue

(
    FRigControlValue InValue
)

Returns the contained FRotator value from a a Rig Control Value

Public function Const

FName

 

GetSafeNewName

(
    const FString& InPotentialNewName,
    ERigElementType InType
)

Returns a valid new name for a to-be-added element.

Public function Static

FName

 

GetSanitizedName

(
    const FString& InName
)

Sanitizes a name by removing invalid characters.

Public function Const

TArray< FRig...

 

GetSelectedElements

(
    ERigElementType InTypeFilter
)

Returns the selected elements The types to retrieve the selection for

Public function Const UFunction BlueprintCallable, Category

TArray< FRig...

 

GetSelectedKeys

(
    ERigElementType InTypeFilter
)

Returns the keys of selected elements The types to retrieve the selection for

Public function

bool &

 

GetSuspendNotificationsFlag()

Returns a reference to the suspend notifications flag

Public function Const

uint16

 

GetTopologyVersion()

Returns the topology version of this hierarchy

Public function Const

FTransform

 

GetTransform

(
    FRigTransformElement* InTransf...,
    const ERigTransformType::Type InTra...
)

Returns a transform based on a given transform type

Public function Static UFunction BlueprintCallable, Category

FTransform

 

GetTransformFromControlValue

(
    FRigControlValue InValue
)

Returns the contained FTransform value from a a Rig Control Value

Public function Static UFunction BlueprintCallable, Category

FTransformNo...

 

GetTransformNoScaleFromControlValue

(
    FRigControlValue InValue
)

Returns the contained FTransformNoScale value from a a Rig Control Value

Public function Const

int32

 

GetTransformStackIndex()

Returns the transform stack index

Public function Const

TArray< FRig...

 

GetTransientControls()

Returns all transient Control elements

Public function Static UFunction BlueprintCallable, Category

FVector2D

 

GetVector2DFromControlValue

(
    FRigControlValue InValue
)

Returns the contained FVector2D value from a a Rig Control Value

Public function Static UFunction BlueprintCallable, Category

FVector

 

GetVectorFromControlValue

(
    FRigControlValue InValue
)

Returns the contained FVector value from a a Rig Control Value

Protected function Static

float

 

GetWeightForLerp

(
    const float WeightA,
    const float WeightB
)

Public function Static

FRigElementK...

 

GetWorldSpaceReferenceKey()

Protected function

FTransform

 

GetWorldTransformForReference

(
    const FRigUnitContext* InConte...,
    const FRigElementKey& InKey,
    bool bInitial
)

Protected function Static

void

 

IntegrateParentConstraintQuat

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

Protected function Static

void

 

IntegrateParentConstraintVector

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

Protected function Const

FTransform

 

InverseSolveParentConstraints

(
    const FTransform& InGlobalTransfor...,
    const FRigElementParentConstraintAr...,
    const ERigTransformType::Type InTra...,
    const FTransform& InLocalOffsetTra...
)

Public function Const

bool

 

IsDependentOn

(
    FRigBaseElement* InDependent,
    FRigBaseElement* InDependency,
    const TElementDependencyMap& InDep...
)

Returns true if an element is affected to another element

Public function Const

bool

 

IsNameAvailable

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

Returns true if a given name is available.

Public function Const UFunction BlueprintCallable, Category

bool

 

IsParentedTo

(
    FRigElementKey InChild,
    FRigElementKey InParent
)

Returns true if an element is parented to another element

Public function Const

bool

 

IsParentedTo

(
    FRigBaseElement* InChild,
    FRigBaseElement* InParent,
    const TElementDependencyMap& InDep...
)

Returns true if an element is parented to another element

Public function Const

bool

 

IsParentedTo

(
    int32 InChildIndex,
    int32 InParentIndex,
    const TElementDependencyMap& InDep...
)

Returns true if an element is parented to another element

Public function Const UFunction BlueprintCallable, Category

bool

 

IsSelected

(
    FRigElementKey InKey
)

Returns true if a given element is selected

Public function Const

bool

 

IsSelected

(
    int32 InIndex
)

Public function Const UFunction BlueprintCallable, Category

bool

 

IsSelectedByIndex

(
    int32 InIndex
)

Returns true if a given element is selected

Public function Const

bool

 

IsTracingChanges()

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

Public function Const UFunction BlueprintCallable, Category

bool

 

IsValidIndex

(
    int32 InElementIndex
)

Returns true if the provided element index is valid

Protected function Const

FTransform

 

LazilyComputeParentConstraint

(
    const FRigElementParentConstraintAr...,
    int32 InIndex,
    const ERigTransformType::Type InTra...,
    const FTransform& InLocalOffsetTra...,
    bool bApplyLocalOffsetTransform,
    const FTransform& InLocalPoseTrans...,
    bool bApplyLocalPoseTransform
)

Public function

void

 

Load

(
    FArchive& Ar
)

Public function Static UFunction BlueprintCallable, Category

FRigControlV...

 

MakeControlValueFromBool

(
    bool InValue
)

Creates a rig control value from a bool value

Public function Static UFunction BlueprintCallable, Category

FRigControlV...

 

MakeControlValueFromEulerTransform

(
    FEulerTransform InValue
)

Creates a rig control value from a FEulerTransform value

Public function Static UFunction BlueprintCallable, Category

FRigControlV...

 

MakeControlValueFromFloat

(
    float InValue
)

Creates a rig control value from a float value

Public function Static UFunction BlueprintCallable, Category

FRigControlV...

 

MakeControlValueFromInt

(
    int32 InValue
)

Creates a rig control value from a int32 value

Public function Static UFunction BlueprintCallable, Category

FRigControlV...

 

MakeControlValueFromRotator

(
    FRotator InValue
)

Creates a rig control value from a FRotator value

Public function Static UFunction BlueprintCallable, Category

FRigControlV...

 

MakeControlValueFromTransform

(
    FTransform InValue
)

Creates a rig control value from a FTransform value

Public function Static UFunction BlueprintCallable, Category

FRigControlV...

 

MakeControlValueFromTransformNoScale

(
    FTransformNoScale InValue
)

Creates a rig control value from a FTransformNoScale value

Public function Static UFunction BlueprintCallable, Category

FRigControlV...

 

MakeControlValueFromVector

(
    FVector InValue
)

Creates a rig control value from a FVector value

Public function Static UFunction BlueprintCallable, Category

FRigControlV...

 

MakeControlValueFromVector2D

(
    FVector2D InValue
)

Creates a rig control value from a FVector2D value

Public function

void

 

Notify

(
    ERigHierarchyNotification InNotifTy...,
    const FRigBaseElement* InEleme...
)

Public function Const UFunction BlueprintCallable, Category

int32

 

Num()

Returns the number of elements in the Hierarchy.

Public function Const

int32

 

Num

(
    ERigElementType InElementType
)

Returns the number of elements in the Hierarchy.

Public function

FRigEventDel...

 

OnEventReceived()

Returns the delegate to listen to for events coming from this hierarchy

Public function

FRigHierarch...

 

OnModified()

Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy.

Public function

FRigHierarch...

 

OnUndoRedo()

Returns the event fired during undo / redo

Public function

bool

 

Redo()

Performs redo for one transform change

Public function

void

 

RegisterListeningHierarchy

(
    URigHierarchy* InHierarchy
)

Add dependent hierarchies that listens to changes made to this hierarchy

Public function UFunction BlueprintCallable, Category

void

 

Reset()

Clears the whole hierarchy and removes all elements.

Public function UFunction BlueprintCallable, Category

void

 

ResetCurveValues()

Resets all curves to 0.0

Public function

void

 

ResetPoseToInitial()

Resets the current pose of all elements to the initial / ref pose.

Public function UFunction BlueprintCallable, Category

void

 

ResetPoseToInitial

(
    ERigElementType InTypeFilter
)

Resets the current pose of a filtered lost if elements to the initial / ref pose.

Public function

void

 

ResetTransformStack()

Clears the undo / redo stack of this hierarchy

Protected function Static

int32

 

RigElementTypeToFlatIndex

(
    ERigElementType InElementType
)

Public function Static

void

 

SanitizeName

(
    FString& InOutName
)

Sanitizes a name by removing invalid characters.

Public function

void

 

Save

(
    FArchive& Ar
)

Public function UFunction BlueprintCallable, Category

void

 

SendAutoKeyEvent

(
    FRigElementKey InElement,
    float InOffsetInSeconds,
    bool bAsynchronous
)

Sends an autokey event from the hierarchy to the world

Public function

void

 

SendEvent

(
    const FRigEventContext& InEvent,
    bool bAsynchronous
)

Sends an event from the hierarchy to the world

Public function

void

 

SetControlOffsetTransform

(
    FRigControlElement* InControlE...,
    const FTransform& InTransform,
    const ERigTransformType::Type InTra...,
    bool bAffectChildren,
    bool bSetupUndo,
    bool bForce,
    bool bPrintPythonCommands
)

Sets the offset transform for a given control element

Public function UFunction BlueprintCallable, Category

void

 

SetControlOffsetTransform

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

Sets the offset transform for a given control element by key

Public function UFunction BlueprintCallable, Category

void

 

SetControlOffsetTransformByIndex

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

Sets the local offset transform for a given control element by index

Public function UFunction BlueprintCallable, Category

void

 

SetControlSettings

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

Sets the control settings for a given control element by key

Public function

void

 

SetControlSettings

(
    FRigControlElement* InControlE...,
    FRigControlSettings InSettings,
    bool bSetupUndo,
    bool bForce,
    bool bPrintPythonCommands
)

Sets the control settings for a given control element

Public function UFunction BlueprintCallable, Category

void

 

SetControlSettingsByIndex

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

Sets the control settings for a given control element by index

Public function

void

 

SetControlShapeTransform

(
    FRigControlElement* InControlE...,
    const FTransform& InTransform,
    const ERigTransformType::Type InTra...,
    bool bSetupUndo,
    bool bForce,
    bool bPrintPythonCommands
)

Sets the shape transform for a given control element

Public function UFunction BlueprintCallable, Category

void

 

SetControlShapeTransform

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

Sets the shape transform for a given control element by key

Public function UFunction BlueprintCallable, Category

void

 

SetControlShapeTransformByIndex

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

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

Public function Const

void

 

SetControlValue

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

Public function

void

 

SetControlValue

(
    FRigControlElement* InControlE...,
    const FRigControlValue& InValue,
    ERigControlValueType InValueType,
    bool bSetupUndo,
    bool bForce,
    bool bPrintPythonCommands
)

Sets a control's current value

Public function Const

void

 

SetControlValue

(
    FRigControlElement* InControlE...,
    const T& InValue,
    ERigControlValueType InValueType,
    bool bSetupUndo,
    bool bForce
)

Public function

void

 

SetControlValue

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

Sets a control's current value given its index

Public function Const

void

 

SetControlValue

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

Sets a control's current value given its key

Public function UFunction BlueprintCallable, Category

void

 

SetControlValue

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

Sets a control's current value given its key

Public function Const

void

 

SetControlValue

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

Sets a control's current value given its index

Public function UFunction BlueprintCallable, Category

void

 

SetControlValueByIndex

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

Sets a control's current value given its index

Public function

void

 

SetControlVisibility

(
    FRigControlElement* InControlE...,
    bool bVisibility
)

Sets a control's current visibility

Public function UFunction BlueprintCallable, Category

void

 

SetControlVisibility

(
    FRigElementKey InKey,
    bool bVisibility
)

Sets a control's current visibility based on a key

Public function

void

 

SetControlVisibility

(
    int32 InElementIndex,
    bool bVisibility
)

Public function UFunction BlueprintCallable, Category

void

 

SetControlVisibilityByIndex

(
    int32 InElementIndex,
    bool bVisibility
)

Sets a control's current visibility based on a key

Public function

void

 

SetCurveValue

(
    int32 InElementIndex,
    float InValue,
    bool bSetupUndo
)

Public function UFunction BlueprintCallable, Category

void

 

SetCurveValue

(
    FRigElementKey InKey,
    float InValue,
    bool bSetupUndo
)

Sets a curve's value given its key

Public function

void

 

SetCurveValue

(
    FRigCurveElement* InCurveEleme...,
    float InValue,
    bool bSetupUndo,
    bool bForce
)

Sets a curve's value

Public function UFunction BlueprintCallable, Category

void

 

SetCurveValueByIndex

(
    int32 InElementIndex,
    float InValue,
    bool bSetupUndo
)

Sets a curve's value given its index

Public function

void

 

SetGlobalTransform

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

Public function UFunction BlueprintCallable, Category

void

 

SetGlobalTransform

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

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

Public function UFunction BlueprintCallable, Category

void

 

SetGlobalTransformByIndex

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

Sets the global current or initial transform for a given element index.

Public function

void

 

SetInitialControlValue

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

Sets a control's initial value given its index

Public function Const

void

 

SetInitialControlValue

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

Sets a control's initial value given its index

Public function

void

 

SetInitialGlobalTransform

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

Public function

void

 

SetInitialGlobalTransform

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

Public function

void

 

SetInitialLocalTransform

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

Public function

void

 

SetInitialLocalTransform

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

Public function UFunction BlueprintCallable, Category

void

 

SetLocalTransform

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

Sets the local current or initial transform for a given key.

Public function

void

 

SetLocalTransform

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

Public function UFunction BlueprintCallable, Category

void

 

SetLocalTransformByIndex

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

Sets the local current or initial transform for a given element index.

Public function

bool

 

SetParentWeight

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

Sets the weight of a parent below a multi parent element

Public function UFunction BlueprintCallable, Category

bool

 

SetParentWeight

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

Sets the weight of a parent below a multi parent element

Public function

bool

 

SetParentWeight

(
    FRigBaseElement* InChild,
    const FRigBaseElement* InParen...,
    FRigElementWeight InWeight,
    bool bInitial,
    bool bAffectChildren
)

Sets the weight of a parent below a multi parent element

Public function

bool

 

SetParentWeightArray

(
    FRigBaseElement* InChild,
    const TArrayView< const FRigElement...,
    bool bInitial,
    bool bAffectChildren
)

Sets the all of the weights of the parents of a multi parent element

Public function

bool

 

SetParentWeightArray

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

Sets the all of the weights of the parents of a multi parent element

Public function UFunction BlueprintCallable, Category

bool

 

SetParentWeightArray

(
    FRigElementKey InChild,
    TArray< FRigElementWeight > InWeigh...,
    bool bInitial,
    bool bAffectChildren
)

Sets the all of the weights of the parents of a multi parent element

Public function

void

 

SetPose

(
    const FRigPose& InPose,
    ERigTransformType::Type InTransform...,
    ERigElementType InElementType,
    const TArrayView< const FRigElement...,
    float InWeight
)

Sets the current / initial pose of the hierarchy

Public function

void

 

SetPose

(
    const FRigPose& InPose,
    ERigTransformType::Type InTransform...,
    ERigElementType InElementType,
    const FRigElementKeyCollection& In...,
    float InWeight
)

Sets the current / initial pose of the hierarchy

Public function

void

 

SetPose

(
    const FRigPose& InPose,
    ERigTransformType::Type InTransform...
)

Sets the current / initial pose of the hierarchy

Public function UFunction BlueprintCallable, Category, Meta

void

 

SetPose_ForBlueprint

(
    FRigPose InPose
)

Sets the current / initial pose of the hierarchy

Public function

void

 

SetTransform

(
    FRigTransformElement* InTransf...,
    const FTransform& InTransform,
    const ERigTransformType::Type InTra...,
    bool bAffectChildren,
    bool bSetupUndo,
    bool bForce,
    bool bPrintPythonCommands
)

Sets a transform for a given element based on the transform type

Protected function Const

FTransform

 

SolveParentConstraints

(
    const FRigElementParentConstraintAr...,
    const ERigTransformType::Type InTra...,
    const FTransform& InLocalOffsetTra...,
    bool bApplyLocalOffsetTransform,
    const FTransform& InLocalPoseTrans...,
    bool bApplyLocalPoseTransform
)

Public function Const UFunction BlueprintCallable, Category

TArray< FRig...

 

SortKeys

(
    const TArray< FRigElementKey >& In...
)

Sorts the input key list by traversing the hierarchy

Public function

void

 

StartInteraction()

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

Public function

void

 

StorePoseForTrace

(
    const FString& InPrefix
)

Stores the current pose for tracing

Public function UFunction BlueprintCallable, Category

bool

 

SwitchToDefaultParent

(
    FRigElementKey InChild,
    bool bInitial,
    bool bAffectChildren
)

Switches a multi parent element to its first parent

Public function

bool

 

SwitchToDefaultParent

(
    FRigBaseElement* InChild,
    bool bInitial,
    bool bAffectChildren
)

Switches a multi parent element to its first parent This sets the new parent's weight to 1.0 and disables weights for all other potential parents.

Public function

bool

 

SwitchToParent

(
    FRigBaseElement* InChild,
    FRigBaseElement* InParent,
    bool bInitial,
    bool bAffectChildren,
    const TElementDependencyMap& InDep...,
    FString* OutFailureReason
)

Switches a multi parent element to a single parent.

Public function

bool

 

SwitchToParent

(
    FRigElementKey InChild,
    FRigElementKey InParent,
    bool bInitial,
    bool bAffectChildren,
    const TElementDependencyMap& InDep...,
    FString* OutFailureReason
)

Public function UFunction BlueprintCallable, Category

bool

 

SwitchToParent

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

Switches a multi parent element to a single parent.

Public function

bool

 

SwitchToParent

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

Switches a multi parent element to a single parent.

Public function

bool

 

SwitchToWorldSpace

(
    FRigBaseElement* InChild,
    bool bInitial,
    bool bAffectChildren
)

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

Public function UFunction BlueprintCallable, Category

bool

 

SwitchToWorldSpace

(
    FRigElementKey InChild,
    bool bInitial,
    bool bAffectChildren
)

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

Public function

void

 

TraceFrames

(
    int32 InNumFramesToTrace
)

Tells this hierarchy to trace a series of frames

Public function Const

void

 

Traverse

(
    FRigBaseElement* InElement,
    bool bTowardsChildren,
    TFunction< void...
)

Helper function to traverse the hierarchy

Public function Const

void

 

Traverse

(
    TFunction< void...,
    bool bTowardsChildren
)

Helper function to traverse the hierarchy from the root

Public function

bool

 

Undo()

Performs undo for one transform change

Public function

void

 

UnregisterListeningHierarchy

(
    URigHierarchy* InHierarchy
)

Remove dependent hierarchies that listens to changes made to this hierarchy

Public function

void

 

UpdateReferences

(
    const FRigUnitContext* InConte...
)

Update all elements that depend on external references

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PostTransacted

(
    const FTransactionObjectEvent& Tra...
)

Called after the object has been transacted in some way.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Classes

Name

Description

Protected struct

FConstraintIndex

Typedefs

Constants

Name

Description

EmptyElementArray

Static empty element array used for ref returns.