1. Epic GamesDeveloper
  3. UIKRig_BodyMover

UIKRig_BodyMover

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

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;BlueprintType, EditInlineNew&41;  
class UIKRig_BodyMover : public UIKRigSolver

Variables

  Type Name Description
Public variable UProperty TArray< TObjectPtr< UIKRig_BodyMoverEffector > > Effectors  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float PositionAlpha Blend the translational effect of this solver on/off. Range is 0-1. Default is 1.0.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float PositionNegativeX Multiply the NEGATIVE X translation. Range is 0-1. Default is 1.0.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float PositionNegativeY Multiply the NEGATIVE Y translation. Range is 0-1. Default is 1.0.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float PositionNegativeZ Multiply the NEGATIVE Z translation. Range is 0-1. Default is 1.0.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float PositionPositiveX Multiply the POSITIVE X translation. Range is 0-1. Default is 1.0.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float PositionPositiveY Multiply the POSITIVE Y translation. Range is 0-1. Default is 1.0.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float PositionPositiveZ Multiply the POSITIVE Z translation. Range is 0-1. Default is 1.0.
Public variable UProperty Category visibleanywhere FName RootBone The target bone to move with the effectors.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float RotateXAlpha Blend the X-axis rotational effect on/off. Range is 0-1. Default is 1.0.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float RotateYAlpha Blend the Y-axis rotational effect on/off. Range is 0-1. Default is 1.0.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float RotateZAlpha Blend the Z-axis rotational effect on/off. Range is 0-1. Default is 1.0.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float RotationAlpha Blend the total rotational effect on/off. Range is 0-1. Default is 1.0.

Overridden from UIKRigSolver

  Type Name Description
Public function Virtual void

AddGoal ( const UIKRigEffectorGoal& NewGoal
)

 Goals
Public function Virtual Const UObject *

GetGoalSettings ( const FName& GoalName
)

 Override to support supplying goals settings specific to this solver to outside systems for editing/UI
Public function Virtual Const FText Override to give your solver a nice name to display in the UI
Public function Virtual Const FName If solver requires a root bone, then override this to return it.
Public function Virtual Const bool

GetWarningMessage ( FText& OutWarningMessage
)

 Override to provide warning to user during setup of any missing components.
Public function Virtual void

Initialize ( const FIKRigSkeleton& IKRigSkeleton
)

 UIKRigSolver interface
Public function Virtual Const bool

IsBoneAffectedBySolver ( const FName& BoneName,
const FIKRigSkeleton& IKRigSkeleton
)

 Return true if the supplied Bone is affected by this solver - this provides UI feedback for user
Public function Virtual Const bool

IsGoalConnected ( const FName& GoalName
)

 Override to support QUERY for a connected goal
Public function Virtual void

RemoveGoal ( const FName& GoalName
)

 Override to support REMOVING a goal from custom solver
Public function Virtual void

RenameGoal ( const FName& OldName,
const FName& NewName
)

 Override to support RENAMING an existing goal
Public function Virtual Const bool Root bone can be set on this solver
Public function Virtual void

SetGoalBone ( const FName& GoalName,
const FName& NewBoneName
)

 Override to support CHANGING BONE for an existing goal
Public function Virtual void

SetRootBone ( const FName& RootBoneName
)

 Override to support SETTING ROOT BONE for the solver
Public function Virtual void

Solve ( FIKRigSkeleton& IKRigSkeleton,
const FIKRigGoalContainer& Goals
)

 Override Solve() to evaluate new output pose (InOutGlobalTransform)
Public function Virtual void Override to support RECEIVING modified solver settings from outside systems for editing/UI.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page