FIKRetargetRelativeIKOpSettings

API > API/Plugins > API/Plugins/RelativeIKOp

   
Name FIKRetargetRelativeIKOpSettings
Type struct
Header File /Engine/Plugins/Experimental/Animation/RelativeIKOp/Source/RelativeIKOp/Public/RelativeIKOp.h
Include Path #include "RelativeIKOp.h"

Syntax

USTRUCT (BlueprintType , Meta=(DisplayName="Relative IK Settings"))  
struct FIKRetargetRelativeIKOpSettings : public FIKRetargetOpSettingsBase

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AmplifyCloseDistance double Max weight increase cap distance (very close to prop) RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Importance Weight"
  • Meta=(ClampMin="0.1")
AmplifyCloseThreshold double Start amplifying weight at this distance (close-ish to prop) RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Importance Weight"
  • Meta=(ClampMin="1.0")
AmplifyScale double Bias feasibility distance weighting relative to distance threshold (+ increase target feasibility/- reduced target feasibility) RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Importance Weight"
  • Meta=(ClampMin="1.0", ClampMax="20.0")
bApplyImportanceWeighting bool   RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Importance Weight"
bApplyPostSolvePinning bool Apply prop pin post-solve. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Test Features"
bBidirectionalDistanceContactBlend bool Distance blend body pairs towards each contact position if both can move. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Test Features"
bDebugDrawBodyPairs bool Draw source and target body pair relationships for current animation. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Debug"
bDebugDrawBodyTransforms bool Show body-local transform setup (like baked verts) RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Debug"
bDebugDrawGoalContributions bool Draw each pair's goal contribution (white) and show weighted final goal location (yellow) RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Debug"
bDebugDrawPhysicsBodies bool Display source and target physics bodies for baked data. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Debug"
bDebugDrawRetargetVertAverages bool Draw retarget pair-line for each pair contribution. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Debug"
bDryRun bool Run op and display debug info but DON'T update IK Goals. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Debug"
bEnableIntersectPushOut bool Enable Collison push out for Ikgoals and Props. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Intersection"
bIgnoreSourceScale bool Ignore source scaling when computing relative distance relationships. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Parameters"
BlendPinsToSource double Blend from relative ik pin bone to source location. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Test Features"
  • Meta=(ClampMin="0", ClampMax="1")
bMultiBoneSolve bool // Distance blend contact bodies towards domain bodies RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Test Features"
BodyMapping TMap< FName, FName > Physics body source -> target name mapping. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Source Target Mapping"
  • Meta=(ReinitializeOnEdit)
bSolveWithPropScale bool Add Props scale as a parameter for optimization. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Prop Scaling"
ContributionSumWeight double IK Goal normalization (internally multiplied by total of contribution weights) RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Parameters"
  • Meta=(ClampMin="0", ClampMax="1")
DebugFullRetargetPairBones TArray< FName > Draw full retarget space (quad) pair relationships. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Debug"
  • Meta=(NotOverrideable)
DistanceThreshold double Maximum distance for which body pair info is baked. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Parameters"
  • Meta=(ClampMin="0.1")
DistanceWeightMode EDistanceWeightMode DistHalfPointLambda*DistanceThreshold is the place where distance weight value be 0.5. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Parameters"
DistHalfPointLambda double DistHalfPointLambda*DistanceThreshold is the place where distance weight value be 0.5. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Parameters"
  • Meta=(ClampMin="0.01", ClampMax="0.99")
FeasibilityLengthBias double Bias feasibility distance weighting relative to distance threshold (+ increase target feasibility/- reduced target feasibility) RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Parameters"
FloorConstraintScalar double Maximum distance for which prop-floor info is baked. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Parameters"
  • Meta=(ClampMin="0.0")
FloorThreshold double Maximum distance for which prop-floor info is baked. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Parameters"
  • Meta=(ClampMin="0.1")
GlueThreshold double Max distance to glue bodies (very close to a body) RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Intersection"
  • Meta=(ClampMin="0.01")
IntersectBodies TArray< FName > Bone names with attached physics bodies to do trivial intersection against NOTE: Only Sphere, Capsule and Box bodies currently supported RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Intersection"
  • Meta=(NotOverrideable)
IntersectOffsetScale double Max distance to glue bodies (very close to a body) RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Intersection"
  • Meta=(ClampMin="0.01")
MultiBoneRegularization double Regularization additive constant for stabilizing multibone solve, the higher the body bones will stay at original position. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Test Features"
  • Meta=(ClampMin="0.001")
PinPropBones TArray< FPinBoneSettings > List of bones to pin. Should include all attach bones that may be affected by relative ik bake data. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Prop Settings"
  • Meta=(ReinitializeOnEdit)
PropScalarBoneRegularization double Regularization additive constant for stabilizing prop bone position, the higher the prop bones will stay at original position. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Prop Scaling"
  • Meta=(ClampMin="0.001")
PropScalarDamping double Regularization additive constant for stabilizing prop bone scalar, the higher the prop bones will stay at original Propscalar set in PinPropBone Settings. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Prop Scaling"
  • Meta=(ClampMin="0.001")
PropScalarLearningRate double Props scalar change ratio which allow to change per frame. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Prop Scaling"
  • Meta=(ClampMin="0.0001", ClampMax="10")
PropScalarRange double Test Parameter for prop scalar range allow to change, it will clamp prop scalar between [PinPropBone.Propscalar-PropScalarRange, PinPropBone.Propscalar+PropScalarRange]. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Prop Scaling"
  • Meta=(ClampMin="0", ClampMax="10")
RetargetContactAlpha double Alpha from contact-body to secondary body representation in contribution pairs. RelativeIKOp.h
  • BlueprintReadWrite
  • Category="Parameters"
RetargetSpringAlpha double Alpha between primary and secondary pair distance relationship. RelativeIKOp.h
  • BlueprintReadWrite
  • Category="Parameters"
TargetIntersectOpPhysicsAssetOverride TObjectPtr< UPhysicsAsset > Target mesh physics asset for Intersect push out. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Intersection"
  • Meta=(ReinitializeOnEdit)
TargetPhysicsAssetOverride TObjectPtr< UPhysicsAsset > Target mesh physics asset for retargeting relative body pair vertices. RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Physics"
  • Meta=(ReinitializeOnEdit)
TemporalSmoothingRadius int32 Frames of temporal smoothing of body pair verts (0 is no smoothing) RelativeIKOp.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Parameters"
  • Meta=(ClampMin="0", ClampMax="60")

Functions

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page