Navigation
API > API/Plugins > API/Plugins/ControlRig
Retrieves various pieces of info about an interpolated transform hierarchy from an rig element item list
| Name | FRigUnit_ChainInfo |
| Type | struct |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
| Include Path | #include "Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h" |
Syntax
USTRUCT (Meta=(DisplayName="Chain Info", Category="Hierarchy", Keywords="Chain"))
struct FRigUnit_ChainInfo : public FRigUnit_HighlevelBase
Inheritance Hierarchy
- FRigVMStruct → FRigUnit → FRigUnit_HighlevelBase → FRigUnit_ChainInfo
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigUnit_ChainInfo() |
Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCalculateStretch | bool | If True calculate stretch factors of chain and current segment | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
| bDebug | bool | Enable debug draw for node | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
| bInitial | bool | If True use initial transform values for chain | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
| CachedElements | TArray< FCachedRigElement > | Used to cache the internally used index. | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h | |
| ChainLength | float | The length of the interpolated chain | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
| ChainStretchFactor | float | Stretch factor of chain | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
| DebugScale | float | Debug draw scale | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
| InterpolatedTransform | FTransform | The interpolated transform at the chain's input parameter | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
| Items | TArray< FRigElementKey > | The items to use to interpret the chain | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
| Param | float | The parameter value down the chain of items from 0 to 1 | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
| ParamLength | float | The length of the interpolated chain | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
| SegmentInfo | FRigUnit_ChainInfo_SegmentInfo | Segment Info | Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |
|
Functions
Public
Overridden from FRigVMStruct
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute() |
Units/Highlevel/Hierarchy/RigUnit_ChainInfo.h |