Choose your operating system:
Windows
macOS
Linux
| UObjectBase
|
Module |
|
Header |
/Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchy.h |
Include |
#include "Rigs/RigHierarchy.h" |
UCLASS(BlueprintType)
class URigHierarchy : public UObject
Name | Description | ||
---|---|---|---|
|
bEnableCacheValidityCheck |
||
|
TObjectPtr< URi... |
HierarchyForCacheValidation |
|
|
TraceFramesCaptured |
||
|
TraceFramesLeft |
||
|
TracePoses |
Name | Description | |
---|---|---|
|
URigHierarchy() |
Name | Description | |
---|---|---|
|
~URigHierarchy() |
Name | Description | ||
---|---|---|---|
|
begin() |
Iterators |
|
|
CanSwitchToParent ( |
Determines if the element can be switched to a provided parent |
|
|
CheckTraceFormatIfRequired() |
Updates the format for trace floating point numbers |
|
|
ClearListeningHierarchy() |
||
|
ComputeLocalControlValue ( |
||
|
ComputeParentConstraintIndices ( |
||
|
Contains ( |
Returns true if the provided element key is valid |
|
|
Contains_ForBlueprint ( |
Returns true if the provided element key is valid |
|
|
ControlSettingsToPythonCommands ( |
||
|
CopyHierarchy ( |
Copies the contents of a hierarchy onto this one |
|
|
CopyPose ( |
Copies the contents of a hierarchy onto this one |
|
|
DumpTransformStackToFile ( |
Dumps the content of the transform stack to a string |
|
|
end() |
||
|
EndInteraction() |
Starts an interaction on the rig. This will cause all transform actions happening to be merged |
|
|
const T *... |
Find ( |
Returns an element for a given key or nullptr. |
|
T * |
Find ( |
Returns an element for a given key or nullptr. |
|
FRigBaseElem... |
Find ( |
Returns an element for a given key or nullptr. |
|
const FRigBa... |
Find ( |
Returns an element for a given key or nullptr. |
|
FRigBaseElem... |
FindChecked ( |
Returns an element for a given key and raises for invalid results. |
|
T * |
FindChecked ( |
Returns an element for a given key. |
|
const T *... |
FindChecked ( |
Returns an element for a given key. |
|
const FRigBa... |
FindChecked ( |
Returns an element for a given key and raises for invalid results. |
|
ERigElementT... |
FlatIndexToRigElementType ( |
|
|
ForEach |
Filtered template Iterator function to invoke a lambda / TFunction for each element of a given type. |
|
|
ForEach |
Iterator function to invoke a lambda / TFunction for each element |
|
|
T * |
Get ( |
Returns an element at a given index or nullptr. |
|
const FRigBa... |
Get ( |
Returns an element at a given index or nullptr. |
|
const T *... |
Get ( |
Returns an element at a given index or nullptr. |
|
FRigBaseElem... |
Get ( |
Returns an element at a given index or nullptr. |
|
FRigElementK... |
GetActiveParent ( |
Get the current active for the passed in key. |
|
GetAllKeys ( |
Returns all element keys of this hierarchy |
|
|
GetAllKeys_ForBlueprint ( |
Returns all element keys of this hierarchy |
|
|
GetBoneKeys ( |
Returns all Bone elements |
|
|
GetBones ( |
Returns all Bone elements |
|
|
const T *... |
GetChecked ( |
Returns an element at a given index. |
|
T * |
GetChecked ( |
Returns an element at a given index. |
|
const FRigBa... |
GetChildren ( |
Returns the child elements of a given element |
|
GetChildren ( |
Returns the child elements of a given element key |
|
|
GetChildren |
Returns the child elements of a given element index |
|
|
FRigBaseElem... |
GetChildren ( |
Returns the child elements of a given element |
|
GetControlKeys ( |
Returns all Control elements |
|
|
URigHierarch... |
GetController ( |
Returns a controller for this hierarchy |
|
GetControlOffsetTransform ( |
Returns the global offset transform for a given control element. |
|
|
GetControlPinDefaultValue ( |
Returns the default value to use for a pin for a control |
|
|
FEdGraphPinT... |
GetControlPinType ( |
Returns the pin type to use for a control |
|
GetControls ( |
Returns all Control elements |
|
|
GetControlShapeTransform ( |
Returns the global shape transform for a given control element. |
|
|
T |
GetControlValue ( |
Returns a control's current value given its index |
|
T |
GetControlValue ( |
|
|
FRigControlV... |
GetControlValue ( |
Returns a control's current value |
|
FRigControlV... |
GetControlValue ( |
Returns a control's current value given its index |
|
T |
GetControlValue ( |
Returns a control's current value given its key |
|
FRigControlV... |
GetControlValue ( |
Returns a control's current value given its key |
|
GetControlValue ( |
||
|
FRigControlV... |
GetControlValueByIndex ( |
Returns a control's current value given its index |
|
GetCurveKeys() |
Returns all Curve elements |
|
|
GetCurves() |
Returns all Curve elements |
|
|
float |
GetCurveValue ( |
Returns a curve's value |
|
float |
GetCurveValue ( |
|
|
float |
GetCurveValue ( |
Returns a curve's value given its key |
|
float |
GetCurveValueByIndex ( |
Returns a curve's value given its index |
|
FRigElementK... |
GetDefaultParentKey() |
|
|
TElementDepe... |
GetDependenciesForVM |
|
|
TArray< T &#... |
GetElementsOfType ( |
Filtered accessor to retrieve all elements of a given type |
|
FEulerTransf... |
GetEulerTransformFromControlValue ( |
Returns the contained FEulerTransform value from a a Rig Control Value |
|
TArray< T &#... |
GetFilteredElements |
Filtered accessor to retrieve all elements of a given type |
|
FRigElementK... |
GetFirstParent ( |
Returns the first parent element of a given element key |
|
GetFirstParent ( |
Returns the first parent element of a given element index |
|
|
FRigBaseElem... |
GetFirstParent ( |
Returns the first parent element of a given element |
|
float |
GetFloatFromControlValue ( |
Returns the contained float value from a a Rig Control Value |
|
GetGlobalControlOffsetTransform ( |
Returns the global offset transform for a given control element. |
|
|
GetGlobalControlOffsetTransformByIndex |
Returns the global offset transform for a given control element. |
|
|
GetGlobalControlShapeTransform ( |
Returns the global shape transform for a given control element. |
|
|
GetGlobalControlShapeTransformByIndex |
Returns the global shape transform for a given control element. |
|
|
GetGlobalTransform ( |
Returns the global current or initial value for a given key. |
|
|
GetGlobalTransform ( |
||
|
GetGlobalTransformByIndex |
Returns the global current or initial value for a element index. |
|
|
GetIndex ( |
Returns the index of an element given its key |
|
|
GetIndex_ForBlueprint ( |
Returns the index of an element given its key |
|
|
FRigControlV... |
GetInitialControlValue ( |
Returns a control's initial value given its index |
|
T |
GetInitialControlValue ( |
Returns a control's initial value given its index |
|
GetInitialGlobalTransform ( |
||
|
GetInitialGlobalTransform ( |
||
|
GetInitialLocalTransform ( |
||
|
GetInitialLocalTransform ( |
||
|
GetIntFromControlValue ( |
Returns the contained int32 value from a a Rig Control Value |
|
|
FRigElementK... |
GetKey ( |
Returns the key of an element given its index |
|
GetKeysOfType ( |
Filtered accessor to retrieve all element keys of a given type |
|
|
GetLocalTransform ( |
||
|
GetLocalTransform ( |
Returns the local current or initial value for a given key. |
|
|
GetLocalTransformByIndex |
Returns the local current or initial value for a element index. |
|
|
GetMaxNameLength() |
Returns the max allowed length for a name within the hierarchy. |
|
|
GetNullKeys ( |
Returns all Null elements |
|
|
GetNulls ( |
Returns all Null elements |
|
|
GetNumberOfParents ( |
Returns the number of parents of an element |
|
|
GetNumberOfParents ( |
Returns the number of parents of an element |
|
|
GetNumberOfParents ( |
Returns the number of parents of an element |
|
|
FRigElementK... |
GetOrAddWorldSpaceReference() |
Adds the world space reference or returns it |
|
GetParents ( |
Returns the parent elements of a given element key |
|
|
GetParents |
Returns the parent elements of a given element index |
|
|
FRigBaseElem... |
GetParents ( |
Returns the parent elements of a given element |
|
GetParentTransform ( |
Returns the global current or initial value for a given key. |
|
|
GetParentTransform ( |
Returns a transform for a given element's parent based on the transform type If the element does not have a parent FTransform::Identity will be returned. |
|
|
GetParentTransformByIndex |
Returns the global current or initial value for a given element index. |
|
|
FRigElementW... |
GetParentWeight ( |
Returns the weight of a parent below a multi parent element |
|
FRigElementW... |
GetParentWeight ( |
Returns the weight of a parent below a multi parent element |
|
FRigElementW... |
GetParentWeight ( |
Returns the weight of a parent below a multi parent element |
|
GetParentWeightArray ( |
Returns the weights of all parents below a multi parent element |
|
|
GetParentWeightArray ( |
Returns the weights of all parents below a multi parent element |
|
|
GetPose ( |
Returns the current / initial pose of the hierarchy |
|
|
GetPose ( |
Returns the current / initial pose of the hierarchy |
|
|
GetPose ( |
Returns the current / initial pose of the hierarchy |
|
|
GetPreviousName ( |
Returns the previous name of an element prior to a rename operation |
|
|
FRigElementK... |
GetPreviousParent ( |
Returns the previous parent of an element prior to a reparent operation |
|
GetReferenceKeys ( |
Returns all references |
|
|
GetReferences ( |
Returns all references |
|
|
GetRigidBodies ( |
Returns all RigidBody elements |
|
|
GetRigidBodyKeys ( |
Returns all RigidBody elements |
|
|
GetRotatorFromControlValue ( |
Returns the contained FRotator value from a a Rig Control Value |
|
|
GetSafeNewName ( |
Returns a valid new name for a to-be-added element. |
|
|
GetSanitizedName ( |
Sanitizes a name by removing invalid characters. |
|
|
GetSelectedElements ( |
Returns the selected elements The types to retrieve the selection for |
|
|
GetSelectedKeys ( |
Returns the keys of selected elements The types to retrieve the selection for |
|
|
bool & |
GetSuspendNotificationsFlag() |
Returns a reference to the suspend notifications flag |
|
GetTopologyVersion() |
Returns the topology version of this hierarchy |
|
|
GetTransform ( |
Returns a transform based on a given transform type |
|
|
GetTransformFromControlValue ( |
Returns the contained FTransform value from a a Rig Control Value |
|
|
FTransformNo... |
GetTransformNoScaleFromControlValue ( |
Returns the contained FTransformNoScale value from a a Rig Control Value |
|
GetTransformStackIndex() |
Returns the transform stack index |
|
|
GetTransientControls() |
Returns all transient Control elements |
|
|
GetVector2DFromControlValue ( |
Returns the contained FVector2D value from a a Rig Control Value |
|
|
GetVectorFromControlValue ( |
Returns the contained FVector value from a a Rig Control Value |
|
|
float |
GetWeightForLerp ( |
|
|
FRigElementK... |
GetWorldSpaceReferenceKey() |
|
|
GetWorldTransformForReference ( |
||
|
IntegrateParentConstraintQuat ( |
||
|
IntegrateParentConstraintVector ( |
||
|
InverseSolveParentConstraints ( |
||
|
IsDependentOn ( |
Returns true if an element is affected to another element |
|
|
IsNameAvailable ( |
Returns true if a given name is available. |
|
|
IsParentedTo ( |
Returns true if an element is parented to another element |
|
|
IsParentedTo ( |
Returns true if an element is parented to another element |
|
|
IsParentedTo ( |
Returns true if an element is parented to another element |
|
|
IsSelected ( |
Returns true if a given element is selected |
|
|
IsSelected ( |
||
|
IsSelectedByIndex ( |
Returns true if a given element is selected |
|
|
IsTracingChanges() |
Returns true if a hierarchy will record any change. This is used for debugging purposes. |
|
|
IsValidIndex ( |
Returns true if the provided element index is valid |
|
|
LazilyComputeParentConstraint ( |
||
|
Load ( |
||
|
FRigControlV... |
MakeControlValueFromBool ( |
Creates a rig control value from a bool value |
|
FRigControlV... |
MakeControlValueFromEulerTransform ( |
Creates a rig control value from a FEulerTransform value |
|
FRigControlV... |
MakeControlValueFromFloat ( |
Creates a rig control value from a float value |
|
FRigControlV... |
MakeControlValueFromInt ( |
Creates a rig control value from a int32 value |
|
FRigControlV... |
MakeControlValueFromRotator ( |
Creates a rig control value from a FRotator value |
|
FRigControlV... |
MakeControlValueFromTransform ( |
Creates a rig control value from a FTransform value |
|
FRigControlV... |
MakeControlValueFromTransformNoScale ( |
Creates a rig control value from a FTransformNoScale value |
|
FRigControlV... |
MakeControlValueFromVector ( |
Creates a rig control value from a FVector value |
|
FRigControlV... |
MakeControlValueFromVector2D ( |
Creates a rig control value from a FVector2D value |
|
Notify ( |
||
|
Num() |
Returns the number of elements in the Hierarchy. |
|
|
Num ( |
Returns the number of elements in the Hierarchy. |
|
|
FRigEventDel... |
OnEventReceived() |
Returns the delegate to listen to for events coming from this hierarchy |
|
FRigHierarch... |
OnModified() |
Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy. |
|
FRigHierarch... |
OnUndoRedo() |
Returns the event fired during undo / redo |
|
Redo() |
Performs redo for one transform change |
|
|
RegisterListeningHierarchy ( |
Add dependent hierarchies that listens to changes made to this hierarchy |
|
|
Reset() |
Clears the whole hierarchy and removes all elements. |
|
|
ResetCurveValues() |
Resets all curves to 0.0 |
|
|
ResetPoseToInitial() |
Resets the current pose of all elements to the initial / ref pose. |
|
|
ResetPoseToInitial ( |
Resets the current pose of a filtered lost if elements to the initial / ref pose. |
|
|
ResetTransformStack() |
Clears the undo / redo stack of this hierarchy |
|
|
RigElementTypeToFlatIndex ( |
||
|
SanitizeName ( |
Sanitizes a name by removing invalid characters. |
|
|
Save ( |
||
|
SendAutoKeyEvent ( |
Sends an autokey event from the hierarchy to the world |
|
|
SendEvent ( |
Sends an event from the hierarchy to the world |
|
|
SetControlOffsetTransform ( |
Sets the offset transform for a given control element |
|
|
SetControlOffsetTransform ( |
Sets the offset transform for a given control element by key |
|
|
SetControlOffsetTransformByIndex |
Sets the local offset transform for a given control element by index |
|
|
SetControlSettings ( |
Sets the control settings for a given control element by key |
|
|
SetControlSettings ( |
Sets the control settings for a given control element |
|
|
SetControlSettingsByIndex ( |
Sets the control settings for a given control element by index |
|
|
SetControlShapeTransform ( |
Sets the shape transform for a given control element |
|
|
SetControlShapeTransform ( |
Sets the shape transform for a given control element by key |
|
|
SetControlShapeTransformByIndex ( |
Sets the local shape transform for a given control element by index |
|
|
SetControlValue ( |
||
|
SetControlValue ( |
Sets a control's current value |
|
|
SetControlValue ( |
||
|
SetControlValue ( |
Sets a control's current value given its index |
|
|
SetControlValue ( |
Sets a control's current value given its key |
|
|
SetControlValue ( |
Sets a control's current value given its key |
|
|
SetControlValue ( |
Sets a control's current value given its index |
|
|
SetControlValueByIndex ( |
Sets a control's current value given its index |
|
|
SetControlVisibility ( |
Sets a control's current visibility |
|
|
SetControlVisibility ( |
Sets a control's current visibility based on a key |
|
|
SetControlVisibility |
||
|
SetControlVisibilityByIndex |
Sets a control's current visibility based on a key |
|
|
SetCurveValue |
||
|
SetCurveValue ( |
Sets a curve's value given its key |
|
|
SetCurveValue ( |
Sets a curve's value |
|
|
SetCurveValueByIndex |
Sets a curve's value given its index |
|
|
SetGlobalTransform ( |
||
|
SetGlobalTransform ( |
Sets the global current or initial transform for a given key. |
|
|
SetGlobalTransformByIndex ( |
Sets the global current or initial transform for a given element index. |
|
|
SetInitialControlValue ( |
Sets a control's initial value given its index |
|
|
SetInitialControlValue |
Sets a control's initial value given its index |
|
|
SetInitialGlobalTransform ( |
||
|
SetInitialGlobalTransform ( |
||
|
SetInitialLocalTransform ( |
||
|
SetInitialLocalTransform ( |
||
|
SetLocalTransform ( |
Sets the local current or initial transform for a given key. |
|
|
SetLocalTransform ( |
||
|
SetLocalTransformByIndex |
Sets the local current or initial transform for a given element index. |
|
|
SetParentWeight ( |
Sets the weight of a parent below a multi parent element |
|
|
SetParentWeight ( |
Sets the weight of a parent below a multi parent element |
|
|
SetParentWeight ( |
Sets the weight of a parent below a multi parent element |
|
|
SetParentWeightArray ( |
Sets the all of the weights of the parents of a multi parent element |
|
|
SetParentWeightArray ( |
Sets the all of the weights of the parents of a multi parent element |
|
|
SetParentWeightArray ( |
Sets the all of the weights of the parents of a multi parent element |
|
|
SetPose ( |
Sets the current / initial pose of the hierarchy |
|
|
SetPose ( |
Sets the current / initial pose of the hierarchy |
|
|
SetPose ( |
Sets the current / initial pose of the hierarchy |
|
|
SetPose_ForBlueprint ( |
Sets the current / initial pose of the hierarchy |
|
|
SetTransform ( |
Sets a transform for a given element based on the transform type |
|
|
SolveParentConstraints ( |
||
|
SortKeys ( |
Sorts the input key list by traversing the hierarchy |
|
|
StartInteraction() |
Starts an interaction on the rig. This will cause all transform actions happening to be merged |
|
|
StorePoseForTrace ( |
Stores the current pose for tracing |
|
|
SwitchToDefaultParent ( |
Switches a multi parent element to its first parent |
|
|
SwitchToDefaultParent ( |
Switches a multi parent element to its first parent This sets the new parent's weight to 1.0 and disables weights for all other potential parents. |
|
|
SwitchToParent ( |
Switches a multi parent element to a single parent. |
|
|
SwitchToParent ( |
||
|
SwitchToParent ( |
Switches a multi parent element to a single parent. |
|
|
SwitchToParent ( |
Switches a multi parent element to a single parent. |
|
|
SwitchToWorldSpace ( |
Switches a multi parent element to world space. This injects a world space reference. |
|
|
SwitchToWorldSpace ( |
Switches a multi parent element to world space. This injects a world space reference. |
|
|
TraceFrames ( |
Tells this hierarchy to trace a series of frames |
|
|
Traverse ( |
Helper function to traverse the hierarchy |
|
|
Traverse |
Helper function to traverse the hierarchy from the root |
|
|
Undo() |
Performs undo for one transform change |
|
|
UnregisterListeningHierarchy ( |
Remove dependent hierarchies that listens to changes made to this hierarchy |
|
|
UpdateReferences ( |
Update all elements that depend on external references |
Name | Description | ||
---|---|---|---|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
PostTransacted ( |
Called after the object has been transacted in some way. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name |
Description |
|
---|---|---|
|
FConstraintIndex |
Name |
Description |
---|---|
TElementDependencyMap |
|
TElementDependencyMapPair |
Name |
Description |
---|---|
EmptyElementArray |
Static empty element array used for ref returns. |