code: namespace ERigTransformType { enum Type { InitialLocal, CurrentLocal, InitialGlobal, CurrentGlobal, NumTransformTypes, } }


module: ControlRig

code: namespace ERigTransformType { [Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) ERigTransformType::SwapLocalAndGlobal ( const [Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType ) }


code: virtual int32 AddUserDataImpl ( const void * InData )


code: virtual void EmptyUserData ( int32 Size )


code: virtual const FTransform & GetGlobalTransform ( int32 Index ) const


code: virtual FTransform & GetGlobalTransform ( int32 Index )


code: virtual FTransform & GetLocalTransform ( int32 Index )


description: It's up to your hierarchy to decide what to do with this

code: virtual const FTransform & GetLocalTransform ( int32 Index ) const


code: virtual int32 GetNumUserData() const


code: virtual void * GetUserDataImpl ( int32 Index )


description: Derived classes can implement this to supply per-node user data

code: virtual const void * GetUserDataImpl ( int32 Index ) const


code: virtual bool HasUserData() const


code: virtual void RemoveUserData ( int32 Index )


code: virtual void SetGlobalTransform ( int32 Index, const FTransform & NewTransform )


code: virtual void SetLocalTransform ( int32 Index, const FTransform & NewTransform )


code: virtual ~FAnimationHierarchy()


code: const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * GetElement() const


className: FAnimationHierarchy

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FAnimationHierarchy : public [FNodeHierarchyWithUserData](API\Runtime\AnimationCore\FNodeHierarchyWithUserData)

UserData

type: TArray<FConstr...


code: const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & GetKey() const


code: bool IsIdentical ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey, const [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy )


code: operator FRigElementKey() const


className: FCachedRigElement::operator bool

code: operator bool() const


className: FCachedRigElement::operator int32

code: operator int32() const


code: bool operator== ( const [FCachedRigElement](API\Plugins\ControlRig\Rigs\FCachedRigElement) & Other ) const


code: bool operator== ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & Other ) const


code: bool operator== ( const int32 & Other ) const


code: bool operator< ( const [FCachedRigElement](API\Plugins\ControlRig\Rigs\FCachedRigElement) & Other ) const


code: bool operator> ( const [FCachedRigElement](API\Plugins\ControlRig\Rigs\FCachedRigElement) & Other ) const


code: bool operator!= ( const [FCachedRigElement](API\Plugins\ControlRig\Rigs\FCachedRigElement) & Other ) const


code: bool operator!= ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & Other ) const


code: bool operator!= ( const int32 & Other ) const


code: bool UpdateCache ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey, const [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy )


code: bool UpdateCache ( const [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy )


code: FCachedRigElement ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey, const [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy )


code: void AddConstraint ( const [FTransformConstraint](API\Runtime\AnimationCore\FTransformConstraint) & TransformConstraint )


code: void DeleteConstraint ( const [FName](API\Runtime\Core\UObject\FName) & TargetNode )


code: bool DoesHaveConstraint() const


code: [FTransformConstraint](API\Runtime\AnimationCore\FTransformConstraint) * FindConstraint ( const [FName](API\Runtime\Core\UObject\FName) & TargetNode )


description: Returns constraint ptr if found

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FTransformConstraint](API\Runtime\AnimationCore\FTransformConstraint) > GetConstraints() const


className: FConstraintNodeData

ConstraintOffset

type: FConstraintOffs...

LinkedNode

type: FName

RelativeParent

type: FTransform


className: FFKBoneCheckInfo

description: Structs used to specify which bones/curves/controls we should have active, since if all controls or active we can't passthrough some previous bone transform

code: struct FFKBoneCheckInfo

bActive

type: bool


description: Helper function to be called as part ofURigHierarchy::CopyHierarchy

code: virtual void CopyFrom ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InOtherHierarchy )


code: virtual void CopyPose ( [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, bool bCurrent, bool bInitial, bool bWeights )


className: ESerializationPhase

code: enum ESerializationPhase { StaticData, InterElementData, }


code: virtual const [FName](API\Runtime\Core\UObject\FName) & GetDisplayName() const


code: [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetElementStruct() const


code: const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & GetKey() const


code: [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * GetMetadata ( int32 InIndex ) const


code: [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * GetMetadata ( const [FName](API\Runtime\Core\UObject\FName) & InName ) const


code: [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * GetMetadata ( const [FName](API\Runtime\Core\UObject\FName) & InName, [ERigMetadataType](API\Plugins\ControlRig\Rigs\ERigMetadataType) InType ) const


code: int32 GetMetadataVersion() const


code: const [FName](API\Runtime\Core\UObject\FName) & GetName() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetNameString() const


code: template<typename T> bool IsA() const


code: static bool IsClassOf ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement )


code: bool IsTypeOf ( [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) InElementType ) const


code: virtual void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: void NotifyMetadataChanged ( const [FName](API\Runtime\Core\UObject\FName) & InName )


code: void NotifyMetadataTagChanged ( const [FName](API\Runtime\Core\UObject\FName) & InTag, bool bAdded )


code: [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) & operator= ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) & InOther )


code: bool RemoveMetadata ( const [FName](API\Runtime\Core\UObject\FName) & InName )


code: virtual void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: bool SetMetaData ( const [FName](API\Runtime\Core\UObject\FName) & InName, [ERigMetadataType](API\Plugins\ControlRig\Rigs\ERigMetadataType) InType, const void * InData, int32 InSize )


description: Sets up the metadata and ensures the right type

code: [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * SetupValidMetadata ( const [FName](API\Runtime\Core\UObject\FName) & InName, [ERigMetadataType](API\Plugins\ControlRig\Rigs\ERigMetadataType) InType )


code: FRigBaseElement ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) & InOther )


className: FRigBaseElement

CachedChildren

type: FRigBaseElement...

Key

type: FRigElementKey

Metadata

type: TArray<FRigBas...

MetadataChangedDelegate

type: FRigElementMeta...

MetadataNameToIndex

type: TMap<FName, in...

NameString

type: FString

OwnedInstances

description: Used for constructing / destructing the memory. typically == 1


className: FRigBaseElementParentArray

description: TypedefTArrayFRigBaseElementParentArray;

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) *, TInlineAllocator< 1 > > FRigBaseElementParentArray


className: FRigBaseElementChildrenArray

description: TypedefTArrayFRigBaseElementChildrenArray;

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) *, TInlineAllocator< 3 > > FRigBaseElementChildrenArray


code: static void DestroyMetadata ( [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) ** Metadata )


code: const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * GetElement() const


code: const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & GetKey() const


code: [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetMetadataStruct() const


code: static [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * GetMetadataStruct ( const [ERigMetadataType](API\Plugins\ControlRig\Rigs\ERigMetadataType) & InType )


code: const [FName](API\Runtime\Core\UObject\FName) & GetName() const


code: const [ERigMetadataType](API\Plugins\ControlRig\Rigs\ERigMetadataType) & GetType() const


code: const void * GetValueData() const


code: const [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * GetValueProperty() const


code: const int32 & GetValueSize() const


code: template<typename T> bool IsA() const


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: static [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * MakeMetadata ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement, const [FName](API\Runtime\Core\UObject\FName) & InName, [ERigMetadataType](API\Plugins\ControlRig\Rigs\ERigMetadataType) InType )


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


code: bool SetValueData ( const void * InData, int32 InSize )


code: virtual bool SetValueDataImpl ( const void * InData )


className: FRigBaseMetadata

Element

type: constFRigBaseE...

Type

type: ERigMetadataTyp...

ValueProperty

type: constFProperty...


code: virtual [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) GetElementType() const


code: virtual [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) GetParentElementKey ( bool bForce ) const


className: FRigBone

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigBone : public [FRigElement](API\Plugins\ControlRig\Rigs\FRigElement)

Dependents

type: TArray< int32 >

description: Dependent list - direct dependent for child or anything that needs to update due to this

InitialTransform

description: Initial global transform that is saved in this rig

Type

type: ERigBoneType

description: The source of the bone to differentiate procedurally generated, imported etc


code: virtual void CopyFrom ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InOtherHierarchy )


code: static bool IsClassOf ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement )


code: virtual void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: virtual void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & A, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: [FRigBone](API\Plugins\ControlRig\Rigs\FRigBone) & Add ( const [FName](API\Runtime\Core\UObject\FName) & InNewName, const [FName](API\Runtime\Core\UObject\FName) & InParentName, [ERigBoneType](API\Plugins\ControlRig\Rigs\ERigBoneType) InType, const FTransform & InInitTransform, const FTransform & InLocalTransform, const FTransform & InGlobalTransform )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigBone](API\Plugins\ControlRig\Rigs\FRigBone) >::RangedForConstIteratorType begin() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigBone](API\Plugins\ControlRig\Rigs\FRigBone) >::RangedForConstIteratorType end() const


code: [FRigBoneHierarchy](API\Plugins\ControlRig\Rigs\FRigBoneHierarchy) & operator= ( [FRigBoneHierarchy](API\Plugins\ControlRig\Rigs\FRigBoneHierarchy) && InOther )


code: [FRigBoneHierarchy](API\Plugins\ControlRig\Rigs\FRigBoneHierarchy) & operator= ( const [FRigBoneHierarchy](API\Plugins\ControlRig\Rigs\FRigBoneHierarchy) & InOther )


description: Pretty weird that this type is copy/move assignable (needed for USTRUCTs) but not copy/move constructible.

code: FRigBoneHierarchy ( [FRigBoneHierarchy](API\Plugins\ControlRig\Rigs\FRigBoneHierarchy) && InOther )


code: FRigBoneHierarchy ( const [FRigBoneHierarchy](API\Plugins\ControlRig\Rigs\FRigBoneHierarchy) & InOther )


code: const [TArray](API\Runtime\Core\Containers\TArray)< bool > & GetValue() const


code: [TArray](API\Runtime\Core\Containers\TArray)< bool > & GetValue()


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: bool SetValue ( const [TArray](API\Runtime\Core\Containers\TArray)< bool > & InValue )


code: virtual ~FRigBoolArrayMetadata()


className: FRigBoolArrayMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigBoolArrayMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

Value

type: TArray< bool >


code: bool SetValue ( const bool & InValue )


className: FRigBoolMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigBoolMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)


code: static bool Equals ( const FTransform & A, const FTransform & B, const float InTolerance )


code: void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool & bDirty )


code: bool operator== ( const [FRigComputedTransform](API\Plugins\ControlRig\Rigs\FRigComputedTransform) & Other ) const


code: void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool & bDirty )


code: void Set ( const FTransform & InTransform, bool & bDirty )


className: FRigComputedTransform


code: void ApplyLimits ( [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) & InOutValue ) const


code: static [FProperty](API\Runtime\CoreUObject\UObject\FProperty) * FindPropertyForValueType ( [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType )


code: const [FName](API\Runtime\Core\UObject\FName) & GetDisplayName() const


code: virtual [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) GetParentElementKey() const


code: virtual [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) GetSpaceElementKey() const


code: virtual [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) GetElementType() const


code: FTransform GetTransformFromValue ( [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const


code: const [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) & GetValue ( [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const


code: [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) & GetValue ( [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType )


code: void SetValueFromTransform ( const FTransform & InTransform, [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType )


className: FRigControl

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigControl : public [FRigElement](API\Plugins\ControlRig\Rigs\FRigElement)

bAnimatable

description: If the control is animatable in sequencer

bDrawLimits

description: True if the limits should be drawn in debug.

bGizmoEnabled

description: Set to true if the gizmo is enabled in 3d

bGizmoVisible

description: Set to true if the gizmo is currently visible in 3d

bIsCurve

description: If Created from a Curve Container

bIsTransientControl

description: If the control is transient and only visible in the control rig editor

bLimitRotation

description: True if the control has to obey rotation limits.

bLimitScale

description: True if the control has to obey scale limits.

bLimitTranslation

description: True if the control has to obey translation limits.

ControlEnum

type: TObjectPtr<UEn...

ControlType

type: ERigControlType

GizmoColor

type: FLinearColor

GizmoName

description: This is optional UI setting - this doesn't mean this is always used, but it is optional for manipulation layer to use this

InitialValue

type: FRigControlValu...

description: The value that a control is reset to during begin play or when the control rig is instantiated.

MaximumValue

description: The maximum limit of the control's value

MinimumValue

description: The minimum limit of the control's value

OffsetTransform

description: Used to offset a control in global space.

PrimaryAxis

type: ERigControlAxis

description: The primary axis to use for float controls

description: The current value of the control.


code: virtual void CopyPose ( [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, bool bCurrent, bool bInitial, bool bWeights )


code: virtual const [FName](API\Runtime\Core\UObject\FName) & GetDisplayName() const


code: bool IsAnimationChannel() const


code: static bool IsClassOf ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement )


code: virtual void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: virtual void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & A, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


className: FRigControlElementCustomization

AvailableSpaces

type: TArray<FRigEle...


className: FRigControlElement

Offset

type: FRigCurrentAndI...

PreferredEulerAngles

type: FRigPreferredEu...

Settings

type: FRigControlSett...


code: [FRigControl](API\Plugins\ControlRig\Rigs\FRigControl) & Add ( const [FName](API\Runtime\Core\UObject\FName) & InNewName, [ERigControlType](API\Plugins\ControlRig\Rigs\ERigControlType) InControlType, const [FName](API\Runtime\Core\UObject\FName) & InParentName, const [FName](API\Runtime\Core\UObject\FName) & InSpaceName, const FTransform & InOffsetTransform, const [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) & InValue, const [FName](API\Runtime\Core\UObject\FName) & InGizmoName, const FTransform & InGizmoTransform, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InGizmoColor )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigControl](API\Plugins\ControlRig\Rigs\FRigControl) >::RangedForConstIteratorType begin() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigControl](API\Plugins\ControlRig\Rigs\FRigControl) >::RangedForConstIteratorType end() const


code: [FRigControlHierarchy](API\Plugins\ControlRig\Rigs\FRigControlHierarchy) & operator= ( [FRigControlHierarchy](API\Plugins\ControlRig\Rigs\FRigControlHierarchy) && InOther )


code: [FRigControlHierarchy](API\Plugins\ControlRig\Rigs\FRigControlHierarchy) & operator= ( const [FRigControlHierarchy](API\Plugins\ControlRig\Rigs\FRigControlHierarchy) & InOther )


code: FRigControlHierarchy ( [FRigControlHierarchy](API\Plugins\ControlRig\Rigs\FRigControlHierarchy) && InOther )


code: FRigControlHierarchy ( const [FRigControlHierarchy](API\Plugins\ControlRig\Rigs\FRigControlHierarchy) & InOther )


code: template<typename T> T Apply ( const T & InValue, const T & InMinimum, const T & InMaximum ) const


code: bool GetForValueType ( [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const


code: bool operator== ( const [FRigControlLimitEnabled](API\Plugins\ControlRig\Rigs\FRigControlLimitEnabled) & Other ) const


code: bool operator!= ( const [FRigControlLimitEnabled](API\Plugins\ControlRig\Rigs\FRigControlLimitEnabled) & Other ) const


code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: [FRigControlLimitEnabled](API\Plugins\ControlRig\Rigs\FRigControlLimitEnabled) & Set ( bool InValue )


code: [FRigControlLimitEnabled](API\Plugins\ControlRig\Rigs\FRigControlLimitEnabled) & Set ( bool InMinimum, bool InMaximum )


code: void SetForValueType ( [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType, bool InValue )


code: FRigControlLimitEnabled ( bool InValue )


code: FRigControlLimitEnabled ( bool InMinimum, bool InMaximum )


className: FRigControlLimitEnabled

bMaximum

type: bool


code: FRigControlModifiedContext ( [EControlRigSetKey](API\Plugins\ControlRig\Rigs\EControlRigSetKey) InSetKey )


code: FRigControlModifiedContext ( [EControlRigSetKey](API\Plugins\ControlRig\Rigs\EControlRigSetKey) InSetKey, float InLocalTime, const [FName](API\Runtime\Core\UObject\FName) & InEventName, [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) InKeyMask )


className: FRigControlModifiedContext

EventName

type: FName

LocalTime

type: float

SetKey

type: EControlRigSetK...


description: Applies the limits expressed by these settings to a transform

code: void ApplyLimits ( FTransform & InOutValue ) const


description: Applies the limits expressed by these settings to a value

code: void ApplyLimits ( [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) & InOutValue ) const


description: The euler rotation order this control prefers for animation if it is active. If not set then we use the default UE rotator.

code: [TOptional](API\Runtime\Core\IO\TOptional)< EEulerRotationOrder > GetRotationOrder() const


code: bool IsSelectable ( bool bRespectVisibility ) const


code: void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: bool operator== ( const [FRigControlSettings](API\Plugins\ControlRig\Rigs\FRigControlSettings) & InOther ) const


code: bool operator!= ( const [FRigControlSettings](API\Plugins\ControlRig\Rigs\FRigControlSettings) & InOther ) const


code: void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void SetAnimationTypeFromDeprecatedData ( bool bAnimatable, bool bShapeEnabled )


description: Set the rotation order if the rotation is set otherwise use default rotator

code: void SetRotationOrder ( const [TOptional](API\Runtime\Core\IO\TOptional)< EEulerRotationOrder > & EulerRotation )


code: void SetupLimitArrayForType ( bool bLimitTranslation, bool bLimitRotation, bool bLimitScale )


code: bool SetVisible ( bool bVisible, bool bForce )


className: FRigControlSettings

AnimationType

type: ERigControlAnim...

bDrawLimits

description: True if the limits should be drawn in debug.

bGroupWithParentControl

description: If set to true the animation channel will be grouped with the parent control in sequencer

bIsCurve

description: If Created from a Curve Container

bRestrictSpaceSwitching

description: Allow to space switch only to the available spaces

bShapeVisible

description: Set to true if the shape is currently visible in 3d

bUsePreferredRotationOrder

description: Whether to use a specfied rotation order or just use the default FRotator order and conversion functions

ControlEnum

description: If the control is 4transient and only visible in the control rig editor

Customization

type: FRigControlElem...

description: The User interface customization used for a control This will be used as the default content for the space picker and other widgets

DrivenControls

description: The list of driven controls for this proxy control.

FilteredChannels

type: TArray<ERigCon...

description: Filtered Visible Transform channels. If this is empty everything is visible

LimitEnabled

type: TArray<FRigCon...

description: True if the control has limits.

PreferredRotationOrder

type: EEulerRotationO...

description: The euler rotation order this control prefers for animation, if we aren't using default UE rotator

PreviouslyDrivenControls

description: The list of previously driven controls - prior to a procedural change

ShapeVisibility

type: ERigControlVisi...

description: Defines how the shape visibility should be changed


code: void ApplyLimits ( const [TArray](API\Runtime\Core\Containers\TArray)< [FRigControlLimitEnabled](API\Plugins\ControlRig\Rigs\FRigControlLimitEnabled) > & LimitEnabled, [ERigControlType](API\Plugins\ControlRig\Rigs\ERigControlType) InControlType, const [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) & InMinimumValue, const [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) & InMaximumValue )


code: FRotator GetRotator&40;&41; const


code: FVector3f GetScale3D&40;&41; const


code: FVector3f GetTranslation&40;&41; const


code: FEulerTransform_Float &40; const FEulerTransform & InTransform &41;


code: struct FEulerTransform_Float


code: FQuat GetRotation&40;&41; const


code: FTransformNoScale_Float &40; const FTransformNoScale & InTransform &41;


code: struct FTransformNoScale_Float


code: FTransform ToTransform&40;&41; const


code: FTransform_Float &40; const FTransform & InTransform &41;


code: struct FTransform_Float


code: template<class T> T Get() const


description: We disable all of these to force Control Rig to store values as floats. We've added our own float variations purely for storage purposes, from which we'll cast back and forth to FTransform etc.

code: template<> const FVector2D Get() const


code: template<> const FVector Get() const


code: template<> const FVector4 Get() const


code: template<> const FRotator Get() const


code: template<> const FQuat Get() const


code: template<> const FTransform Get() const


code: template<> const [FTransformNoScale](API\Runtime\AnimationCore\FTransformNoScale) Get() const


code: template<> const [FEulerTransform](API\Runtime\AnimationCore\FEulerTransform) Get() const


code: FTransform GetAsTransform ( [ERigControlType](API\Plugins\ControlRig\Rigs\ERigControlType) InControlType, [ERigControlAxis](API\Plugins\ControlRig\Rigs\ERigControlAxis) InPrimaryAxis ) const


code: template<class T> T & GetRef()


code: template<> FRotator & GetRef()


code: template<> const FQuat & GetRef() const


code: template<> const FTransform & GetRef() const


code: template<> FTransform & GetRef()


code: template<> const [FTransformNoScale](API\Runtime\AnimationCore\FTransformNoScale) & GetRef() const


code: template<> [FTransformNoScale](API\Runtime\AnimationCore\FTransformNoScale) & GetRef()


code: template<> const [FEulerTransform](API\Runtime\AnimationCore\FEulerTransform) & GetRef() const


code: template<> [FEulerTransform](API\Runtime\AnimationCore\FEulerTransform) & GetRef()


code: template<class T> const T & GetRef() const


code: template<> const FVector2D & GetRef() const


code: template<> FVector2D & GetRef()


code: template<> const FVector & GetRef() const


code: template<> const FVector4 & GetRef() const


code: template<> FVector4 & GetRef()


code: template<> const FRotator & GetRef() const


code: template<> [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) Make ( FVector2D InValue )


code: template<> [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) Make ( FVector InValue )


code: template<> [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) Make ( FRotator InValue )


code: template<> [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) Make ( FTransform InValue )


code: template<> [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) Make ( [FTransformNoScale](API\Runtime\AnimationCore\FTransformNoScale) InValue )


code: template<> [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) Make ( [FEulerTransform](API\Runtime\AnimationCore\FEulerTransform) InValue )


code: template<class T> static [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) Make ( T InValue )


code: template<class T> void Set ( T InValue )


code: template<> void Set ( FVector InValue )


code: template<> void Set ( FVector4 InValue )


code: template<> void Set ( FQuat InValue )


code: template<> void Set ( FRotator InValue )


code: template<> void Set ( FTransform InValue )


code: template<> void Set ( FVector2D InValue )


code: template<> void Set ( [FTransformNoScale](API\Runtime\AnimationCore\FTransformNoScale) InValue )


code: template<> void Set ( [FEulerTransform](API\Runtime\AnimationCore\FEulerTransform) InValue )


code: template<class T> T SetFromString ( const [FString](API\Runtime\Core\Containers\FString) & InString )


code: template<> FVector SetFromString ( const [FString](API\Runtime\Core\Containers\FString) & InString )


code: template<> FQuat SetFromString ( const [FString](API\Runtime\Core\Containers\FString) & InString )


code: template<> FRotator SetFromString ( const [FString](API\Runtime\Core\Containers\FString) & InString )


code: template<> FTransform SetFromString ( const [FString](API\Runtime\Core\Containers\FString) & InString )


code: template<> [FTransformNoScale](API\Runtime\AnimationCore\FTransformNoScale) SetFromString ( const [FString](API\Runtime\Core\Containers\FString) & InString )


code: template<> [FEulerTransform](API\Runtime\AnimationCore\FEulerTransform) SetFromString ( const [FString](API\Runtime\Core\Containers\FString) & InString )


code: void SetFromTransform ( const FTransform & InTransform, [ERigControlType](API\Plugins\ControlRig\Rigs\ERigControlType) InControlType, [ERigControlAxis](API\Plugins\ControlRig\Rigs\ERigControlAxis) InPrimaryAxis )


code: [FString](API\Runtime\Core\Containers\FString) ToPythonString ( [ERigControlType](API\Plugins\ControlRig\Rigs\ERigControlType) InControlType ) const


code: template<class T> [FString](API\Runtime\Core\Containers\FString) ToString() const


code: template<> [FString](API\Runtime\Core\Containers\FString) ToString() const


className: FRigControlValueStorage


code: const FTransform & Get ( const [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType ) const


code: bool & GetDirtyFlag ( const [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType )


code: const bool & GetDirtyFlag ( const [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType ) const


code: bool IsDirty ( const [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType ) const


code: void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void MarkDirty ( const [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType )


code: bool operator== ( const [FRigCurrentAndInitialTransform](API\Plugins\ControlRig\Rigs\FRigCurrentAndInitialTransform) & Other ) const


code: const [FRigComputedTransform](API\Plugins\ControlRig\Rigs\FRigComputedTransform) & operator[] ( const [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType ) const


code: [FRigComputedTransform](API\Plugins\ControlRig\Rigs\FRigComputedTransform) & operator[] ( const [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType )


code: void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void Set ( const [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType, const FTransform & InTransform )


code: FRigCurrentAndInitialTransform()


className: FRigCurrentAndInitialTransform

Current

type: FRigLocalAndGlo...


code: virtual [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) GetElementType() const


className: FRigCurve

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigCurve : public [FRigElement](API\Plugins\ControlRig\Rigs\FRigElement)


code: [FRigCurve](API\Plugins\ControlRig\Rigs\FRigCurve) & Add ( const [FName](API\Runtime\Core\UObject\FName) & InNewName, float InValue )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigCurve](API\Plugins\ControlRig\Rigs\FRigCurve) >::RangedForConstIteratorType begin() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigCurve](API\Plugins\ControlRig\Rigs\FRigCurve) >::RangedForConstIteratorType end() const


code: [FRigCurveContainer](API\Plugins\ControlRig\Rigs\FRigCurveContainer) & operator= ( [FRigCurveContainer](API\Plugins\ControlRig\Rigs\FRigCurveContainer) && InOther )


code: [FRigCurveContainer](API\Plugins\ControlRig\Rigs\FRigCurveContainer) & operator= ( const [FRigCurveContainer](API\Plugins\ControlRig\Rigs\FRigCurveContainer) & InOther )


description: Pretty weird that this type is copy/move assignable (needed for USTRUCTs) but not copy/move constructible.

code: FRigCurveContainer ( [FRigCurveContainer](API\Plugins\ControlRig\Rigs\FRigCurveContainer) && InOther )


code: FRigCurveContainer ( const [FRigCurveContainer](API\Plugins\ControlRig\Rigs\FRigCurveContainer) & InOther )


code: static bool IsClassOf ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement )


code: virtual void CopyPose ( [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, bool bCurrent, bool bInitial, bool bWeights )


code: virtual void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: virtual void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & A, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


className: FRigCurveElement

bIsValueSet

description: Set to true if the value was actually set.


code: const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * Get() const


code: template<typename T> T * Get()


code: template<typename T> const T * Get() const


code: template<typename T> T * GetChecked()


code: template<typename T> const T * GetChecked() const


code: const [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * GetHierarchy() const


code: const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & GetKey() const


className: FRigElementHandle::operator bool

code: operator bool() const


code: FRigElementHandle ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


code: FRigElementHandle ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement )


className: FRigElementHandle

code: struct FRigElementHandle


code: bool IsTypeOf ( [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) InElementType ) const


code: void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


className: FRigElementKey::operator bool


code: bool operator== ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & Other ) const


code: bool operator> ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & Other ) const


code: bool operator< ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & Other ) const


code: bool operator!= ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & Other ) const


code: void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: FRigElementKey ( const [FName](API\Runtime\Core\UObject\FName) & InName, [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) InType )


className: FRigElementKey

Type

type: ERigElementType


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) > & GetValue() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) > & GetValue()


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


code: bool SetValue ( const [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) > & InValue )


code: virtual ~FRigElementKeyArrayMetadata()


code: int32 Add ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


className: FRigElementKeyArrayMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigElementKeyArrayMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)


code: int32 AddUnique ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) >::RangedForConstIteratorType begin() const


code: bool Contains ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


description: Resets the data structure and removes all storage.

code: void Empty()


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) >::RangedForConstIteratorType end() const


description: Filters a collection by element type

code: [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) FilterByType ( uint8 InElementTypes ) const


description: Filters a collection by name

code: [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) FilterByName ( const [FName](API\Runtime\Core\UObject\FName) & InPartialName ) const


description: Returns the first element of this collection.

code: const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & First() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) > & GetKeys() const


description: Returns true if this collection contains no elements.

code: bool IsEmpty() const


description: Returns true if a given instruction index is valid.

code: bool IsValidIndex ( int32 InIndex ) const


description: Returns the last element of this collection.

code: const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & Last() const


description: Returns the difference between two collections

code: static [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) MakeDifference ( const [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) & A, const [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) & B )


description: Creates a collection containing all of the children of a given

code: static [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) MakeFromChildren ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InParentKey, bool bRecursive, bool bIncludeParent, uint8 InElementTypes )


description: Creates a collection containing an item chain

code: static [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) MakeFromChain ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InFirstItem, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InLastItem, bool bReverse )


description: Creates a collection containing all keys of a hierarchy

code: static [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) MakeFromCompleteHierarchy ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, uint8 InElementTypes )


description: Returns the collection in the reverse order

code: static [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) MakeReversed ( const [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) & InCollection )


description: Creates a collection containing all of the elements with a given name

code: static [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) MakeFromName ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, const [FName](API\Runtime\Core\UObject\FName) & InPartialName, uint8 InElementTypes )


description: Returns the intersection between two collections

code: static [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) MakeIntersection ( const [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) & A, const [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) & B )


description: Returns the union between two collections

code: static [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) MakeUnion ( const [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) & A, const [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) & B, bool bAllowDuplicates )


description: Returns the number of elements in this collection.

code: int32 Num() const


description: Resets the data structure and maintains all storage.

code: void Reset()


description: Const accessor for an element given its index

code: const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & operator[] ( int32 InIndex ) const


code: FRigElementKeyCollection ( const [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) > & InKeys )


className: FRigElementKeyCollection


code: const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & GetValue() const


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


code: bool SetValue ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InValue )


code: virtual ~FRigElementKeyMetadata()


className: FRigElementMetadataChangedDelegate

code: typedef TBaseDelegate_TwoParams< void, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) &, const [FName](API\Runtime\Core\UObject\FName) & > FRigElementMetadataChangedDelegate


className: FRigElementKeyMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigElementKeyMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

Value

type: FRigElementKey


className: FRigElementMetadataTagChangedDelegate

code: typedef TBaseDelegate_ThreeParams< void, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) &, const [FName](API\Runtime\Core\UObject\FName) &, bool > FRigElementMetadataTagChangedDelegate


code: void CopyPose ( const [FRigElementParentConstraint](API\Plugins\ControlRig\Rigs\FRigElementParentConstraint) & InOther, bool bCurrent, bool bInitial )


code: const [FRigElementWeight](API\Plugins\ControlRig\Rigs\FRigElementWeight) & GetWeight ( bool bInitial ) const


className: FRigElementParentConstraint

Cache

type: FRigComputedTra...

InitialWeight

type: FRigElementWeig...

ParentElement

type: FRigTransformEl...


className: FRigElementParentConstraintArray

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementParentConstraint](API\Plugins\ControlRig\Rigs\FRigElementParentConstraint), TInlineAllocator< 1 > > FRigElementParentConstraintArray


code: namespace FRigElementTypeHelper { static uint32 FRigElementTypeHelper::Add ( uint32 InMasks, [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) InType ) }


code: namespace FRigElementTypeHelper { static bool FRigElementTypeHelper::DoesHave ( uint32 InMasks, [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) InType ) }


code: namespace FRigElementTypeHelper { static uint32 FRigElementTypeHelper::Remove ( uint32 InMasks, [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) InType ) }


code: namespace FRigElementTypeHelper { static uint32 FRigElementTypeHelper::ToMask ( [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) InType ) }


code: FRigElementWeight ( float InWeight )


code: FRigElementWeight ( float InLocation, float InRotation, float InScale )


className: FRigElementWeight


className: FRigEventContext

Event

type: ERigEvent

Payload

type: void *


className: FRigEventDelegate

code: typedef TMulticastDelegate_TwoParams< void, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) *, const [FRigEventContext](API\Plugins\ControlRig\Rigs\FRigEventContext) & > FRigEventDelegate


code: const [TArray](API\Runtime\Core\Containers\TArray)< float > & GetValue() const


code: [TArray](API\Runtime\Core\Containers\TArray)< float > & GetValue()


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


code: bool SetValue ( const [TArray](API\Runtime\Core\Containers\TArray)< float > & InValue )


code: virtual ~FRigFloatArrayMetadata()


className: FRigFloatArrayMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigFloatArrayMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

Value

type: TArray< float >


code: const float & GetValue() const


code: bool SetValue ( const float & InValue )


className: FRigFloatMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigFloatMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

type: float


code: [FRigHierarchyContainer](API\Plugins\ControlRig\Rigs\FRigHierarchyContainer) & operator= ( const [FRigHierarchyContainer](API\Plugins\ControlRig\Rigs\FRigHierarchyContainer) & InOther )


code: FRigHierarchyContainer ( const [FRigHierarchyContainer](API\Plugins\ControlRig\Rigs\FRigHierarchyContainer) & InOther )


className: FRigHierarchyContainer

BoneHierarchy

type: FRigBoneHierarc...

ControlHierarchy

type: FRigControlHier...

CurveContainer

type: FRigCurveContai...

SpaceHierarchy

type: FRigSpaceHierar...


code: FRigHierarchyControllerInstructionBracket ( [URigHierarchyController](API\Plugins\ControlRig\Rigs\URigHierarchyController) * InController, int32 InInstructionIndex )


code: class FRigHierarchyControllerInstructionBracket : private [TGuardValue< int32 >](API\Runtime\Core\Templates\TGuardValue)


className: FRigHierarchyCopyPasteContent

Contents

type: TArray<FString...

Elements

type: TArray<FRigHie...

GlobalTransforms

type: TArray< FTransf...

Types

type: TArray<ERigEle...

description: Maintain properties below for backwards compatibility pre-5.0.


className: FRigHierarchyCopyPasteContentPerElement

Content

type: FString

Parents

type: TArray<FRigEle...

Pose

type: FRigCurrentAndI...


className: FRigHierarchyEnableControllerBracket

description: No constructors are accessible with public or protected access.


className: FRigHierarchyExecuteContextBracket

description: No destructors are accessible with public or protected access.


code: FRigHierarchyGlobalValidityBracket ( bool bEnable )


className: FRigHierarchyGlobalValidityBracket


code: FRigHierarchyInteractionBracket ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy )


code: ~FRigHierarchyInteractionBracket()


className: FRigHierarchyInteractionBracket

code: struct FRigHierarchyInteractionBracket


code: FRigHierarchyListenerGuard ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, bool bInEnableInitialChanges, bool bInEnableCurrentChanges, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InListeningHierarchy )


className: FRigHierarchyListenerGuard

code: class FRigHierarchyListenerGuard


code: ~FRigHierarchyGlobalValidityBracket()


className: FRigHierarchyMetadataChangedDelegate

code: typedef TMulticastDelegate_TwoParams< void, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) &, const [FName](API\Runtime\Core\UObject\FName) & > FRigHierarchyMetadataChangedDelegate


className: FRigHierarchyModifiedDynamicEvent

code: class FRigHierarchyModifiedDynamicEvent


className: FRigHierarchyMetadataTagChangedDelegate

code: typedef TMulticastDelegate_ThreeParams< void, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) &, const [FName](API\Runtime\Core\UObject\FName) &, bool > FRigHierarchyMetadataTagChangedDelegate


className: FRigHierarchyModifiedEvent

code: typedef TMulticastDelegate_ThreeParams< void, [ERigHierarchyNotification](API\Plugins\ControlRig\Rigs\ERigHierarchyNotification), [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) *, const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * > FRigHierarchyModifiedEvent


className: FRigHierarchyRef

description: This struct is still here for backwards compatibility - but not used anywhere


className: FRigHierarchyUndoRedoTransformEvent

code: class FRigHierarchyUndoRedoTransformEvent : public TBaseMulticastDelegate_FiveParams< void, URigHierarchy *, const FRigElementKey &, ERigTransformType::Type, const FTransform &, bool >


code: FRigHierarchyValidityBracket ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy )


code: ~FRigHierarchyValidityBracket()


code: int32 AddUnique ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


className: FRigHierarchyValidityBracket

code: struct FRigHierarchyValidityBracket


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) >::RangedForConstIteratorType begin() const


code: bool Contains ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) >::RangedForConstIteratorType end() const


code: const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & GetSource() const


code: bool Merge ( const [FRigInfluenceEntry](API\Plugins\ControlRig\Rigs\FRigInfluenceEntry) & Other )


code: void OnKeyRemoved ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


code: void OnKeyRenamed ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InOldKey, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InNewKey )


code: const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & operator[] ( int32 InIndex ) const


code: [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & operator[] ( int32 InIndex )


code: void Remove ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


className: FRigInfluenceEntry

Source

type: FRigElementKey


className: FRigInfluenceEntryModifier


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigInfluenceEntry](API\Plugins\ControlRig\Rigs\FRigInfluenceEntry) >::RangedForConstIteratorType begin() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigInfluenceEntry](API\Plugins\ControlRig\Rigs\FRigInfluenceEntry) >::RangedForConstIteratorType end() const


code: const [FRigInfluenceEntry](API\Plugins\ControlRig\Rigs\FRigInfluenceEntry) * Find ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: [FRigInfluenceEntry](API\Plugins\ControlRig\Rigs\FRigInfluenceEntry) & FindOrAdd ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


code: [FRigInfluenceEntryModifier](API\Plugins\ControlRig\Rigs\FRigInfluenceEntryModifier) GetEntryModifier ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: const [FName](API\Runtime\Core\UObject\FName) & GetEventName() const


code: int32 GetIndex ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: bool Merge ( const [FRigInfluenceMap](API\Plugins\ControlRig\Rigs\FRigInfluenceMap) & Other, bool bIgnoreEventName )


code: bool Merge ( const [FRigInfluenceMap](API\Plugins\ControlRig\Rigs\FRigInfluenceMap) & Other )


code: const [FRigInfluenceEntry](API\Plugins\ControlRig\Rigs\FRigInfluenceEntry) & operator[] ( int32 InIndex ) const


code: [FRigInfluenceEntry](API\Plugins\ControlRig\Rigs\FRigInfluenceEntry) & operator[] ( int32 InIndex )


code: const [FRigInfluenceEntry](API\Plugins\ControlRig\Rigs\FRigInfluenceEntry) & operator[] ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: [FRigInfluenceEntry](API\Plugins\ControlRig\Rigs\FRigInfluenceEntry) & operator[] ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


code: void SetEntryModifier ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey, const [FRigInfluenceEntryModifier](API\Plugins\ControlRig\Rigs\FRigInfluenceEntryModifier) & InModifier )


className: FRigInfluenceMap

Entries

type: TArray<FRigInf...

EventName

type: FName

KeyToIndex

type: TMap<FRigEleme...


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigInfluenceMap](API\Plugins\ControlRig\Rigs\FRigInfluenceMap) >::RangedForConstIteratorType begin() const


code: bool Contains ( const [FName](API\Runtime\Core\UObject\FName) & InEventName ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigInfluenceMap](API\Plugins\ControlRig\Rigs\FRigInfluenceMap) >::RangedForConstIteratorType end() const


code: const [FRigInfluenceMap](API\Plugins\ControlRig\Rigs\FRigInfluenceMap) * Find ( const [FName](API\Runtime\Core\UObject\FName) & InEventName ) const


code: [FRigInfluenceEntryModifier](API\Plugins\ControlRig\Rigs\FRigInfluenceEntryModifier) GetEntryModifier ( const [FName](API\Runtime\Core\UObject\FName) & InEventName, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: int32 GetIndex ( const [FName](API\Runtime\Core\UObject\FName) & InEventName ) const


code: [FRigInfluenceMap](API\Plugins\ControlRig\Rigs\FRigInfluenceMap) & FindOrAdd ( const [FName](API\Runtime\Core\UObject\FName) & InEventName )


code: bool Merge ( const [FRigInfluenceMapPerEvent](API\Plugins\ControlRig\Rigs\FRigInfluenceMapPerEvent) & Other )


code: void OnKeyRemoved ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


code: void OnKeyRenamed ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InOldKey, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InNewKey )


code: [FRigInfluenceMap](API\Plugins\ControlRig\Rigs\FRigInfluenceMap) & operator[] ( int32 InIndex )


code: const [FRigInfluenceMap](API\Plugins\ControlRig\Rigs\FRigInfluenceMap) & operator[] ( int32 InIndex ) const


code: const [FRigInfluenceMap](API\Plugins\ControlRig\Rigs\FRigInfluenceMap) & operator[] ( const [FName](API\Runtime\Core\UObject\FName) & InEventName ) const


code: [FRigInfluenceMap](API\Plugins\ControlRig\Rigs\FRigInfluenceMap) & operator[] ( const [FName](API\Runtime\Core\UObject\FName) & InEventName )


code: void Remove ( const [FName](API\Runtime\Core\UObject\FName) & InEventName )


code: void SetEntryModifier ( const [FName](API\Runtime\Core\UObject\FName) & InEventName, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey, const [FRigInfluenceEntryModifier](API\Plugins\ControlRig\Rigs\FRigInfluenceEntryModifier) & InModifier )


className: FRigInfluenceMapPerEvent

EventToIndex

type: TMap<FName, in...


code: const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & GetValue() const


code: [TArray](API\Runtime\Core\Containers\TArray)< int32 > & GetValue()


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


code: bool SetValue ( const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & InValue )


code: virtual ~FRigInt32ArrayMetadata()


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigInt32ArrayMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

Value

type: TArray< int32 >


code: const int32 & GetValue() const


code: bool SetValue ( const int32 & InValue )


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigInt32Metadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > & GetValue() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > & GetValue()


code: bool SetValue ( const [TArray](API\Runtime\Core\Containers\TArray)< [FLinearColor](API\Runtime\Core\Math\FLinearColor) > & InValue )


code: FRigLinearColorArrayMetadata()


code: virtual ~FRigLinearColorArrayMetadata()


className: FRigLinearColorArrayMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigLinearColorArrayMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

type: TArray<FLinear...


code: const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & GetValue() const


code: bool SetValue ( const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & InValue )


code: virtual ~FRigLinearColorMetadata()


className: FRigLinearColorMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigLinearColorMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

type: FLinearColor


code: void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


className: EDirty

code: enum EDirty { ELocal = 0, EGlobal, EDirtyMax, }


code: void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


className: FRigLocalAndGlobalTransform

bDirty

type: bool[FRigLocalA...

Global

type: FRigComputedTra...


description: Helper function to be called as part ofURigHierarchy::CopyHierarchy

code: virtual void CopyFrom ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InOtherHierarchy )


code: virtual void CopyPose ( [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, bool bCurrent, bool bInitial, bool bWeights )


code: static bool IsClassOf ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement )


code: virtual ~FRigMultiParentElement()


code: virtual void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: virtual void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & A, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


className: FRigMultiParentElement

ParentConstraints

type: FRigElementPare...


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & GetValue() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & GetValue()


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


code: bool SetValue ( const [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > & InValue )


code: virtual ~FRigNameArrayMetadata()


className: FRigNameArrayMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigNameArrayMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

Value

type: TArray<FName>


code: const [FName](API\Runtime\Core\UObject\FName) & GetValue() const


code: bool SetValue ( const [FName](API\Runtime\Core\UObject\FName) & InValue )


className: FRigNameMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigNameMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigPoseElement](API\Plugins\ControlRig\Rigs\FRigPoseElement) >::RangedForConstIteratorType begin() const


code: bool Contains ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigPoseElement](API\Plugins\ControlRig\Rigs\FRigPoseElement) >::RangedForConstIteratorType end() const


code: bool IsValidIndex ( int32 InIndex ) const


code: int32 GetIndex ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: const [FRigPoseElement](API\Plugins\ControlRig\Rigs\FRigPoseElement) & operator[] ( int32 InIndex ) const


code: [FRigPoseElement](API\Plugins\ControlRig\Rigs\FRigPoseElement) & operator[] ( int32 InIndex )


className: FRigPoseElement

CurveValue

type: float

GlobalTransform

type: FTransform

Index

type: FCachedRigEleme...


className: DefaultRotationOrder

code: static constexpr EEulerRotationOrder DefaultRotationOrder = EEulerRotationOrder::YZX;


code: FVector & Get ( bool bInitial )


code: const FVector & Get ( bool bInitial ) const


code: FVector GetAngles ( bool bInitial, EEulerRotationOrder InRotationOrder ) const


code: FQuat GetQuatFromRotator ( const FRotator & InRotator ) const


code: FRotator GetRotator ( bool bInitial ) const


code: void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: FRotator GetRotatorFromQuat ( const FQuat & InQuat ) const


code: bool operator== ( const [FRigPreferredEulerAngles](API\Plugins\ControlRig\Rigs\FRigPreferredEulerAngles) & Other ) const


code: void SetAngles ( const FVector & InValue, bool bInitial, EEulerRotationOrder InRotationOrder, bool bFixEulerFlips )


code: void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: FRotator SetRotator ( const FRotator & InValue, bool bInitial, bool bFixEulerFlips )


code: void SetRotationOrder ( EEulerRotationOrder InRotationOrder )


className: FRigPreferredEulerAngles

Current

type: FVector

RotationOrder

type: EEulerRotationO...


code: const [TArray](API\Runtime\Core\Containers\TArray)< FQuat > & GetValue() const


code: [TArray](API\Runtime\Core\Containers\TArray)< FQuat > & GetValue()


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


code: bool SetValue ( const [TArray](API\Runtime\Core\Containers\TArray)< FQuat > & InValue )


code: virtual ~FRigQuatArrayMetadata()


className: FRigQuatArrayMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigQuatArrayMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

Value

type: TArray< FQuat >


code: const FQuat & GetValue() const


code: bool SetValue ( const FQuat & InValue )


className: FRigQuatMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigQuatMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

type: FQuat


code: virtual void CopyFrom ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InOtherHierarchy )


code: virtual void CopyPose ( [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, bool bCurrent, bool bInitial, bool bWeights )


code: FTransform GetReferenceWorldTransform ( const [FRigVMExecuteContext](API\Plugins\RigVM\RigVMCore\FRigVMExecuteContext) * InContext, bool bInitial ) const


code: static bool IsClassOf ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement )


code: virtual void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: virtual void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & A, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: virtual ~FRigReferenceElement()


className: FRigReferenceElement

GetWorldTransformDelegate

type: FRigReferenceGe...


className: FRigReferenceGetWorldTransformDelegate

code: typedef TBaseDelegate_ThreeParams< FTransform, const [FRigVMExecuteContext](API\Plugins\RigVM\RigVMCore\FRigVMExecuteContext) *, const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) &, bool > FRigReferenceGetWorldTransformDelegate


className: FRigRigidBodyElement

Settings

type: FRigRigidBodySe...


code: virtual ~FRigRigidBodyElement()


code: void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: const [TArray](API\Runtime\Core\Containers\TArray)< FRotator > & GetValue() const


code: [TArray](API\Runtime\Core\Containers\TArray)< FRotator > & GetValue()


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: bool SetValue ( const [TArray](API\Runtime\Core\Containers\TArray)< FRotator > & InValue )


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


code: virtual ~FRigRotatorArrayMetadata()


className: FRigRotatorArrayMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigRotatorArrayMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

Value

type: TArray< FRotato...


code: const FRotator & GetValue() const


code: bool SetValue ( const FRotator & InValue )


className: FRigRotatorMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigRotatorMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

type: FRotator


code: virtual ~FRigRotatorMetadata()


code: virtual void CopyFrom ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InOtherHierarchy )


code: static bool IsClassOf ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement )


code: virtual void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: virtual void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & A, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: virtual ~FRigSingleParentElement()


code: virtual [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) GetElementType() const


className: FRigSingleParentElement

ParentElement

type: FRigTransformEl...


code: virtual [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) GetParentElementKey() const


className: FRigSpace

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigSpace : public [FRigElement](API\Plugins\ControlRig\Rigs\FRigElement)

ParentName

type: FName

SpaceType

type: ERigSpaceType


code: [FRigSpace](API\Plugins\ControlRig\Rigs\FRigSpace) & Add ( const [FName](API\Runtime\Core\UObject\FName) & InNewName, [ERigSpaceType](API\Plugins\ControlRig\Rigs\ERigSpaceType) InSpaceType, const [FName](API\Runtime\Core\UObject\FName) & InParentName, const FTransform & InTransform )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigSpace](API\Plugins\ControlRig\Rigs\FRigSpace) >::RangedForConstIteratorType begin() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigSpace](API\Plugins\ControlRig\Rigs\FRigSpace) >::RangedForConstIteratorType end() const


code: [FRigSpaceHierarchy](API\Plugins\ControlRig\Rigs\FRigSpaceHierarchy) & operator= ( [FRigSpaceHierarchy](API\Plugins\ControlRig\Rigs\FRigSpaceHierarchy) && InOther )


code: [FRigSpaceHierarchy](API\Plugins\ControlRig\Rigs\FRigSpaceHierarchy) & operator= ( const [FRigSpaceHierarchy](API\Plugins\ControlRig\Rigs\FRigSpaceHierarchy) & InOther )


description: Pretty weird that this type is copy/move assignable (needed for USTRUCTs) but not copy/move constructible.

code: FRigSpaceHierarchy ( [FRigSpaceHierarchy](API\Plugins\ControlRig\Rigs\FRigSpaceHierarchy) && InOther )


code: FRigSpaceHierarchy ( const [FRigSpaceHierarchy](API\Plugins\ControlRig\Rigs\FRigSpaceHierarchy) & InOther )


code: const [TArray](API\Runtime\Core\Containers\TArray)< FTransform > & GetValue() const


code: [TArray](API\Runtime\Core\Containers\TArray)< FTransform > & GetValue()


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: bool SetValue ( const [TArray](API\Runtime\Core\Containers\TArray)< FTransform > & InValue )


className: FRigTransformArrayMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigTransformArrayMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

Value

type: TArray< FTransf...


code: virtual void CopyFrom ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InOtherHierarchy )


code: virtual void CopyPose ( [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InOther, bool bCurrent, bool bInitial, bool bWeights )


code: virtual ~FRigTransformArrayMetadata()


className: FElementsToDirtyArray

description: Typedef TArrayFElementsToDirtyArray;

code: typedef [TArray](API\Runtime\Core\Containers\TArray)< [FElementToDirty](API\Plugins\ControlRig\Rigs\FRigTransformElement\FElementToDirty), TInlineAllocator< 3 > > FElementsToDirtyArray


code: bool operator&61;&61; &40; const FElementToDirty & Other &41; const


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


code: bool operator&33;&61; &40; const FElementToDirty & Other &41; const


code: FElementToDirty &40; FRigTransformElement &42; InElement, int32 InHierarchyDistance &41;


className: FElementToDirty

code: struct FElementToDirty


code: static bool IsClassOf ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement )


code: virtual void Save ( [FArchive](API\Runtime\Core\Serialization\FArchive) & A, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: virtual void Load ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * Hierarchy, [ESerializationPhase](API\Plugins\ControlRig\Rigs\FRigBaseElement\ESerializationPhase) SerializationPhase )


code: virtual ~FRigTransformElement()


className: FRigTransformElement

ElementsToDirty

type: FElementsToDirt...

Pose

type: FRigCurrentAndI...


code: const FTransform & GetValue() const


code: static bool IsClassOf ( const [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata) * InMetadata )


code: bool SetValue ( const FTransform & InValue )


code: virtual ~FRigTransformMetadata()


className: FRigTransformMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigTransformMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)


code: FRigTransformStackEntry ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey, [ERigTransformStackEntryType](API\Plugins\ControlRig\Rigs\ERigTransformStackEntryType) InEntryType, [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType, const FTransform & InOldTransform, const FTransform & InNewTransform, bool bInAffectChildren, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InCallstack )


className: FRigTransformStackEntry

bAffectChildren

type: bool

Callstack

type: TArray<FString...

EntryType

type: TEnumAsByte<ER...

Key

type: FRigElementKey


code: const [TArray](API\Runtime\Core\Containers\TArray)< FVector > & GetValue() const


code: [TArray](API\Runtime\Core\Containers\TArray)< FVector > & GetValue()


code: bool SetValue ( const [TArray](API\Runtime\Core\Containers\TArray)< FVector > & InValue )


code: virtual ~FRigVectorArrayMetadata()


className: FRigVectorArrayMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigVectorArrayMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

Value

type: TArray< FVector...


code: const FVector & GetValue() const


code: bool SetValue ( const FVector & InValue )


code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar, bool bIsLoading )


className: FRigVectorMetadata

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FRigVectorMetadata : public [FRigBaseMetadata](API\Plugins\ControlRig\Rigs\FRigBaseMetadata)

type: FVector


className: operator&

code: constexpr [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) operator& ( [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) Lhs, [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) Rhs )


className: operator&=

code: [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) & operator&= ( [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) & Lhs, [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) Rhs )


className: operator~

code: constexpr [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) operator~ ( [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) E )


className: operator^

code: constexpr [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) operator^ ( [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) Lhs, [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) Rhs )


className: operator^=

code: [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) & operator^= ( [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) & Lhs, [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) Rhs )


className: operator!

code: constexpr bool operator! ( [EControlRigContextChannelToKey](API\Plugins\ControlRig\Rigs\EControlRigContextChannelToKey) E )


description: ExecuteUnits

code: virtual bool Execute_Internal ( const [FName](API\Runtime\Core\UObject\FName) & InEventName )


description: Utility function to

code: static [FName](API\Runtime\Core\UObject\FName) GetControlName ( const [FName](API\Runtime\Core\UObject\FName) & InBoneName )


code: static [FName](API\Runtime\Core\UObject\FName) GetNullName ( const [FName](API\Runtime\Core\UObject\FName) & InBoneName )


description: BEGIN ControlRig.

code: virtual void Initialize ( bool bInitRigUnits )


code: UAdditiveControlRig ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


code: bool CanToggleApplyMode() const


className: FRigElementInitializationOptions

code: struct FRigElementInitializationOptions

bGenerateBoneControls

description: Flag whether or not to generate a transform control for bones.

bGenerateCurveControls

description: Flag whether or not to generate a float control for all curves in the hierarchy.

bImportCurves

description: Flag whether or not to import all curves from SmartNameMapping.

BoneNames

type: TArray<FName>

description: Set of bone names to generate a transform control for.

CurveNames

description: Set of curve names to generate a float control for (requires bImportCurves to be false)


code: bool GetControlActive ( int32 Index ) const


description: Utility function to generate a valid control element name

code: static [FName](API\Runtime\Core\UObject\FName) GetControlName ( const [FName](API\Runtime\Core\UObject\FName) & InName, const [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) & InType )


code: [TArray](API\Runtime\Core\Containers\TArray)< [FName](API\Runtime\Core\UObject\FName) > GetControlNames()


className: UAdditiveControlRig

description: Rig that allows additive layer editing per joint

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(NotBlueprintable) class UAdditiveControlRig : public [UControlRig](API\Plugins\ControlRig\UControlRig)


description: Utility function to generate a target element name for control

code: static [FName](API\Runtime\Core\UObject\FName) GetControlTargetName ( const [FName](API\Runtime\Core\UObject\FName) & InName, const [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) & InType )


code: bool IsApplyModeAdditive() const


description: Ensures that controls mask is updated according to contained ControlRig (control) elements.

code: void RefreshActiveControls()


description: Setup the initial transform / ref pose of the bones based upon skeletal mesh component (ref skeleton) This uses the RefSkeleton pose instead of the current refpose (or vice versae is bUseAnimInstance == true)

code: virtual void SetBoneInitialTransformsFromSkeletalMeshComponent ( [USkeletalMeshComponent](API\Runtime\Engine\Components\USkeletalMeshComponent) * InSkelMeshComp, bool bUseAnimInstance )


code: void SetApplyMode ( [EControlRigFKRigExecuteMode](API\Plugins\ControlRig\Rigs\EControlRigFKRigExecuteMode) InMode )


code: void SetControlActive ( const [TArray](API\Runtime\Core\Containers\TArray)< [FFKBoneCheckInfo](API\Plugins\ControlRig\Rigs\FFKBoneCheckInfo) > & InBoneChecks )


code: void SetControlActive ( int32 Index, bool bActive )


code: void SetInitializationOptions ( const [FRigElementInitializationOptions](API\Plugins\ControlRig\Rigs\UFKControlRig\FRigElementInitializationOptions) & Options )


code: void AddCachedCollection ( uint32 InHash, const [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) & InCollection ) const


code: UFKControlRig ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UFKControlRig

description: Rig that allows override editing per joint

code: [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(NotBlueprintable, Meta=(DisplayName="FK Control Rig")) class UFKControlRig : public [UControlRig](API\Plugins\ControlRig\UControlRig)


description: Iterators

code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * >::RangedForIteratorType begin()


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


className: bEnableValidityCheckbyDefault

code: static bool bEnableValidityCheckbyDefault = false;


description:
Determines if the element can be switched to a provided parent
Returns true if changing the weight was successful

code: bool CanSwitchToParent ( [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InChild, [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InParent, const [TElementDependencyMap](API\Plugins\ControlRig\Rigs\URigHierarchy\TElementDependencyMap) & InDependencyMap, [FString](API\Runtime\Core\Containers\FString) * OutFailureReason )


description: Updates the format for trace floating point numbers


description: Cleans up caches after load

code: void CleanupInvalidCaches()


code: void ClearListeningHierarchy()


description:
Returns true if the provided element key is valid
Returns true if the provided element key is valid

code: bool Contains ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


description:
Returns true if the provided element key is valid as a certain typename
Returns true if the provided element key is valid

code: template<typename T> bool Contains ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy, Meta=(DisplayName="Contains", ScriptName="Contains")) bool Contains_ForBlueprint ( [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InKey ) const


description: Copies the contents of a hierarchy onto this one

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) void CopyHierarchy ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy )


code: static void DeclareConstructClasses ( [TArray](API\Runtime\Core\Containers\TArray)< [FTopLevelAssetPath](API\Runtime\CoreUObject\UObject\FTopLevelAssetPath) > & OutConstructClasses, const [UClass](API\Runtime\CoreUObject\UObject\UClass) * SpecificSubclass )


description: Dumps the content of the transform stack to a string

code: void DumpTransformStackToFile ( [FString](API\Runtime\Core\Containers\FString) * OutFilePath )


className: EmptyElementArray

description: Static empty element array used for ref returns.

code: static const [FRigBaseElementChildrenArray](API\Plugins\ControlRig\Rigs\FRigBaseElementChildrenArray) EmptyElementArray;


code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * >::RangedForIteratorType end()


description: Starts an interaction on the rig. This will cause all transform actions happening to be merged

code: void EndInteraction()


description: Performs validation of the cache within the hierarchy on any mutation.

code: void EnsureCacheValidity() const


description:
Returns an element for a given key or nullptr.
The retrieved element or nullptr.

code: const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * Find ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) void CopyPose ( [URigHierarchy](API\Plugins\ControlRig\Rigs\URigHierarchy) * InHierarchy, bool bCurrent, bool bInitial, bool bWeights, bool bMatchPoseInGlobalIfNeeded )


code: [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * Find ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


description:
Returns an element for a given key or nullptr. This templated method also casts to the chosen element type but does not guarantee a valid result.
The retrieved element or nullptr.

code: template<typename T> const T * Find ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: template<typename T> T * Find ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


code: const [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) * FindCachedCollection ( uint32 InHash ) const


description:
Returns an element for a given key and raises for invalid results.
The retrieved element or nullptr.

code: [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * FindChecked ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


code: const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * FindChecked ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


description:
Returns an element for a given key. This templated method also casts to the chosen element type and checks for a the valid result.
The retrieved element or nullptr.

code: template<typename T> const T * FindChecked ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


code: template<typename T> T * FindChecked ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey )


code: [FRigElementKeyCollection](API\Plugins\ControlRig\Rigs\FRigElementKeyCollection) & FindOrAddCachedCollection ( uint32 InHash ) const


code: static [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) FlatIndexToRigElementType ( int32 InIndex )


description: Iterator function to invoke a lambda /TFunctionfor each element

code: void ForEach ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool([FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) *)> PerElementFunction ) const


description: Filtered template Iterator function to invoke a lambda /TFunctionfor each element of a given type.

code: template<typename T> void ForEach ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(T *)> PerElementFunction ) const


description:
Returns an element at a given index or nullptr.
The retrieved element or nullptr.

code: const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * Get ( int32 InIndex ) const


code: [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * Get ( int32 InIndex )


description:
Returns an element at a given index or nullptr. This templated method also casts to the chosen element type but does not guarantee a valid result.
The retrieved element or nullptr.

code: template<typename T> const T * Get ( int32 InIndex ) const


code: template<typename T> T * Get ( int32 InIndex )


description:
Get the current active for the passed in key. This is only valid when only one parent has a weight value and the other parents have zero weights
Returns the first parent with a non-zero weight

code: [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) GetActiveParent ( const [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) & InKey ) const


description:
Returns all element keys of this hierarchy
The keys of all elements

code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) > GetAllKeys ( bool bTraverse, [ERigElementType](API\Plugins\ControlRig\Rigs\ERigElementType) InElementType ) const


description: Returns all Bone elements

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy, Meta=(DisplayName="Get Bones", ScriptName="GetBones")) [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) > GetBoneKeys ( bool bTraverse ) const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy, Meta=(DisplayName="Get All Keys", ScriptName="GetAllKeys")) [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) > GetAllKeys_ForBlueprint ( bool bTraverse ) const


description: Queries and returns the value of bool array metadata

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category=URigHierarchy) [TArray](API\Runtime\Core\Containers\TArray)< bool > GetBoolArrayMetadata ( [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InItem, [FName](API\Runtime\Core\UObject\FName) InMetadataName ) const


description: Returns all Bone elements

code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigBoneElement](API\Plugins\ControlRig\Rigs\FRigBoneElement) * > GetBones ( bool bTraverse ) const


description: Queries and returns the value of bool metadata

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category=URigHierarchy) bool GetBoolMetadata ( [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InItem, [FName](API\Runtime\Core\UObject\FName) InMetadataName, bool DefaultValue ) const


description:
Returns an element at a given index. This templated method also casts to the chosen element type and checks for a the valid result.
The retrieved element or nullptr.

code: template<typename T> const T * GetChecked ( int32 InIndex ) const


description:
Returns the child elements of a given element
Returns the child elements

code: const [FRigBaseElementChildrenArray](API\Plugins\ControlRig\Rigs\FRigBaseElementChildrenArray) & GetChildren ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement ) const


code: template<typename T> T * GetChecked ( int32 InIndex )


description:
Returns the child elements of a given element key
Returns the child elements

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) > GetChildren ( [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InKey, bool bRecursive ) const


code: [FRigBaseElementChildrenArray](API\Plugins\ControlRig\Rigs\FRigBaseElementChildrenArray) GetChildren ( const [FRigBaseElement](API\Plugins\ControlRig\Rigs\FRigBaseElement) * InElement, bool bRecursive ) const


description:
Returns the child elements of a given element index
Returns the child elements' indices

code: [TArray](API\Runtime\Core\Containers\TArray)< int32 > GetChildren ( int32 InIndex, bool bRecursive ) const


code: FVector GetControlAnglesFromQuat ( const [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, const FQuat & InQuat ) const


description:
Returns the global offset transform for a given control element.
The global offset transform

code: FTransform GetControlOffsetTransform ( [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, const [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType ) const


description:
Returns a controller for this hierarchy. Note: If the controller is not available this will return nullptr even if the bCreateIfNeeded flag is set to true. You can check the controller's availability withIsControllerAvailable().
The Controller for this hierarchy

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) [URigHierarchyController](API\Plugins\ControlRig\Rigs\URigHierarchyController) * GetController ( bool bCreateIfNeeded )


description: Returns all Control elements

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy, Meta=(DisplayName="Get Controls", ScriptName="GetControls")) [TArray](API\Runtime\Core\Containers\TArray)< [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) > GetControlKeys ( bool bTraverse ) const


description:
Returns a control's preferred euler rotation order
Returns the current preferred euler rotation order

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) EEulerRotationOrder GetControlPreferredEulerRotationOrderByIndex ( int32 InElementIndex, bool bFromSettings ) const


description:
Returns the default value to use for a pin for a control
The pin default value

code: [FString](API\Runtime\Core\Containers\FString) GetControlPinDefaultValue ( [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, bool bForEdGraph, [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const


description:
Returns a control's preferred euler angles (local transform rotation)
Returns the current preferred euler angles

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) FVector GetControlPreferredEulerAngles ( [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InKey, EEulerRotationOrder InRotationOrder, bool bInitial ) const


description:
Returns the pin type to use for a control
The pin type

code: [FEdGraphPinType](API\Runtime\Engine\EdGraph\FEdGraphPinType) GetControlPinType ( [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement ) const


code: FVector GetControlPreferredEulerAngles ( const [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, EEulerRotationOrder InRotationOrder, bool bInitial ) const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) FVector GetControlPreferredEulerAnglesByIndex ( int32 InElementIndex, EEulerRotationOrder InRotationOrder, bool bInitial ) const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) EEulerRotationOrder GetControlPreferredEulerRotationOrder ( [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InKey, bool bFromSettings ) const


code: EEulerRotationOrder GetControlPreferredEulerRotationOrder ( const [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, bool bFromSettings ) const


description:
Returns a control's preferred rotator (local transform rotation)
Returns the current preferred rotator

code: FRotator GetControlPreferredRotator ( const [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, bool bInitial ) const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) FRotator GetControlPreferredRotator ( [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InKey, bool bInitial ) const


code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) FRotator GetControlPreferredRotatorByIndex ( int32 InElementIndex, bool bInitial ) const


code: FQuat GetControlQuaternion ( const [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, const FVector & InEulerAngle ) const


description:
Returns the global shape transform for a given control element.
The global shape transform

code: FTransform GetControlShapeTransform ( [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, const [ERigTransformType::Type](API\Plugins\ControlRig\Rigs\ERigTransformType__Type) InTransformType ) const


code: FVector GetControlSpecifiedEulerAngle ( const [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, bool bIsInitial ) const


description:
Returns a control's current value given its key
Returns the current value of the control

code: [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category=URigHierarchy) [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) GetControlValue ( [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InKey, [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const


code: template<typename T> T GetControlValue ( [FRigElementKey](API\Plugins\ControlRig\Rigs\FRigElementKey) InKey, [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const


description:
Returns a control's current value given its index
Returns the current value of the control

code: [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) GetControlValue ( int32 InElementIndex, [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const


description: Returns all Control elements

code: [TArray](API\Runtime\Core\Containers\TArray)< [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * > GetControls ( bool bTraverse ) const


code: template<typename T> T GetControlValue ( int32 InElementIndex, [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const


description:
Returns a control's current value
Returns the current value of the control

code: [FRigControlValue](API\Plugins\ControlRig\Rigs\FRigControlValue) GetControlValue ( [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const


code: template<typename T> T GetControlValue ( [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const


code: template<> FVector2D GetControlValue ( [FRigControlElement](API\Plugins\ControlRig\Rigs\FRigControlElement) * InControlElement, [ERigControlValueType](API\Plugins\ControlRig\Rigs\ERigControlValueType) InValueType ) const