1. Epic GamesDeveloper
  3. FIKRigGoal

FIKRigGoal

API > API/Plugins > API/Plugins/IKRig

   
Name FIKRigGoal
Type struct
Header File /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/IKRigDataTypes.h
Include Path #include "Rig/IKRigDataTypes.h"

Syntax

USTRUCT (Blueprintable)  
struct FIKRigGoal

Constructors

Name Remarks Include Path Unreal Specifiers
  Rig/IKRigDataTypes.h  

FIKRigGoal ( const UIKRigEffectorGoal* InGoal
)

   Rig/IKRigDataTypes.h  

FIKRigGoal ( const FName& InGoalName,
const FName& InBoneName
)

   Rig/IKRigDataTypes.h  

FIKRigGoal ( const FName& InName,
const FName& InBoneName,
const FVector& InPosition,
const FQuat& InRotation,
const float InPositionAlpha,
const float InRotationAlpha,
EIKRigGoalSpace InPositionSpace,
EIKRigGoalSpace InRotationSpace,
bool bInEnabled
)

   Rig/IKRigDataTypes.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bEnabled bool If true, the goal is active and can be used by solvers in the rig. Rig/IKRigDataTypes.h
  • Transient
BoneName FName Name of the bone associate with this goal. Rig/IKRigDataTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Goal
FinalBlendedPosition FVector   Rig/IKRigDataTypes.h
  • Transient
FinalBlendedRotation FQuat   Rig/IKRigDataTypes.h
  • Transient
Name FName Name of the IK Goal. Must correspond to the name of a Goal in the target IKRig asset. Rig/IKRigDataTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Goal
Position FVector Position of the IK goal in Component Space of target actor component. Rig/IKRigDataTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Position
  • Meta=(EditCondition="Source == EIKRigGoalSource::Manual")
PositionAlpha float Range 0-1, default is 1.0. Rig/IKRigDataTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Position
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
PositionSpace EIKRigGoalSpace The space that the goal position is in. Rig/IKRigDataTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Position
Rotation FRotator Rotation of the IK goal in Component Space of target actor component. Rig/IKRigDataTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Rotation
  • Meta=(EditCondition="Source == EIKRigGoalSource::Manual")
RotationAlpha float Range 0-1, default is 1.0. Rig/IKRigDataTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Rotation
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
RotationSpace EIKRigGoalSpace The space that the goal rotation is in. Rig/IKRigDataTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Rotation
SourceBone FBoneReference When TransformSource is set to "Bone" mode, the Position and Rotation will be driven by this Bone's input transform. Rig/IKRigDataTypes.h
  • EditAnywhere
  • Category=Goal
TransformSource EIKRigGoalTransformSource Set the source of the transform data for the Goal. Rig/IKRigDataTypes.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Goal

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString ToString()

   Rig/IKRigDataTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page