Navigation
API > API/Plugins > API/Plugins/ControlRig
| Name | URigHierarchyController |
| Type | class |
| Header File | /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchyController.h |
| Include Path | #include "Rigs/RigHierarchyController.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class URigHierarchyController : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → URigHierarchyController
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URigHierarchyController() |
Rigs/RigHierarchyController.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~URigHierarchyController() |
Rigs/RigHierarchyController.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bReportWarningsAndErrors | bool | Rigs/RigHierarchyController.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bSuspendAllNotifications | bool | If set to true all notifications coming from this hierarchy will be suspended | Rigs/RigHierarchyController.h | |
| bSuspendParentCycleCheck | bool | If set to true parent cycle checking will be only deployed for elements that already have children. | Rigs/RigHierarchyController.h | |
| bSuspendPythonPrinting | bool | If set to true all python printing can be disabled. | Rigs/RigHierarchyController.h | |
| bSuspendSelectionNotifications | bool | If set to true selection related notifications coming from this hierarchy will be suspended | Rigs/RigHierarchyController.h | |
| CurrentInstructionIndex | int32 | If set the controller will mark new items as procedural and created at the current instruction | Rigs/RigHierarchyController.h | |
| LogFunction | TFunction< void(EMessageSeverity::Type, const FString &)> | This function can be used to override the controller's logging mechanism | Rigs/RigHierarchyController.h | |
| ModifiedEvent | FRigHierarchyModifiedEvent | Rigs/RigHierarchyController.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigElementKey AddAnimationChannel
(
FName InName, |
Adds a control to the hierarchy | Rigs/RigHierarchyController.h | |
FRigElementKey AddAnimationChannel_ForBlueprint
(
FName InName, |
Adds a control to the hierarchy | Rigs/RigHierarchyController.h |
|
bool AddAvailableSpace
(
FRigElementKey InControl, |
Adds a new available space to the given control | Rigs/RigHierarchyController.h |
|
bool AddAvailableSpace
(
FRigControlElement* InControlElement, |
Adds a new available space to the given control | Rigs/RigHierarchyController.h | |
FRigElementKey AddBone
(
FName InName, |
Adds a bone to the hierarchy | Rigs/RigHierarchyController.h |
|
bool AddChannelHost
(
FRigElementKey InChannel, |
Adds a new channel host to the animation channel | Rigs/RigHierarchyController.h |
|
FRigComponentKey AddComponent
(
UScriptStruct* InComponentStruct, |
Adds a component to the hierarchy | Rigs/RigHierarchyController.h |
|
FRigElementKey AddConnector
(
FName InName, |
Adds a connector to the hierarchy | Rigs/RigHierarchyController.h |
|
FRigElementKey AddControl
(
FName InName, |
Adds a control to the hierarchy | Rigs/RigHierarchyController.h | |
FRigElementKey AddControl_ForBlueprint
(
FName InName, |
Adds a control to the hierarchy | Rigs/RigHierarchyController.h |
|
FRigElementKey AddCurve
(
FName InName, |
Adds a curve to the hierarchy | Rigs/RigHierarchyController.h |
|
FRigElementKey AddDefaultRootSocket() |
Adds a socket to the first determined root bone the hierarchy | Rigs/RigHierarchyController.h | |
FRigElementKey AddNull
(
FName InName, |
Adds a null to the hierarchy | Rigs/RigHierarchyController.h |
|
bool AddParent
(
FRigBaseElement* InChild, |
Adds a new parent to an element. | Rigs/RigHierarchyController.h | |
bool AddParent
(
FRigElementKey InChild, |
Adds a new parent to an element. | Rigs/RigHierarchyController.h |
|
FRigElementKey AddReference
(
FName InName, |
Adds an reference to the hierarchy | Rigs/RigHierarchyController.h | |
FRigElementKey AddSocket
(
FName InName, |
Adds a socket to the hierarchy | Rigs/RigHierarchyController.h |
|
bool ClearSelection
(
bool bSetupUndo |
Clears the selection | Rigs/RigHierarchyController.h |
|
bool DeselectComponent
(
FRigComponentKey InKey |
Deselects or deselects a component in the hierarchy | Rigs/RigHierarchyController.h |
|
bool DeselectElement
(
FRigElementKey InKey |
Deselects or deselects an element in the hierarchy | Rigs/RigHierarchyController.h |
|
bool DeselectHierarchyKey
(
FRigHierarchyKey InKey, |
Deselects or deselects a component or an element in the hierarchy | Rigs/RigHierarchyController.h |
|
TArray< FRigElementKey > DuplicateElements
(
TArray< FRigElementKey > InKeys, |
Duplicate the given elements | Rigs/RigHierarchyController.h |
|
FString ExportSelectionToText() |
Exports the selected items to text | Rigs/RigHierarchyController.h |
|
FString ExportToText
(
TArray< FRigElementKey > InKeys |
Exports a list of items to text | Rigs/RigHierarchyController.h |
|
| Rigs/RigHierarchyController.h |
|
||
TArray< FString > GetAddBonePythonCommands
(
FRigBoneElement* Bone |
Rigs/RigHierarchyController.h | ||
TArray< FString > GetAddComponentPythonCommands
(
const FRigBaseComponent* Component |
Rigs/RigHierarchyController.h | ||
TArray< FString > GetAddConnectorPythonCommands
(
FRigConnectorElement* Connector |
Rigs/RigHierarchyController.h | ||
TArray< FString > GetAddControlPythonCommands
(
FRigControlElement* Control |
Rigs/RigHierarchyController.h | ||
TArray< FString > GetAddCurvePythonCommands
(
FRigCurveElement* Curve |
Rigs/RigHierarchyController.h | ||
TArray< FString > GetAddElementPythonCommands
(
FRigBaseElement* Element |
Rigs/RigHierarchyController.h | ||
TArray< FString > GetAddNullPythonCommands
(
FRigNullElement* Null |
Rigs/RigHierarchyController.h | ||
TArray< FString > GetAddSocketPythonCommands
(
FRigSocketElement* Socket |
Rigs/RigHierarchyController.h | ||
FRigControlSettings GetControlSettings
(
FRigElementKey InKey |
Returns the control settings of a given control | Rigs/RigHierarchyController.h |
|
URigHierarchy * GetHierarchy() |
Returns the hierarchy currently linked to this controller. | Rigs/RigHierarchyController.h |
|
TArray< FString > GetSetControlOffsetTransformPythonCommands
(
const FRigControlElement* Control, |
Rigs/RigHierarchyController.h | ||
TArray< FString > GetSetControlShapeTransformPythonCommands
(
const FRigControlElement* Control, |
Rigs/RigHierarchyController.h | ||
TArray< FString > GetSetControlValuePythonCommands
(
const FRigControlElement* Control, |
Rigs/RigHierarchyController.h | ||
bool & GetSuspendNotificationsFlag() |
Returns a reference to the suspend notifications flag | Rigs/RigHierarchyController.h | |
TArray< FRigElementKey > ImportBones
(
USkeletalMesh* InSkeletalMesh, |
Imports an existing skeleton to the hierarchy, restricting the bone list to the ones that exist in the provided Skeletal Mesh | Rigs/RigHierarchyController.h | |
TArray< FRigElementKey > ImportBones
(
USkeleton* InSkeleton, |
Imports an existing skeleton to the hierarchy | Rigs/RigHierarchyController.h |
|
TArray< FRigElementKey > ImportBones
(
const FReferenceSkeleton& InSkeleton, |
Imports an existing skeleton to the hierarchy | Rigs/RigHierarchyController.h | |
TArray< FRigElementKey > ImportBones
(
const TArray< FMeshBoneInfo >& BoneInfos, |
Imports the provided bone list to the hierarchy | Rigs/RigHierarchyController.h | |
TArray< FRigElementKey > ImportBonesFromAsset
(
FString InAssetPath, |
Imports an existing skeleton to the hierarchy | Rigs/RigHierarchyController.h |
|
TArray< FRigElementKey > ImportBonesFromSkeletalMesh
(
USkeletalMesh* InSkeletalMesh, |
Imports an existing skeleton to the hierarchy, restricting the bone list to the ones that exist in the provided Skeletal Mesh | Rigs/RigHierarchyController.h |
|
TArray< FRigElementKey > ImportCurves
(
USkeleton* InSkeleton, |
Imports all curves from a skeleton to the hierarchy | Rigs/RigHierarchyController.h |
|
TArray< FRigElementKey > ImportCurves
(
UAnimCurveMetaData* InAnimCurvesMetadata, |
Imports all curves from an anim curve metadata object to the hierarchy | Rigs/RigHierarchyController.h | |
TArray< FRigElementKey > ImportCurvesFromAsset
(
FString InAssetPath, |
Imports all curves from a skeleton to the hierarchy | Rigs/RigHierarchyController.h |
|
TArray< FRigElementKey > ImportCurvesFromSkeletalMesh
(
USkeletalMesh* InSkeletalMesh, |
Imports all curves from a skeletalmesh to the hierarchy | Rigs/RigHierarchyController.h |
|
TArray< FRigElementKey > ImportFromHierarchyContainer
(
const FRigHierarchyContainer& InContainer, |
Imports the content of a RigHierachyContainer (the hierarchy v1 pre 5.0) This is used for backwards compatbility only during load and does not support undo. | Rigs/RigHierarchyController.h | |
TArray< FRigElementKey > ImportFromText
(
FString InContent, |
Rigs/RigHierarchyController.h | ||
TArray< FRigElementKey > ImportFromText
(
FString InContent, |
Imports the content of a text buffer to the hierarchy | Rigs/RigHierarchyController.h |
|
TArray< FRigElementKey > ImportPreviewSkeletalMesh
(
USkeletalMesh* InSkeletalMesh, |
Imports all bones from a preview skeletal mesh. Used for rig modules and their preview skeleton | Rigs/RigHierarchyController.h |
|
TArray< FRigElementKey > ImportSocketsFromSkeletalMesh
(
USkeletalMesh* InSkeletalMesh, |
Imports the sockets from existing skeleton to the hierarchy as nulls | Rigs/RigHierarchyController.h |
|
TArray< FRigElementKey > MirrorElements
(
TArray< FRigElementKey > InKeys, |
Mirrors the given elements | Rigs/RigHierarchyController.h |
|
FRigHierarchyModifiedEvent & OnModified() |
Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy. | Rigs/RigHierarchyController.h | |
bool RemoveAllParents
(
FRigElementKey InChild, |
Removes all parents from an element in the hierarchy. | Rigs/RigHierarchyController.h |
|
bool RemoveAvailableSpace
(
FRigElementKey InControl, |
Removes an available space from the given control | Rigs/RigHierarchyController.h |
|
bool RemoveChannelHost
(
FRigElementKey InChannel, |
Removes an channel host from the animation channel | Rigs/RigHierarchyController.h |
|
bool RemoveComponent
(
FRigComponentKey InComponent, |
Removes a component from the hierarchy | Rigs/RigHierarchyController.h |
|
bool RemoveElement
(
FRigElementKey InElement, |
Removes an existing element from the hierarchy | Rigs/RigHierarchyController.h |
|
bool RemoveParent
(
FRigElementKey InChild, |
Removes an existing parent from an element in the hierarchy. | Rigs/RigHierarchyController.h |
|
FRigComponentKey RenameComponent
(
FRigComponentKey InComponent, |
Renames an existing component in the hierarchy | Rigs/RigHierarchyController.h |
|
FRigElementKey RenameElement
(
FRigElementKey InElement, |
Renames an existing element in the hierarchy | Rigs/RigHierarchyController.h |
|
bool ReorderElement
(
FRigElementKey InElement, |
Changes the element's index within its default parent (or the top level) | Rigs/RigHierarchyController.h |
|
FRigComponentKey ReparentComponent
(
FRigComponentKey InComponentKey, |
Reparents an existing component in the hierarchy | Rigs/RigHierarchyController.h |
|
void ReportAndNotifyError
(
const FString& InMessage |
Reports an error to the console and logs a notification to the UI. | Rigs/RigHierarchyController.h | |
void ReportAndNotifyErrorf
(
::UE::Core::TCheckedFormatString< FString::FmtCharType, Types... > Fmt, |
Rigs/RigHierarchyController.h | ||
void ReportError
(
const FString& InMessage |
Reports an error to the console. This does nothing if bReportWarningsAndErrors is false. | Rigs/RigHierarchyController.h | |
void ReportErrorf
(
::UE::Core::TCheckedFormatString< FString::FmtCharType, Types... > Fmt, |
Rigs/RigHierarchyController.h | ||
void ReportWarning
(
const FString& InMessage |
Reports a warning to the console. This does nothing if bReportWarningsAndErrors is false. | Rigs/RigHierarchyController.h | |
void ReportWarningf
(
::UE::Core::TCheckedFormatString< FString::FmtCharType, Types... > Fmt, |
Rigs/RigHierarchyController.h | ||
bool SelectComponent
(
FRigComponentKey InKey, |
Selects or deselects a component in the hierarchy | Rigs/RigHierarchyController.h |
|
bool SelectElement
(
FRigElementKey InKey, |
Selects or deselects an element in the hierarchy | Rigs/RigHierarchyController.h |
|
bool SelectHierarchyKey
(
FRigHierarchyKey InKey, |
Selects or deselects a component or an element in the hierarchy | Rigs/RigHierarchyController.h |
|
bool SetAvailableSpaceIndex
(
FRigElementKey InControl, |
Reorders an available space for the given control | Rigs/RigHierarchyController.h |
|
bool SetAvailableSpaceLabel
(
FRigElementKey InControl, |
Updates the label on an available space | Rigs/RigHierarchyController.h |
|
bool SetComponentContent
(
FRigComponentKey InComponent, |
Updates the content of a component in the hierarchy | Rigs/RigHierarchyController.h |
|
bool SetComponentSelection
(
const TArray< FRigComponentKey >& InKeys, |
Sets the selection based on a list of component keys | Rigs/RigHierarchyController.h |
|
bool SetComponentState
(
FRigComponentKey InComponent, |
Updates the state of a component in the hierarchy | Rigs/RigHierarchyController.h | |
bool SetControlSettings
(
FRigElementKey InKey, |
Sets a control's settings given a control key | Rigs/RigHierarchyController.h |
|
FName SetDisplayName
(
FRigElementKey InControl, |
Sets the display name on a control | Rigs/RigHierarchyController.h |
|
void SetHierarchy
(
URigHierarchy* InHierarchy |
Sets the hierarchy currently linked to this controller. | Rigs/RigHierarchyController.h |
|
bool SetHierarchySelection
(
const TArray< FRigHierarchyKey >& InKeys, |
Sets the selection based on a list of component keys | Rigs/RigHierarchyController.h |
|
bool SetParent
(
FRigElementKey InChild, |
Sets a new parent to an element. | Rigs/RigHierarchyController.h |
|
bool SetSelection
(
const TArray< FRigElementKey >& InKeys, |
Sets the selection based on a list of element keys | Rigs/RigHierarchyController.h |
|
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Serialize
(
FArchive& Ar |
Rigs/RigHierarchyController.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static USkeletalMesh * GetSkeletalMeshFromAssetPath
(
const FString& InAssetPath |
Rigs/RigHierarchyController.h | ||
| Rigs/RigHierarchyController.h |