1. Epic GamesDeveloper
  3. UIKRigEffectorGoal

UIKRigEffectorGoal

API > API/Plugins > API/Plugins/IKRig

   
Name UIKRigEffectorGoal
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 UIKRigEffectorGoal : public UObject

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bExposePosition bool Should position data be exposed in Blueprint Rig/IKRigDefinition.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Exposure"
bExposeRotation bool Should rotation data be exposed in Blueprint Rig/IKRigDefinition.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Exposure"
BoneName FName The name of the bone that this Goal is located at. Rig/IKRigDefinition.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Category="Goal Settings"
CurrentTransform FTransform The current transform of this Goal, in the Global Space of the character. Rig/IKRigDefinition.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Goal Settings"
GoalName FName The name used to refer to this goal from outside systems. Rig/IKRigDefinition.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Category="Goal Settings"
InitialTransform FTransform The initial transform of this Goal, as defined by the initial transform of the Goal's bone in the retarget pose. Rig/IKRigDefinition.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Category="Goal Settings"
PositionAlpha float Range 0-1, default is 1. Rig/IKRigDefinition.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Goal Settings"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
PreviewMode EIKRigGoalPreviewMode Effects how this Goal transform is previewed in the IK Rig editor. Rig/IKRigDefinition.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Goal Settings"
RotationAlpha float Range 0-1, default is 1. Rig/IKRigDefinition.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Goal Settings"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")
SizeMultiplier float The size of the Goal gizmo drawing in the editor viewport. Rig/IKRigDefinition.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Viewport Goal Settings"
  • Meta=(ClampMin="0.1", ClampMax="1000.0", UIMin="0.1", UIMax="100.0")
ThicknessMultiplier float The thickness of the Goal gizmo drawing in the editor viewport. Rig/IKRigDefinition.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="Viewport Goal Settings"
  • Meta=(ClampMin="0.0", ClampMax="10.0", UIMin="0.0", UIMax="5.0")

Functions

Public

Name Remarks Include Path Unreal Specifiers

TOptional< FTransform::FReal > GetNumericValue ( ESlateTransformComponent::Type Component,
ESlateRotationRepresentation::Type Representation,
ESlateTransformSubComponent::Type SubComponent,
EIKRigTransformType::Type TransformType
) const

   Rig/IKRigDefinition.h  

void OnCopyToClipboard ( ESlateTransformComponent::Type Component,
EIKRigTransformType::Type TransformType
) const

   Rig/IKRigDefinition.h  

void OnPasteFromClipboard ( ESlateTransformComponent::Type Component,
EIKRigTransformType::Type TransformType
)

   Rig/IKRigDefinition.h  

TTuple< FTransform, FTransform > PrepareNumericValueChanged ( ESlateTransformComponent::Type Component,
ESlateRotationRepresentation::Type Representation,
ESlateTransformSubComponent::Type SubComponent,
FTransform::FReal Value,
EIKRigTransformType::Type TransformType
) const

   Rig/IKRigDefinition.h  

void ResetTransformToDefault ( ESlateTransformComponent::Type Component,
TSharedPtr< IPropertyHandle > PropertyHandle
)

   Rig/IKRigDefinition.h  

void SetTransform ( const FTransform& InTransform,
EIKRigTransformType::Type InTransformType
)

   Rig/IKRigDefinition.h  

bool TransformDiffersFromDefault ( ESlateTransformComponent::Type Component,
TSharedPtr< IPropertyHandle > PropertyHandle
) const

   Rig/IKRigDefinition.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   Rig/IKRigDefinition.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator== ( const UIKRigEffectorGoal& Other
) const

   Rig/IKRigDefinition.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page