UIKRigDefinition | Unreal Engine 5.7 Documentation


Name	UIKRigDefinition
Type	class
Header File	/Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/IKRigDefinition.h
Include Path	#include "Rig/IKRigDefinition.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UIKRigDefinition :  
    public UObject ,  
    public IInterface_PreviewMeshProvider

Name	Type	Remarks	Include Path	Unreal Specifiers
BoneSize	float	The size of the Bones in the editor viewport.	Rig/IKRigDefinition.h
Controller	TObjectPtr< UObject >	The controller responsible for managing this asset's data (all editor mutation goes through this)	Rig/IKRigDefinition.h	Transient DuplicateTransient NonTransactional
DrawGoals	bool	Draw bones in the viewport.	Rig/IKRigDefinition.h	EditAnywhere Category="Viewport Goal Settings"
GoalSize	float	The size of the Goals in the editor viewport.	Rig/IKRigDefinition.h	EditAnywhere Category="Viewport Goal Settings" Meta=(ClampMin="0.01", UIMin="0.1", UIMax="100.0")
GoalThickness	float	The thickness of the Goals in the editor viewport.	Rig/IKRigDefinition.h	EditAnywhere Category="Viewport Goal Settings" Meta=(ClampMin="0.01", UIMin="0.0", UIMax="10.0")
PreviewSkeletalMesh	TSoftObjectPtr< USkeletalMesh >	The skeletal mesh to run the IK solve on (loaded into viewport).	Rig/IKRigDefinition.h	AssetRegistrySearchable EditAnywhere Category=PreviewMesh

Name	Type	Remarks	Include Path	Unreal Specifiers
Goals	TArray< TObjectPtr< UIKRigEffectorGoal > >	Goals, used as effectors by solvers that support them	Rig/IKRigDefinition.h
RetargetDefinition	FRetargetDefinition	Bone chains for IK Retargeter	Rig/IKRigDefinition.h
Skeleton	FIKRigSkeleton	Hierarchy and bone-pose transforms	Rig/IKRigDefinition.h
SolverStack	TArray< FInstancedStruct >	Polymorphic stack of solvers, executed in serial fashion where output of prior solve is input to the next	Rig/IKRigDefinition.h	Meta=(ExcludeBaseStruct, BaseStruct="/Script/IKRig.IKRigSolverBase")

Name	Remarks	Include Path
const TArray< UIKRigEffectorGoal * > & GetGoalArray()	Runtime, read-only access to array of Goals, all modifications must go through UIKRigController	Rig/IKRigDefinition.h
const FName & GetPelvis()	Runtime, read-only access to Pelvis, all modifications must go through UIKRigController	Rig/IKRigDefinition.h
const FBoneChain * GetRetargetChainByName ( FName ChainName ) const	Runtime, read-only access to read a bone chain, all modifications must go through UIKRigController	Rig/IKRigDefinition.h
TArray< FName > GetRetargetChainNames()	Get a list of the retarget chains contained in this IK Rig	Rig/IKRigDefinition.h
const TArray< FBoneChain > & GetRetargetChains()	Runtime, read-only access to Retarget Definition, all modifications must go through UIKRigController	Rig/IKRigDefinition.h
const FIKRigSkeleton & GetSkeleton()	Runtime, read-only access to skeleton data	Rig/IKRigDefinition.h
const TArray< FInstancedStruct > & GetSolverStructs()	Runtime, read-only access to array of Solvers structs, all modifications must go through UIKRigController	Rig/IKRigDefinition.h

Name	Remarks	Include Path
virtual void PostDuplicate ( bool bDuplicateForPIE )	UObject	Rig/IKRigDefinition.h
virtual void PostLoad()		Rig/IKRigDefinition.h
virtual void Serialize ( FArchive& Ar )		Rig/IKRigDefinition.h

Name	Remarks	Include Path	Unreal Specifiers
virtual USkeletalMesh * GetPreviewMesh()		Rig/IKRigDefinition.h
virtual void SetPreviewMesh ( USkeletalMesh* PreviewMesh, bool bMarkAsDirty )	END UObject IInterface_PreviewMeshProvider interface	Rig/IKRigDefinition.h

Name	Remarks	Include Path	Unreal Specifiers
static const FName GetPreviewMeshPropertyName()	END IInterface_PreviewMeshProvider interface Get name of Preview Mesh property	Rig/IKRigDefinition.h