Navigation
API > API/Plugins > API/Plugins/IKRig > API/Plugins/IKRig/Rig
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UIKRigDefinition
References
| Module | IKRig |
| Header | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/IKRigDefinition.h |
| Include | #include "Rig/IKRigDefinition.h" |
Syntax
UCLASS&40;Blueprintable&41;
class UIKRigDefinition :
public UObject,
public IInterface_PreviewMeshProvider
Variables
| Type | Name | Description | |
|---|---|---|---|
  |
float | BoneSize | The size of the Bones in the editor viewport. |
    |
TObjectPtr< UObject > | Controller | The controller responsible for managing this asset's data (all editor mutation goes through this) |
   |
bool | DrawGoals | Draw bones in the viewport. |
   |
float | GoalSize | The size of the Goals in the editor viewport. |
   |
float | GoalThickness | The thickness of the Goals in the editor viewport. |
    |
TSoftObjectPtr< USkeletalMesh > | PreviewSkeletalMesh | The skeletal mesh to run the IK solve on (loaded into viewport). |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
const TArray< UIKRigEffectorGoal * > & | GetGoalArray () |
Runtime, read-only access to array of Goals, all modifications must go through UIKRigController |
  |
const FName | END IInterface_PreviewMeshProvider interface Get name of Preview Mesh property | |
  |
const FBoneChain * | GetRetargetChainByName
(
FName ChainName |
Runtime, read-only access to read a bone chain, all modifications must go through UIKRigController |
  |
const TArray< FBoneChain > & | Runtime, read-only access to Retarget Definition, all modifications must go through UIKRigController | |
  |
const FName & | Runtime, read-only access to Retarget Root, all modifications must go through UIKRigController | |
  |
const FIKRigSkeleton & | GetSkeleton () |
Runtime, read-only access to skeleton data |
  |
const TArray< UIKRigSolver * > & | Runtime, read-only access to array of Solvers, all modifications must go through UIKRigController |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostDuplicate
(
bool bDuplicateForPIE |
UObject |
  |
void | Handles reading, writing, and reference collecting using FArchive. |
Overridden from IInterface_PreviewMeshProvider
| Type | Name | Description | |
|---|---|---|---|
   |
USkeletalMesh * | Get the preview mesh for this asset | |
  |
void | SetPreviewMesh
(
USkeletalMesh* PreviewMesh, |
END UObjectIInterface_PreviewMeshProvider interface |