FRigSpaceHierarchy

Windows
MacOS
Linux

References

Module

ControlRig

Header

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

Include

#include "Rigs/RigSpaceHierarchy.h"

Syntax

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

Variables

Constructors

Name Description

Public function

FRigSpaceHierarchy()

Functions

Name Description

Public function

FRigSpace &

 

Add

(
    const FName& InNewName,
    ERigSpaceType InSpaceType,
    const FName& InParentName,
    const FTransform& InTransform
)

Public function

TArray< FRig...

 

begin()

Public function Const

TArray< FRig...

 

begin()

Public function

bool

 

ClearSelection()

Public function Const

TArray< FNam...

 

CurrentSelection()

Public function Const

TArray< FRig...

 

end()

Public function

TArray< FRig...

 

end()

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

FTransform

 

GetInitialTransform

(
    int32 InIndex
)

Public function Const

FTransform

 

GetInitialTransform

(
    const FName& InName
)

Public function Const

FTransform

 

GetLocalTransform

(
    int32 InIndex
)

Public function Const

FTransform

 

GetLocalTransform

(
    const FName& InName
)

Public function Const

FName

 

GetName

(
    int32 InIndex
)

Public function Const

FName

 

GetSafeNewName

(
    const FName& InPotentialNewName
)

Public function Const

const TArray...

 

GetSpaces()

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

FRigSpace

 

Remove

(
    const FName& InNameToRemove
)

Public function

FName

 

Rename

(
    const FName& InOldName,
    const FName& InNewName
)

Public function

bool

 

Reparent

(
    const FName& InName,
    ERigSpaceType InSpaceType,
    const FName& InNewParentName
)

Public function

void

 

Reset()

Clears the hierarchy and removes all content

Public function

void

 

ResetTransforms()

Resets all of the transforms back to the initial transform

Public function Const

ERigElementT...

 

RigElementType()

Public function

bool

 

Select

(
    const FName& InName,
    bool bSelect
)

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
)

Public function

void

 

SetInitialGlobalTransform

(
    int32 InIndex,
    const FTransform& GlobalTransform
)

Public function

void

 

SetInitialTransform

(
    const FName& InName,
    const FTransform& InTransform
)

Public function

void

 

SetInitialTransform

(
    int32 InIndex,
    const FTransform& InTransform
)

Public function

void

 

SetLocalTransform

(
    const FName& InName,
    const FTransform& InTransform
)

Public function

void

 

SetLocalTransform

(
    int32 InIndex,
    const FTransform& InTransform
)

Operators

Name Description

Public function

FRigSpace &

 

operator[]

(
    int32 InIndex
)

Public function Const

const FRigSp...

 

operator[]

(
    int32 InIndex
)

Public function

FRigSpace &

 

operator[]

(
    const FName& InName
)

Public function Const

const FRigSp...

 

operator[]

(
    const FName& InName
)

Public function

FRigSpaceHie...

 

operator=

(
    const FRigSpaceHierarchy& InOther
)

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