UIKRigDefinition

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

IKRig

Header

/Engine/Plugins/Animation/IKRig/Source/IKRig/Public/IKRigDefinition.h

Include

#include "IKRigDefinition.h"

Syntax

UCLASS(Blueprintable)
class UIKRigDefinition :
    public UObject,
    public IInterface_PreviewMeshProvider

Variables

Name Description

Public variable UProperty Category, EditAnywhere, Meta

float

 

BoneSize

The size of the Bones in the editor viewport.

Public variable UProperty Transient

TObjectPtr< UOb...

 

Controller

The controller responsible for managing this asset's data (all editor mutation goes through this)

Public variable UProperty Category, EditAnywhere

bool

 

DrawBones

Draw bones in the viewport.

Public variable UProperty Category, EditAnywhere

bool

 

DrawGoals

Draw bones in the viewport.

Public variable UProperty Category, EditAnywhere, Meta

float

 

GoalSize

The size of the Goals in the editor viewport.

Public variable UProperty Category, EditAnywhere, Meta

float

 

GoalThickness

The thickness of the Goals in the editor viewport.

Public variable UProperty Category assetregistrysearchable, visibleanywhere

TObjectPtr< cla...

 

PreviewSkeletalMesh

The skeletal mesh that was used as the source of the skeleton data.

Public variable UProperty

FIKRigSkeleton

 

Skeleton

Hierarchy and bone-pose transforms

Functions

Name Description

Public function Const

const TArray...

 

GetGoalArray()

Read-only access to array of Goals, all modifications must go through UIKRigController

Public function Const

const FBoneC...

 

GetRetargetChainByName

(
    FName ChainName
)

Runtime, read-only access to a FBoneChain by name.

Public function Const

const TArray...

 

GetRetargetChains()

Runtime, read-only access to Retarget Definition, all modifications must go through UIKRigController

Public function Const

const FName ...

 

GetRetargetRoot()

Runtime, read-only access to Retarget Root

Public function Const

const TArray...

 

GetSolverArray()

Read-only access to array of Solvers, all modifications must go through UIKRigController

Overridden from UObject

Name Description

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_PreviewMeshProvider

Name Description

Public function Virtual Const

USkeletalMes...

 

GetPreviewMesh()

Get the preview mesh for this asset

Public function Virtual

void

 

SetPreviewMesh

(
    USkeletalMesh* PreviewMesh,
    bool bMarkAsDirty
)

IInterface_PreviewMeshProvider interface