Navigation
API > API/Runtime > API/Runtime/AnimGraphRuntime
Simple 2 Bone IK Controller.
| Name | FAnimNode_TwoBoneIK |
| Type | struct |
| Header File | /Engine/Source/Runtime/AnimGraphRuntime/Public/BoneControllers/AnimNode_TwoBoneIK.h |
| Include Path | #include "BoneControllers/AnimNode_TwoBoneIK.h" |
Syntax
USTRUCT (BlueprintInternalUseOnly)
struct FAnimNode_TwoBoneIK : public FAnimNode_SkeletalControlBase
Inheritance Hierarchy
- FAnimNode_Base → FAnimNode_SkeletalControlBase → FAnimNode_TwoBoneIK
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAnimNode_TwoBoneIK() |
BoneControllers/AnimNode_TwoBoneIK.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAllowStretching | uint8 | Should stretching be allowed, to be prevent over extension | BoneControllers/AnimNode_TwoBoneIK.h |
|
| bAllowTwist | uint8 | Whether or not to apply twist on the chain of joints. | BoneControllers/AnimNode_TwoBoneIK.h |
|
| bMaintainEffectorRelRot | uint8 | Keep local rotation of end bone | BoneControllers/AnimNode_TwoBoneIK.h |
|
| bTakeRotationFromEffectorSpace | uint8 | Set end bone to use End Effector rotation | BoneControllers/AnimNode_TwoBoneIK.h |
|
| CachedLowerLimbIndex | FCompactPoseBoneIndex | Cached limb index for lower | BoneControllers/AnimNode_TwoBoneIK.h | |
| CachedUpperLimbIndex | FCompactPoseBoneIndex | Cached limb index for upper | BoneControllers/AnimNode_TwoBoneIK.h | |
| EffectorLocation | FVector | Effector Location. Target Location to reach. | BoneControllers/AnimNode_TwoBoneIK.h |
|
| EffectorLocationSpace | TEnumAsByte< enum EBoneControlSpace > | Reference frame of Effector Location. | BoneControllers/AnimNode_TwoBoneIK.h |
|
| EffectorTarget | FBoneSocketTarget | BoneControllers/AnimNode_TwoBoneIK.h |
|
|
| IKBone | FBoneReference | Name of bone to control. This is the main bone chain to modify from. | BoneControllers/AnimNode_TwoBoneIK.h |
|
| JointTarget | FBoneSocketTarget | BoneControllers/AnimNode_TwoBoneIK.h |
|
|
| JointTargetLocation | FVector | Joint Target Location. Location used to orient Joint bone. | BoneControllers/AnimNode_TwoBoneIK.h |
|
| JointTargetLocationSpace | TEnumAsByte< enum EBoneControlSpace > | Reference frame of Joint Target Location. | BoneControllers/AnimNode_TwoBoneIK.h |
|
| MaxStretchScale | double | Limits to use if stretching is allowed. | BoneControllers/AnimNode_TwoBoneIK.h |
|
| StartStretchRatio | double | Limits to use if stretching is allowed. | BoneControllers/AnimNode_TwoBoneIK.h |
|
| TwistAxis | FAxis | Specify which axis it's aligned. Used when removing twist | BoneControllers/AnimNode_TwoBoneIK.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CachedJoints | FVector | BoneControllers/AnimNode_TwoBoneIK.h | ||
| CachedJointTargetPos | FVector | BoneControllers/AnimNode_TwoBoneIK.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ConditionalDebugDraw
(
FPrimitiveDrawInterface* PDI, |
BoneControllers/AnimNode_TwoBoneIK.h |
Overridden from FAnimNode_SkeletalControlBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void EvaluateSkeletalControl_AnyThread
(
FComponentSpacePoseContext& Output, |
Evaluate the new component-space transforms for the affected bones. | BoneControllers/AnimNode_TwoBoneIK.h | |
virtual bool IsValidToEvaluate
(
const USkeleton* Skeleton, |
Return true if it is valid to Evaluate | BoneControllers/AnimNode_TwoBoneIK.h |
Overridden from FAnimNode_Base
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GatherDebugData
(
FNodeDebugData& DebugData |
BoneControllers/AnimNode_TwoBoneIK.h | ||
virtual void Initialize_AnyThread
(
const FAnimationInitializeContext& Context |
BoneControllers/AnimNode_TwoBoneIK.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FTransform GetTargetTransform
(
const FTransform& InComponentTransform, |
BoneControllers/AnimNode_TwoBoneIK.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bNoTwist_DEPRECATED | bool | Whether or not to apply twist on the chain of joints. | BoneControllers/AnimNode_TwoBoneIK.h | |
| EffectorSpaceBoneName_DEPRECATED | FName | If EffectorLocationSpace is a bone, this is the bone to use. | BoneControllers/AnimNode_TwoBoneIK.h | |
| JointTargetSpaceBoneName_DEPRECATED | FName | If JointTargetSpaceBoneName is a bone, this is the bone to use. | BoneControllers/AnimNode_TwoBoneIK.h | |
| StretchLimits_DEPRECATED | FVector2D | Limits to use if stretching is allowed - old property DEPRECATED | BoneControllers/AnimNode_TwoBoneIK.h |