Navigation
API > API/Plugins > API/Plugins/IKRig
| Name | FIKRigStretchLimbSolver |
| Type | struct |
| Header File | /Engine/Plugins/Animation/IKRig/Source/IKRig/Public/Rig/Solvers/IKRigStretchLimb.h |
| Include Path | #include "Rig/Solvers/IKRigStretchLimb.h" |
Syntax
USTRUCT (BlueprintType )
struct FIKRigStretchLimbSolver : public FIKRigSolverBase
Inheritance Hierarchy
- FIKRigSolverBase → FIKRigStretchLimbSolver
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AllBoneSettings | TArray< FIKRigStretchLimbBoneSettings > | Rig/Solvers/IKRigStretchLimb.h | ||
| Settings | FIKRigStretchLimbSettings | Rig/Solvers/IKRigStretchLimb.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsInitialized | bool | Rig/Solvers/IKRigStretchLimb.h | ||
| BoneIndices | TArray< int32 > | Rig/Solvers/IKRigStretchLimb.h | ||
| BonePositionsPreOffset | TArray< FVector > | Rig/Solvers/IKRigStretchLimb.h | ||
| ChildrenToUpdate | TArray< int32 > | Rig/Solvers/IKRigStretchLimb.h | ||
| InitialPoleVectorLenSq | double | Rig/Solvers/IKRigStretchLimb.h | ||
| PoleVectorParams | TArray< double > | Rig/Solvers/IKRigStretchLimb.h | ||
| RestLengths | TArray< double > | Rig/Solvers/IKRigStretchLimb.h | ||
| TotalRestLength | double | Rig/Solvers/IKRigStretchLimb.h |
Functions
Public
Overridden from FIKRigSolverBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddGoal
(
const UIKRigEffectorGoal& InNewGoal |
Goals | Rig/Solvers/IKRigStretchLimb.h | |
virtual void AddSettingsToBone
(
const FName& InBoneName |
(required if UsesCustomBoneSettings()) override to support ADDING settings to a particular bone | Rig/Solvers/IKRigStretchLimb.h | |
virtual FIKRigBoneSettingsBase * GetBoneSettings
(
const FName& InBoneName |
(required if UsesCustomBoneSettings()) override to support supplying per-bone settings to outside systems for editing/UI NOTE: This must be overriden on solvers that use bone setting and return nullptr if no settings for the given bone | Rig/Solvers/IKRigStretchLimb.h | |
virtual const UScriptStruct * GetBoneSettingsType() |
(required if UsesCustomBoneSettings()) returns the type used for the bone settings in this solver | Rig/Solvers/IKRigStretchLimb.h | |
virtual void GetBonesWithSettings
(
TSet< FName >& OutBonesWithSettings |
(required if UsesCustomBoneSettings()) override to support telling outside systems which bones this solver has settings for. | Rig/Solvers/IKRigStretchLimb.h | |
virtual FText GetNiceName() |
UI stuff. | Rig/Solvers/IKRigStretchLimb.h | |
virtual void GetRequiredBones
(
TSet< FName >& OutRequiredBones |
(required) override to add any bones which this solver requires (helps validate skeleton compatibility) | Rig/Solvers/IKRigStretchLimb.h | |
virtual void GetRequiredGoals
(
TSet< FName >& OutRequiredGoals |
(required) override to add any goals that have been added to this solver | Rig/Solvers/IKRigStretchLimb.h | |
virtual UIKRigSolverControllerBase * GetSolverController
(
UObject* Outer |
Return custom controller for scripting this solver | Rig/Solvers/IKRigStretchLimb.h | |
virtual FIKRigSolverSettingsBase * GetSolverSettings() |
Solver settings | Rig/Solvers/IKRigStretchLimb.h | |
virtual const UScriptStruct * GetSolverSettingsType() |
(required) override this and return the type your solver uses to store its settings | Rig/Solvers/IKRigStretchLimb.h | |
virtual FName GetStartBone() |
(required if UsesStartBone()) if solver requires a start bone, then override this to return it. | Rig/Solvers/IKRigStretchLimb.h | |
virtual bool GetWarningMessage
(
FText& OutWarningMessage |
(optional, but recommended) override to provide warning to user during setup of any missing components. return false if no warnings. | Rig/Solvers/IKRigStretchLimb.h | |
virtual bool HasSettingsOnBone
(
const FName& InBoneName |
(required if UsesCustomBoneSettings()) override to inform outside systems if the given bone has custom settings on it | Rig/Solvers/IKRigStretchLimb.h | |
virtual void Initialize
(
const FIKRigSkeleton& InIKRigSkeleton |
RUNTIME (required) override to setup internal data based on ref pose | Rig/Solvers/IKRigStretchLimb.h | |
virtual bool IsBoneAffectedBySolver
(
const FName& InBoneName, |
(optional, but recommended) return true if the supplied Bone is affected by this solver - this provides UI feedback for user | Rig/Solvers/IKRigStretchLimb.h | |
| (required) override to support CHANGING BONE for an existing goal | Rig/Solvers/IKRigStretchLimb.h | ||
virtual void OnGoalRemoved
(
const FName& InGoalName |
(required) override to support REMOVING a goal from custom solver | Rig/Solvers/IKRigStretchLimb.h | |
| (required) override to support RENAMING an existing goal | Rig/Solvers/IKRigStretchLimb.h | ||
virtual void RemoveSettingsOnBone
(
const FName& InBoneName |
(required if UsesCustomBoneSettings()) override to support REMOVING settings on a particular bone | Rig/Solvers/IKRigStretchLimb.h | |
virtual void SetStartBone
(
const FName& InRootBoneName |
(required if UsesStartBone()) override to support SETTING ROOT BONE for the solver | Rig/Solvers/IKRigStretchLimb.h | |
virtual void Solve
(
FIKRigSkeleton& InIKRigSkeleton, |
(required) override Solve() to evaluate new output pose (InOutGlobalTransform) | Rig/Solvers/IKRigStretchLimb.h | |
virtual bool UsesCustomBoneSettings() |
Bone settings | Rig/Solvers/IKRigStretchLimb.h | |
virtual bool UsesCustomGoalSettings() |
Goal settings | Rig/Solvers/IKRigStretchLimb.h | |
virtual bool UsesStartBone() |
Start bone can be set on this solver | Rig/Solvers/IKRigStretchLimb.h |