1. Epic GamesDeveloper
  3. URigHierarchyController

URigHierarchyController

API > API/Plugins > API/Plugins/ControlRig > API/Plugins/ControlRig/Rigs

Inheritance Hierarchy

References

   
Module ControlRig
Header /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/Rigs/RigHierarchyController.h
Include #include "Rigs/RigHierarchyController.h"

Syntax

UCLASS&40;BlueprintType&41;  
class URigHierarchyController : public UObject

Variables

  Type Name Description
Public variable UProperty Transient bool bReportWarningsAndErrors  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FRigElementKey

AddAnimationChannel ( FName InName,
FRigElementKey InParentControl,
FRigControlSettings InSettings,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Adds a control to the hierarchy
Public function UFunction BlueprintCallable, Category, Meta FRigElementKey

AddAnimationChannel_ForBlueprint ( FName InName,
FRigElementKey InParentControl,
FRigControlSettings InSettings,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Adds a control to the hierarchy
Public function UFunction BlueprintCallable, Category FRigElementKey

AddBone ( FName InName,
FRigElementKey InParent,
FTransform InTransform,
bool bTransformInGlobal,
ERigBoneType InBoneType,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Adds a bone to the hierarchy
Public function FRigElementKey

AddControl ( FName InName,
FRigElementKey InParent,
FRigControlSettings InSettings,
FRigControlValue InValue,
FTransform InOffsetTransform,
FTransform InShapeTransform,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Adds a control to the hierarchy
Public function UFunction BlueprintCallable, Category, Meta FRigElementKey

AddControl_ForBlueprint ( FName InName,
FRigElementKey InParent,
FRigControlSettings InSettings,
FRigControlValue InValue,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Adds a control to the hierarchy
Public function UFunction BlueprintCallable, Category FRigElementKey

AddCurve ( FName InName,
float InValue,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Adds a curve to the hierarchy
Public function UFunction BlueprintCallable, Category FRigElementKey

AddNull ( FName InName,
FRigElementKey InParent,
FTransform InTransform,
bool bTransformInGlobal,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Adds a null to the hierarchy
Public function bool

AddParent ( FRigBaseElement* InChild,
FRigBaseElement* InParent,
float InWeight,
bool bMaintainGlobalTransform,
bool bRemoveAllParents
)

 Adds a new parent to an element.
Public function UFunction BlueprintCallable, Category bool

AddParent ( FRigElementKey InChild,
FRigElementKey InParent,
float InWeight,
bool bMaintainGlobalTransform,
bool bSetupUndo
)

 Adds a new parent to an element.
Public function FRigElementKey

AddReference ( FName InName,
FRigElementKey InParent,
FRigReferenceGetWorldTransformDelegate InDelegate,
bool bSetupUndo
)

 Adds an reference to the hierarchy
Public function UFunction BlueprintCallable, Category FRigElementKey

AddRigidBody ( FName InName,
FRigElementKey InParent,
FRigRigidBodySettings InSettings,
FTransform InLocalTransform,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Adds a rigidbody to the hierarchy
Public function UFunction BlueprintCallable, Category bool Clears the selection
Public function UFunction BlueprintCallable, Category bool Deselects or deselects an element in the hierarchy
Public function UFunction BlueprintCallable, Category TArray< FRigElementKey >

DuplicateElements ( TArray< FRigElementKey > InKeys,
bool bSelectNewElements,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Duplicate the given elements
Public function Const UFunction BlueprintCallable, Category FString Exports the selected items to text
Public function Const UFunction BlueprintCallable, Category FString Exports a list of items to text
Public function UFunction BlueprintCallable, Category TArray< FString >  
Public function Const TArray< FString >  
Public function Const TArray< FString >  
Public function Const TArray< FString >  
Public function Const TArray< FString >  
Public function Const TArray< FString >  
Public function Const TArray< FString >  
Public function Const UFunction BlueprintCallable, Category FRigControlSettings Returns the control settings of a given control
Public function Const UFunction BlueprintCallable, Category URigHierarchy * Returns the hierarchy currently linked to this controller.
Public function Const TArray< FString >

GetSetControlOffsetTransformPythonCommands ( const FRigControlElement* Control,
const FTransform& Offset,
bool bInitial,
bool bAffectChildren
)

  
Public function Const TArray< FString >

GetSetControlShapeTransformPythonCommands ( const FRigControlElement* Control,
const FTransform& Transform,
bool bInitial
)

  
Public function Const TArray< FString >  
Public function bool & Returns a reference to the suspend notifications flag
Public function UFunction BlueprintCallable, Category TArray< FRigElementKey >

ImportBones ( USkeleton* InSkeleton,
FName InNameSpace,
bool bReplaceExistingBones,
bool bRemoveObsoleteBones,
bool bSelectBones,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Imports an existing skeleton to the hierarchy
Public function TArray< FRigElementKey >

ImportBones ( const FReferenceSkeleton& InSkeleton,
const FName& InNameSpace,
bool bReplaceExistingBones,
bool bRemoveObsoleteBones,
bool bSelectBones,
bool bSetupUndo
)

 Imports an existing skeleton to the hierarchy
Public function UFunction BlueprintCallable, Category TArray< FRigElementKey >

ImportBonesFromAsset ( FString InAssetPath,
FName InNameSpace,
bool bReplaceExistingBones,
bool bRemoveObsoleteBones,
bool bSelectBones,
bool bSetupUndo
)

 Imports an existing skeleton to the hierarchy
Public function UFunction BlueprintCallable, Category TArray< FRigElementKey >

ImportCurves ( USkeleton* InSkeleton,
FName InNameSpace,
bool bSelectCurves,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Imports all curves from a skeleton to the hierarchy
Public function UFunction BlueprintCallable, Category TArray< FRigElementKey >

ImportCurvesFromAsset ( FString InAssetPath,
FName InNameSpace,
bool bSelectCurves,
bool bSetupUndo
)

 Imports all curves from a skeleton to the hierarchy
Public function TArray< FRigElementKey >

ImportFromHierarchyContainer ( const FRigHierarchyContainer& InContainer,
bool bIsCopyAndPaste
)

 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.
Public function UFunction BlueprintCallable, Category TArray< FRigElementKey >

ImportFromText ( FString InContent,
bool bReplaceExistingElements,
bool bSelectNewElements,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Imports the content of a text buffer to the hierarchy
Public function UFunction BlueprintCallable, Category TArray< FRigElementKey >

MirrorElements ( TArray< FRigElementKey > InKeys,
FRigVMMirrorSettings InSettings,
bool bSelectNewElements,
bool bSetupUndo,
bool bPrintPythonCommands
)

 Mirrors the given elements
Public function FRigHierarchyModifiedEvent & Returns the modified event, which can be used to subscribe to topological changes happening within the hierarchy.
Public function UFunction BlueprintCallable, Category bool

RemoveAllParents ( FRigElementKey InChild,
bool bMaintainGlobalTransform,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Removes all parents from an element in the hierarchy.
Public function UFunction BlueprintCallable, Category bool

RemoveElement ( FRigElementKey InElement,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Removes an existing element from the hierarchy
Public function UFunction BlueprintCallable, Category bool

RemoveParent ( FRigElementKey InChild,
FRigElementKey InParent,
bool bMaintainGlobalTransform,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Removes an existing parent from an element in the hierarchy.
Public function UFunction BlueprintCallable, Category FRigElementKey

RenameElement ( FRigElementKey InElement,
FName InName,
bool bSetupUndo,
bool bPrintPythonCommand,
bool bClearSelection
)

 Renames an existing element in the hierarchy
Public function UFunction BlueprintCallable, Category bool

ReorderElement ( FRigElementKey InElement,
int32 InIndex,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Changes the element's index within its default parent (or the top level)
Public function Const void

ReportAndNotifyError ( const FString& InMessage
)

 Reports an error to the console and logs a notification to the UI.
Public function Const void

ReportAndNotifyErrorf ( const FmtType& Fmt,
Types... Args
)

  
Public function Const void

ReportError ( const FString& InMessage
)

 Reports an error to the console. This does nothing if bReportWarningsAndErrors is false.
Public function Const void

ReportErrorf ( const FmtType& Fmt,
Types... Args
)

  
Public function Const void

ReportWarning ( const FString& InMessage
)

 Reports a warning to the console. This does nothing if bReportWarningsAndErrors is false.
Public function Const void

ReportWarningf ( const FmtType& Fmt,
Types... Args
)

  
Public function UFunction BlueprintCallable, Category bool

SelectElement ( FRigElementKey InKey,
bool bSelect,
bool bClearSelection
)

 Selects or deselects an element in the hierarchy
Public function Const UFunction BlueprintCallable, Category bool

SetControlSettings ( FRigElementKey InKey,
FRigControlSettings InSettings,
bool bSetupUndo
)

 Sets a control's settings given a control key
Public function UFunction BlueprintCallable, Category FName

SetDisplayName ( FRigElementKey InControl,
FName InDisplayName,
bool bRenameElement,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Sets the display name on a control
Public function UFunction BlueprintCallable, Category void

SetHierarchy ( URigHierarchy* InHierarchy
)

 Sets the hierarchy currently linked to this controller.
Public function UFunction BlueprintCallable, Category bool

SetParent ( FRigElementKey InChild,
FRigElementKey InParent,
bool bMaintainGlobalTransform,
bool bSetupUndo,
bool bPrintPythonCommand
)

 Sets a new parent to an element.
Public function UFunction BlueprintCallable, Category bool

SetSelection ( const TArray< FRigElementKey >& InKeys,
bool bPrintPythonCommand
)

 Sets the selection based on a list of keys

Overridden from UObject

  Type Name Description
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page