Navigation
API > API/Plugins > API/Plugins/IKRig
| Name | FIKRetargetSpeedPlantingOp |
| Type | struct |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/RetargetOps/SpeedPlantingOp.h |
| Include Path | #include "Retargeter/RetargetOps/SpeedPlantingOp.h" |
Syntax
USTRUCT (BlueprintType , Meta=(DisplayName="Speed Plant IK Goals"))
struct FIKRetargetSpeedPlantingOp : public FIKRetargetOpBase
Inheritance Hierarchy
- FIKRetargetOpBase → FIKRetargetSpeedPlantingOp
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ResetThisTick | bool | Retargeter/RetargetOps/SpeedPlantingOp.h | ||
| Settings | FIKRetargetSpeedPlantingOpSettings | Retargeter/RetargetOps/SpeedPlantingOp.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GoalsToPlant | TArray< FSpeedPlantingGoalState > | Retargeter/RetargetOps/SpeedPlantingOp.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Return array of names of all the speed curves referenced by this op. | Retargeter/RetargetOps/SpeedPlantingOp.h |
Overridden from FIKRetargetOpBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AnimGraphEvaluateAnyThread
(
FPoseContext& Output |
(optional) override to get any data from the anim graph as it's evaluating. | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual void AnimGraphPreUpdateMainThread
(
USkeletalMeshComponent& SourceMeshComponent, |
(optional) override to get any data from the source or target skeletal mesh component NOTE: this is called during AnimGraph::PreUpdate() which runs on the main thread, use caution. | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual const UScriptStruct * GetParentOpType() |
(optional) ops can optionally behave as a 'child' where they can be parented to ops of the type returned by this function. | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual FIKRetargetOpSettingsBase * GetSettings () |
(required) override and return a pointer to the settings struct used by this operation NOTE: it is not permitted to modify the settings from inside this getter. | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual const UScriptStruct * GetSettingsType() |
(required) override and return the type used to house the settings for this operation | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual const UScriptStruct * GetType() |
(required) override and return the type of this op (the derived subclass) | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual FText GetWarningMessage() |
(optional) override to display a warning message in the op stack | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual bool Initialize
(
const FIKRetargetProcessor& InProcessor, |
(optional) override to cache internal data when initializing the processor NOTE: you must set bIsInitialized to true to inform the retargeter that this op is ok to execute. | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual void OnAddedToStack
(
const UIKRetargeter* InRetargetAsset, |
(optional) override to automate initial setup after being added to the stack | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual void OnAssignIKRig
(
const ERetargetSourceOrTarget SourceOrTarget, |
(optional) override to react after user assigns a new IK Rig to all ops | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual void OnParentReinitPropertyEdited
(
const FIKRetargetOpBase& InParentOp, |
(optional) override to allow ops to react when a property marked "ReinitializeOnEdit" on the parent op is modified NOTE: InPropertyChangedEvent will be null at load time giving op a chance to clean based on parent state. | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual void OnPlaybackReset() |
(optional) override to reset any internal state when animation playback is reset or stopped (ie, springs / dampers etc) | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual void OnTargetChainRenamed
(
const FName InOldChainName, |
(optional) implement this if the op stores chain settings by name to allow the settings to be maintained after a chain is renamed NOTE: this is only called when the target IK Rig this op references has a chain that is renamed. | Retargeter/RetargetOps/SpeedPlantingOp.h | |
virtual void Run
(
FIKRetargetProcessor& InProcessor, |
(optional) override to evaluate this operation and modify the output pose | Retargeter/RetargetOps/SpeedPlantingOp.h |