Navigation
API > API/Plugins > API/Plugins/IKRig
This is the base class for defining editable settings for a custom retargeting operation. All user-configurable properties for an "op" should be stored within a single instance of a subclass of this type. These settings will automatically be:
Displayed in the details panel when the op is selected
Saved/loaded with the op in the retarget asset
Applied to the op at runtime as part of a profile
NOTE: the derived type must be returned by the op's GetSettingsType() and GetSettings()
NOTE: UProperties that require reinitialization when modified must be marked meta=(ReinitializeOnEdit) When modified, in the editor, these properties will trigger a reinitialization at which point the runtime Op will get the latest values automatically.
| Name | FIKRetargetOpSettingsBase |
| Type | struct |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Retargeter/IKRetargetOps.h |
| Include Path | #include "Retargeter/IKRetargetOps.h" |
Syntax
USTRUCT (BlueprintType )
struct FIKRetargetOpSettingsBase : public FIKRetargetOpSkeletonProvider
Inheritance Hierarchy
- FIKRetargetOpSkeletonProvider → FIKRetargetOpSettingsBase
Derived Classes
FIKRetargetOpSettingsBase derived class hierarchy
- FIKRetargetAdditivePoseOpSettings
- FIKRetargetAlignPoleVectorOpSettings
- FIKRetargetBlendToSourceOpSettings
- FIKRetargetBodyIntersectIKOpSettings
- FIKRetargetCopyBasePoseOpSettings
- FIKRetargetCurveRemapOpSettings
- FIKRetargetFilterBoneOpSettings
- FIKRetargetFKChainsOpSettings
- FIKRetargetFloorConstraintOpSettings
- FIKRetargetIKChainsOpSettings
- FIKRetargetOffsetGoalsOpSettings
- FIKRetargetPelvisMotionOpSettings
- FIKRetargetPinBoneOpSettings
- FIKRetargetPoseOpSettings
- FIKRetargetRootMotionOpSettings
- FIKRetargetRunIKRigOpSettings
- FIKRetargetScaleGoalsOpSettings
- FIKRetargetScaleSourceOpSettings
- FIKRetargetSpeedPlantingOpSettings
- FIKRetargetStretchChainOpSettings
- FIKRetargetStrideWarpingOpSettings
- FIKRetargetWeaponGoalsOpSettings
- FIKRetargetPelvicMotionOpSettings
- FIKRetargetPreviewPropOpSettings
- FIKRetargetRelativeIKOpSettings
- FIKRetargetRigMapperOpSettingsBase
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FIKRetargetOpSettingsBase() |
Retargeter/IKRetargetOps.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDebugDraw | bool | Toggle on/off all debug drawing on the op. | Retargeter/IKRetargetOps.h | |
| bEnabled | bool | Enable/disable the entire operation. Disabled ops are skipped entirely and do not run at all. | Retargeter/IKRetargetOps.h |
|
| EditorInstance | FIKRetargetOpSettingsBase * | The instance of this op currently running in the editor viewport | Retargeter/IKRetargetOps.h | |
| LODThreshold | int32 | The maximum LOD that this Op is allowed to run at. | Retargeter/IKRetargetOps.h |
|
| OwningOpName | FName | The op these settings belong to | Retargeter/IKRetargetOps.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Controller | TStrongObjectPtr< UIKRetargetOpControllerBase > | The controller used to edit this op by script/blueprint (lazy instantiated when needed) | Retargeter/IKRetargetOps.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UIKRetargetOpControllerBase * GetController
(
UObject* Outer |
Provide a scripting object to edit your custom settings type in the editor via BP/Python NOTE: this returns an instance of whatever type is returned by GetControllerType(). | Retargeter/IKRetargetOps.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Assigned by the processor when an editor instance is initialized, used for UI reflection for bone selectors NOTE: if your op has sub-settings structs that inherit from FIKRetargetOpSkeletonProvider, override this to give them pointers to the skeletons | Retargeter/IKRetargetOps.h | ||
virtual void CopySettingsAtRuntime
(
const FIKRetargetOpSettingsBase* InSettingsToCopyFrom |
(required) override to specify how settings should be applied in a way that will not require reinitialization (ie runtime compatible) | Retargeter/IKRetargetOps.h | |
virtual const UClass * GetControllerType() |
(optional, but recommended) provide a custom controller type (deriving from UIKRetargetOpControllerBase) as an API for editing the op NOTE: this type will automatically be lazy instantiated when/if the user calls GetController() on the op. | Retargeter/IKRetargetOps.h | |
virtual void PostLoad
(
const FIKRigObjectVersion::Type InVersion |
(optional) called during the PostLoad of the owning asset. | Retargeter/IKRetargetOps.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool SerializeOpWithVersion
(
FArchive& Ar, |
NOTE ON RETARGET OP POSTLOAD() / SERIALIZE() BEHAVIOR: If custom op settings require load-patching for backwards compatibility, it is NOT enough to rely on the archive being tagged with custom versioning from the UIKRetargeter itself. | Retargeter/IKRetargetOps.h |