FRigControlHierarchy

Windows
MacOS
Linux

References

Module

ControlRig

Header

/Engine/Plugins/Experimental/ControlRig/Source/ControlRig/Public/Rigs/RigControlHierarchy.h

Include

#include "Rigs/RigControlHierarchy.h"

Syntax

[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType))
struct FRigControlHierarchy

Variables

Constructors

Name Description

Public function

FRigControlHierarchy()

Functions

Name Description

Public function

FRigControl ...

 

Add

(
    const FName& InNewName,
    ERigControlType InControlType,
    const FName& InParentName,
    const FName& InSpaceName,
    const FTransform& InOffsetTransfor...,
    const FRigControlValue& InValue,
    const FName& InGizmoName,
    const FTransform& InGizmoTransform,
    const FLinearColor& InGizmoColor
)

Public function Const

TArray< FRig...

 

begin()

Public function

TArray< FRig...

 

begin()

Public function

bool

 

ClearSelection()

Public function

void

 

CopyOffsetTransforms

(
    const FRigControlHierarchy& InOthe...
)

Copies all offset transforms from another hierarchy

Public function Const

TArray< FNam...

 

CurrentSelection()

Public function

TArray< FRig...

 

end()

Public function Const

TArray< FRig...

 

end()

Public function Const

int32

 

GetChildren

(
    const FName& InName,
    TArray< int32 >& OutChildren,
    bool bRecursively
)

List of names of children - this is not cheap, and is supposed to be used only for one time set up

Public function Const

int32

 

GetChildren

(
    const int32 InIndex,
    TArray< int32 >& OutChildren,
    bool bRecursively
)

Public function Const

const TArray...

 

GetControls()

Public function Const

FTransform

 

GetGlobalTransform

(
    int32 InIndex
)

Public function Const

FTransform

 

GetGlobalTransform

(
    const FName& InName
)

Public function Const

int32

 

GetIndex

(
    const FName& InName
)

Public function Const

FTransform

 

GetInitialGlobalTransform

(
    const FName& InName
)

Public function Const

FTransform

 

GetInitialGlobalTransform

(
    int32 InIndex
)

Public function Const

FRigControlV...

 

GetInitialValue

(
    const FName& InName
)

Public function Const

FRigControlV...

 

GetInitialValue

(
    int32 InIndex
)

Public function Const

T

 

GetInitialValue

(
    int32 InIndex
)

Public function Const

T

 

GetInitialValue

(
    const FName& InName
)

Public function Const

FTransform

 

GetLocalTransform

(
    int32 InIndex,
    ERigControlValueType InValueType
)

Public function Const

FTransform

 

GetLocalTransform

(
    const FName& InName,
    ERigControlValueType InValueType
)

Public function Const

T

 

GetMaximumValue

(
    int32 InIndex
)

Public function Const

T

 

GetMaximumValue

(
    const FName& InName
)

Public function Const

FRigControlV...

 

GetMaximumValue

(
    int32 InIndex
)

Public function Const

FRigControlV...

 

GetMaximumValue

(
    const FName& InName
)

Public function Const

T

 

GetMinimumValue

(
    const FName& InName
)

Public function Const

FRigControlV...

 

GetMinimumValue

(
    int32 InIndex
)

Public function Const

FRigControlV...

 

GetMinimumValue

(
    const FName& InName
)

Public function Const

T

 

GetMinimumValue

(
    int32 InIndex
)

Public function Const

FName

 

GetName

(
    int32 InIndex
)

Public function Const

FTransform

 

GetParentInitialTransform

(
    int32 InIndex,
    bool bIncludeOffsetTransform
)

Public function Const

FTransform

 

GetParentTransform

(
    int32 InIndex,
    bool bIncludeOffsetTransform
)

Public function Const

FRigPose

 

GetPose()

Returns the current pose

Public function Const

FName

 

GetSafeNewName

(
    const FName& InPotentialNewName
)

Public function Const

FRigControlV...

 

GetValue

(
    const FName& InName,
    ERigControlValueType InValueType
)

Public function Const

T

 

GetValue

(
    int32 InIndex,
    ERigControlValueType InValueType
)

Public function Const

T

 

GetValue

(
    const FName& InName,
    ERigControlValueType InValueType
)

Public function Const

FRigControlV...

 

GetValue

(
    int32 InIndex,
    ERigControlValueType InValueType
)

Public function

void

 

HandleOnElementRemoved

(
    FRigHierarchyContainer* InCont...,
    const FRigElementKey& InKey
)

Public function

void

 

HandleOnElementRenamed

(
    FRigHierarchyContainer* InCont...,
    ERigElementType InElementType,
    const FName& InOldName,
    const FName& InNewName
)

Public function

void

 

Initialize

(
    bool bResetTransforms
)

Updates all of the internal caches

Public function Const

bool

 

IsNameAvailable

(
    const FName& InPotentialNewName
)

Public function Const

bool

 

IsSelected

(
    const FName& InName
)

Public function Const

int32

 

Num()

Public function

FRigControl

 

Remove

(
    const FName& InNameToRemove
)

Public function

FName

 

Rename

(
    const FName& InOldName,
    const FName& InNewName
)

Public function

bool

 

Reparent

(
    const FName& InName,
    const FName& InNewParentName
)

Public function

void

 

Reset()

Clears the hierarchy and removes all content

Public function

void

 

ResetValues()

Resets all of the values back to the initial values

Public function Const

ERigElementT...

 

RigElementType()

Public function

bool

 

Select

(
    const FName& InName,
    bool bSelect
)

Public function

void

 

SetControlOffset

(
    int32 InIndex,
    const FTransform& InOffsetTransfor...
)

Public function

void

 

SetGlobalTransform

(
    const FName& InName,
    const FTransform& InTransform
)

Public function

void

 

SetGlobalTransform

(
    int32 InIndex,
    const FTransform& InTransform
)

Public function

void

 

SetInitialGlobalTransform

(
    const FName& InName,
    const FTransform& GlobalTransform
)

This is only valid if you have transform as type setting initial transform from global transform (control transform is based on parent)

Public function

void

 

SetInitialGlobalTransform

(
    int32 InIndex,
    const FTransform& GlobalTransform
)

Public function

void

 

SetInitialValue

(
    int32 InIndex,
    T InValue
)

Public function

void

 

SetInitialValue

(
    const FName& InName,
    T InValue
)

Public function

void

 

SetInitialValue

(
    int32 InIndex,
    const FRigControlValue& InValue
)

Public function

void

 

SetInitialValue

(
    const FName& InName,
    const FRigControlValue& InValue
)

Public function

void

 

SetLocalTransform

(
    const FName& InName,
    const FTransform& InTransform,
    ERigControlValueType InValueType
)

Public function

void

 

SetLocalTransform

(
    int32 InIndex,
    const FTransform& InTransform,
    ERigControlValueType InValueType
)

Public function

void

 

SetMaximumValue

(
    const FName& InName,
    const FRigControlValue& InValue
)

Public function

void

 

SetMaximumValue

(
    int32 InIndex,
    const FRigControlValue& InValue
)

Public function

void

 

SetMaximumValue

(
    const FName& InName,
    T InValue
)

Public function

void

 

SetMaximumValue

(
    int32 InIndex,
    T InValue
)

Public function

void

 

SetMinimumValue

(
    int32 InIndex,
    const FRigControlValue& InValue
)

Public function

void

 

SetMinimumValue

(
    int32 InIndex,
    T InValue
)

Public function

void

 

SetMinimumValue

(
    const FName& InName,
    const FRigControlValue& InValue
)

Public function

void

 

SetMinimumValue

(
    const FName& InName,
    T InValue
)

Public function

void

 

SetPose

(
    FRigPose& InPose
)

Sets the current transforms from the given pose

Public function

void

 

SetSpace

(
    const FName& InName,
    const FName& InNewSpaceName
)

Public function

void

 

SetValue

(
    const FName& InName,
    const FRigControlValue& InValue,
    ERigControlValueType InValueType
)

Public function

void

 

SetValue

(
    int32 InIndex,
    const FRigControlValue& InValue,
    ERigControlValueType InValueType
)

Public function

void

 

SetValue

(
    const FName& InName,
    T InValue,
    ERigControlValueType InValueType
)

Public function

void

 

SetValue

(
    int32 InIndex,
    T InValue,
    ERigControlValueType InValueType
)

Operators

Name Description

Public function Const

const FRigCo...

 

operator[]

(
    int32 InIndex
)

Public function

FRigControl ...

 

operator[]

(
    int32 InIndex
)

Public function Const

const FRigCo...

 

operator[]

(
    const FName& InName
)

Public function

FRigControl ...

 

operator[]

(
    const FName& InName
)

Public function

FRigControlH...

 

operator=

(
    const FRigControlHierarchy& InOthe...
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss