Navigation
API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Units > API/Plugins/ControlRig/Units/Animation
Inheritance Hierarchy
- FRigVMDispatchFactory
- FRigDispatchFactory
- FRigDispatch_AnimAttributeBase
- FRigDispatch_GetAnimAttribute
- FRigDispatch_SetAnimAttribute
References
| Module | ControlRig |
| Header | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Units/Animation/RigUnit_AnimAttribute.h |
| Include | #include "Units/Animation/RigUnit_AnimAttribute.h" |
Syntax
USTRUCT (
Meta=(Abstract, Category="Animation Attribute", NodeColor="0.462745, 1,0, 0.329412", Varying))
struct FRigDispatch_AnimAttributeBase : public FRigDispatchFactory
Remarks
Animation Attributes allow dynamically added data to flow from one Anim Node to other Anim Nodes downstream in the Anim Graph and accessible from deformer graph
Variables
| Type | Name | Description | |
|---|---|---|---|
| int32 | BoneNameArgIndex | ||
| int32 | CachedBoneIndexArgIndex | ||
| int32 | CachedBoneNameArgIndex | Hidden | |
| int32 | DefaultArgIndex | ||
| int32 | FoundArgIndex | ||
| TArray< FRigVMTemplateArgumentInfo > | Infos | ||
| int32 | NameArgIndex | Input | |
| int32 | SuccessArgIndex | ||
| int32 | ValueArgIndex | Output |
Functions
| Type | Name | Description | |
|---|---|---|---|
| const TArray< FRigVMTemplateArgument::ETypeCategory > & | |||
| bool | IsSet () |
||
| bool | IsTypeSupported
(
const TRigVMTypeIndex& InTypeIndex |
Overridden from FRigVMDispatchFactory
| Type | Name | Description | |
|---|---|---|---|
| const TArray< FRigVMTemplateArgumentInfo > & | Returns the arguments of the template | ||
| FText | GetArgumentTooltip
(
const FName& InArgumentName, |
Returns the tooltip for an argument | |
| FString | GetNodeTitle
(
const FRigVMTemplateTypeMap& InTypes |
Returns the title of the node for a given type set. | |
| void | Registered needed types during registration of the factory |