Navigation
API > API/Plugins > API/Plugins/IKRig
This is the base class for defining all animation curves operations including curve remapping and rig mapping.
| Name | FIKRetargetCurvesOpBase |
| Type | struct |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/RetargetOps/RetargetCurvesOp.h |
| Include Path | #include "Retargeter/RetargetOps/RetargetCurvesOp.h" |
Syntax
USTRUCT (BlueprintType )
struct FIKRetargetCurvesOpBase : public FIKRetargetOpBase
Inheritance Hierarchy
- FIKRetargetOpBase → FIKRetargetCurvesOpBase
Derived Classes
Structs
| Name | Remarks |
|---|---|
| FCurveData |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FFrameValues | TArray< TArray< TOptional< float > > > | Retargeter/RetargetOps/RetargetCurvesOp.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| SourceCurves | FBlendedHeapCurve | Cached curves, copied on the game thread in PreUpdate() | Retargeter/RetargetOps/RetargetCurvesOp.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetTakeInputCurvesFromSourceAnimInstance() |
A function which allows the user to manually indicate whether to take source curves from the source anim instance, or from the current pose context, since only the first enabled curve processing node must take inputs from the source anim instance | Retargeter/RetargetOps/RetargetCurvesOp.h | |
void SetTakeInputCurvesFromSourceAnimInstance
(
bool bInTakeInputCurvesFromSourceAnimInstance |
A function which allows the user to manually indicate whether to take source curves from the source anim instance, or from the current pose context, since only the first enabled curve processing node must take inputs from the source anim instance | Retargeter/RetargetOps/RetargetCurvesOp.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool HasCurveProcessing() |
(optional) a function which returns true if the operation performs curve processing, false otherwise (default is true) | Retargeter/RetargetOps/RetargetCurvesOp.h | |
virtual void ProcessAnimSequenceCurves
(
FIKRetargetCurvesOpBase::FCurveData InCurveMetaData, |
(optional) a function which can be used during batch processing to apply any operations to curve data for each frame of an anim sequence. | Retargeter/RetargetOps/RetargetCurvesOp.h |
Overridden from FIKRetargetOpBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanHaveChildOps() |
(optional) ops can optionally behave as a 'parent' where child ops must be executed first. | Retargeter/RetargetOps/RetargetCurvesOp.h | |
virtual const UScriptStruct * GetType() |
(required) override and return the type of this op (the derived subclass) | Retargeter/RetargetOps/RetargetCurvesOp.h | |
virtual bool Initialize
(
const FIKRetargetProcessor& InProcessor, |
NOTE: this op does not do anything in Initialize() or Run(). | Retargeter/RetargetOps/RetargetCurvesOp.h | |
virtual bool IsAbstract() |
Designator of an "abstract" base struct, in this case used to classify curve related ops. | Retargeter/RetargetOps/RetargetCurvesOp.h | |
virtual bool IsSingleton() |
(optional) return true to disallow multiple copies of this op in the stack | Retargeter/RetargetOps/RetargetCurvesOp.h | |
virtual void Run
(
FIKRetargetProcessor& InProcessor, |
(optional) override to evaluate this operation and modify the output pose | Retargeter/RetargetOps/RetargetCurvesOp.h |