1. Epic GamesDeveloper
  3. UIKRigProcessor

UIKRigProcessor

API > API/Plugins > API/Plugins/IKRig > API/Plugins/IKRig/Rig

Inheritance Hierarchy

References

   
Module IKRig
Header /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/IKRigProcessor.h
Include #include "Rig/IKRigProcessor.h"

Syntax

UCLASS&40;&41;  
class UIKRigProcessor : public UObject

Variables

  Type Name Description
Public variable FIKRigLogger Log Logging system

Constructors

  Type Name Description
Public function   The runtime for an IKRig to convert an input pose into a solved output pose given a set of IK Rig Goals:

Functions

  Type Name Description
Public function void Used to propagate setting values from the source asset at runtime (settings that do not require re-initialization)
Public function Const void

CopyOutputGlobalPoseToArray ( TArray< FTransform >& OutputPoseGlobal
)

 Get the results after calling Solve()
Public function Const const FGoalBone *

GetGoalBone ( const FName& GoalName
)

 Get the bone associated with a goal
Public function Const const FIKRigGoalContainer & END UPDATE SEQUENCE FUNCTIONSGet access to the internal goal data (read only)
Public function Const const FIKRigSkeleton & Get read-only access to the internal skeleton data
Public function FIKRigSkeleton & Get read/write access to the internal skeleton data
Public function void

Initialize ( const UIKRigDefinition* InRigAsset,
const USkeletalMesh* SkeletalMesh,
const TArray< FName >& ExcludedGoals
)

 Setup a new processor to run the given IKRig asset NOTE!! this function creates new UObjects and consequently MUST be called from the main thread!!
Public function Static bool

IsIKRigCompatibleWithSkeleton ( const UIKRigDefinition* InRigAsset,
const FIKRigInputSkeleton& InputSkeleton,
const FIKRigLogger* Log
)

 Used to determine if the IK Rig asset is compatible with a given skeleton.
Public function Const bool  
Public function void

Reset ()

 Reset all internal data structures. Will require re-initialization before solving again.
Public function void

SetIKGoal ( const FIKRigGoal& Goal
)

 Set a named IK goal to go to a specific location, rotation and space, blended by separate position/rotation alpha (0-1)
Public function void

SetIKGoal ( const UIKRigEffectorGoal* Goal
)

 Set a named IK goal to go to a specific location, rotation and space, blended by separate position/rotation alpha (0-1)
Public function void

SetInputPoseGlobal ( const TArray< FTransform >& InGlobalBoneTransforms
)

 BEGIN UPDATE SEQUENCE FUNCTIONS
Public function void Optionally can be called before Solve() to use the reference pose as start pose
Public function void  
Public function void

Solve ( const FTransform& WorldToComponent
)

 Run entire stack of solvers.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page