FRigBoneHierarchy

Windows
MacOS
Linux

References

Module

ControlRig

Header

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

Include

#include "Rigs/RigBoneHierarchy.h"

Syntax

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

Variables

Constructors

Name Description

Public function

FRigBoneHierarchy()

Functions

Name Description

Public function

FRigBone &

 

Add

(
    const FName& InNewName,
    const FName& InParentName,
    ERigBoneType InType,
    const FTransform& InInitTransform,
    const FTransform& InLocalTransform,
    const FTransform& InGlobalTransfor...
)

Public function

FRigBone &

 

Add

(
    const FName& InNewName,
    const FName& InParentName,
    ERigBoneType InType,
    const FTransform& InInitTransform
)

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

int32

 

GetChildren

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

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

FTransform

 

GetGlobalTransform

(
    int32 InIndex
)

Public function Const

FTransform

 

GetGlobalTransform

(
    const FName& InName
)

Public function Const

int32

 

GetIndex

(
    const FName& InName
)

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

TArray< FRig...

 

ImportSkeleton

(
    const FReferenceSkeleton& InSkelet...,
    const FName& InNameSpace,
    bool bReplaceExistingBones,
    bool bRemoveObsoleteBones,
    bool bSelectBones,
    bool bNotify
)

Import skeleton

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

void

 

RecomputeGlobalTransforms()

Recomputes all of the global transforms from local

Public function

FRigBone

 

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

 

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,
    bool bPropagateTransform
)

Public function

void

 

SetGlobalTransform

(
    int32 InIndex,
    const FTransform& InTransform,
    bool bPropagateTransform
)

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,
    bool bPropagateTransform
)

Public function

void

 

SetLocalTransform

(
    int32 InIndex,
    const FTransform& InTransform,
    bool bPropagateTransform
)

Operators

Name Description

Public function

FRigBone &

 

operator[]

(
    const FName& InName
)

Public function Const

const FRigBo...

 

operator[]

(
    int32 InIndex
)

Public function

FRigBone &

 

operator[]

(
    int32 InIndex
)

Public function Const

const FRigBo...

 

operator[]

(
    const FName& InName
)

Public function

FRigBoneHier...

 

operator=

(
    const FRigBoneHierarchy& 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