Navigation
API > API/Plugins > API/Plugins/IKRig
| Name | FIKRetargetFloorConstraintOp |
| Type | struct |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/RetargetOps/FloorConstraintOp.h |
| Include Path | #include "Retargeter/RetargetOps/FloorConstraintOp.h" |
Syntax
USTRUCT (BlueprintType , Meta=(DisplayName="Floor Constraint"))
struct FIKRetargetFloorConstraintOp : public FIKRetargetOpBase
Inheritance Hierarchy
- FIKRetargetOpBase → FIKRetargetFloorConstraintOp
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FloorConstraints | TArray< FFloorConstraint > | Retargeter/RetargetOps/FloorConstraintOp.h | ||
| Settings | FIKRetargetFloorConstraintOpSettings | Retargeter/RetargetOps/FloorConstraintOp.h |
Functions
Public
Overridden from FIKRetargetOpBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AreChainSettingsAtDefault
(
const FName& InChainName |
(optional) override to support "Reset to Default" UI for chains | Retargeter/RetargetOps/FloorConstraintOp.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/FloorConstraintOp.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/FloorConstraintOp.h | |
virtual const UScriptStruct * GetSettingsType() |
(required) override and return the type used to house the settings for this operation | Retargeter/RetargetOps/FloorConstraintOp.h | |
virtual const UScriptStruct * GetType() |
(required) override and return the type of this op (the derived subclass) | Retargeter/RetargetOps/FloorConstraintOp.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/FloorConstraintOp.h | |
virtual void OnAddedToStack
(
const UIKRetargeter* InRetargetAsset, |
(optional) override to automate initial setup after being added to the stack | Retargeter/RetargetOps/FloorConstraintOp.h | |
virtual void OnAssignIKRig
(
const ERetargetSourceOrTarget SourceOrTarget, |
(optional) override to react after user assigns a new IK Rig to all ops | Retargeter/RetargetOps/FloorConstraintOp.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/FloorConstraintOp.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/FloorConstraintOp.h | |
virtual void ResetChainSettingsToDefault
(
const FName& InChainName |
(optional) override to support resetting all settings for a given chain | Retargeter/RetargetOps/FloorConstraintOp.h | |
virtual void Run
(
FIKRetargetProcessor& InProcessor, |
(optional) override to evaluate this operation and modify the output pose | Retargeter/RetargetOps/FloorConstraintOp.h | |
virtual void SetSettings
(
const FIKRetargetOpSettingsBase* InSettings |
(optional) override to react when settings are applied at runtime NOTE: This is called while the Op is running AFTER Initialize() so it up to the Op author to copy only those settings which are safe to be updated while the op is running. | Retargeter/RetargetOps/FloorConstraintOp.h |