UControlRigHierarchyModifier

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UControlRigHierarchyModifier

References

Module

ControlRigDeveloper

Header

/Engine/Plugins/Experimental/ControlRig/Source/ControlRigDeveloper/Public/ControlRigHierarchyModifier.h

Include

#include "ControlRigHierarchyModifier.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType)
class UControlRigHierarchyModifier : public UObject

Constructors

Functions

Name Description

Public function UFunction BlueprintCallable, Category

FRigElementK...

 

AddBone

(
    const FName& InNewName,
    const FName& InParentName,
    ERigBoneType InType
)

Adds a new single bone.

Public function UFunction BlueprintCallable, Category

FRigElementK...

 

AddControl

(
    const FName& InNewName,
    ERigControlType InControlType,
    const FName& InParentName,
    const FName& InSpaceName,
    const FName& InGizmoName,
    const FLinearColor& InGizmoColor
)

Adds a new single control.

Public function UFunction BlueprintCallable, Category

FRigElementK...

 

AddCurve

(
    const FName& InNewName,
    float InValue
)

Adds a new single curve.

Public function UFunction BlueprintCallable, Category

FRigElementK...

 

AddSpace

(
    const FName& InNewName,
    ERigSpaceType InSpaceType,
    const FName& InParentName
)

Adds a new single space.

Public function UFunction BlueprintCallable, Category

bool

 

ClearSelection()

Clears the selection.

Public function Const UFunction BlueprintCallable, Category

FString

 

ExportToText

(
    const TArray< FRigElementKey >& In...
)

Exports the elements provided to text (for copy & paste, import / export)

Public function UFunction BlueprintCallable, Category

FRigBone

 

GetBone

(
    const FRigElementKey& InKey
)

Returns a single bone from provided key.

Public function UFunction BlueprintCallable, Category

FRigControl

 

GetControl

(
    const FRigElementKey& InKey
)

Returns a single control from provided key.

Public function UFunction BlueprintCallable, Category

FRigCurve

 

GetCurve

(
    const FRigElementKey& InKey
)

Returns a single curve from provided key.

Public function Const UFunction BlueprintCallable, Category

TArray< FRig...

 

GetElements()

Returns the keys of all elements within the hierarchy.

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetGlobalTransform

(
    const FRigElementKey& InKey
)

Returns the current global transform of a given element key.

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetInitialGlobalTransform

(
    const FRigElementKey& InKey
)

Returns the initial global transform for a given element key.

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetInitialTransform

(
    const FRigElementKey& InKey
)

Returns the initial transform for a given element key.

Public function Const UFunction BlueprintCallable, Category

FTransform

 

GetLocalTransform

(
    const FRigElementKey& InKey
)

Returns the current local transform of a given element key.

Public function Const UFunction BlueprintCallable, Category

TArray< FRig...

 

GetSelection()

Returns the keys of all selected elements within the hierarchy.

Public function UFunction BlueprintCallable, Category

FRigSpace

 

GetSpace

(
    const FRigElementKey& InKey
)

Returns a single space from provided key.

Public function UFunction BlueprintCallable, Category

TArray< FRig...

 

ImportFromText

(
    const FString& InContent,
    ERigHierarchyImportMode InImportMod...,
    bool bSelectNewElements
)

Imports the content of the provided text and returns the keys created.

Public function UFunction BlueprintCallable, Category

void

 

Initialize

(
    bool bResetTransforms
)

Initializes the rig, but calling reset on all elements.

Public function Const UFunction BlueprintCallable, Category

bool

 

IsSelected

(
    const FRigElementKey& InKey
)

Returns true if a given element is currently selected.

Public function UFunction BlueprintCallable, Category

bool

 

RemoveElement

(
    const FRigElementKey& InElement
)

Removes a single element, returns true if successful.

Public function UFunction BlueprintCallable, Category

FRigElementK...

 

RenameElement

(
    const FRigElementKey& InElement,
    const FName& InNewName
)

Renames an existing element and returns the new element key.

Public function UFunction BlueprintCallable, Category

bool

 

ReparentElement

(
    const FRigElementKey& InElement,
    const FRigElementKey& InNewParent
)

Reparents an element to another element, returns true if successful.

Public function UFunction BlueprintCallable, Category

void

 

Reset()

Removes all elements of the hierarchy.

Public function UFunction BlueprintCallable, Category

void

 

ResetTransforms()

Resets the transforms on all elements of the hierarchy.

Public function UFunction BlueprintCallable, Category

bool

 

Select

(
    const FRigElementKey& InKey,
    bool bSelect
)

Selects or deselects a given element.

Public function UFunction BlueprintCallable, Category

void

 

SetBone

(
    const FRigBone& InElement
)

Updates a single bone.

Public function UFunction BlueprintCallable, Category

void

 

SetControl

(
    const FRigControl& InElement
)

Updates a single control.

Public function UFunction BlueprintCallable, Category

void

 

SetCurve

(
    const FRigCurve& InElement
)

Updates a single curve.

Public function UFunction BlueprintCallable, Category

void

 

SetGlobalTransform

(
    const FRigElementKey& InKey,
    const FTransform& InTransform
)

Sets the current global transform of a given element key.

Public function UFunction BlueprintCallable, Category

void

 

SetInitialGlobalTransform

(
    const FRigElementKey& InKey,
    const FTransform& InTransform
)

Sets the initial global transform for a given element key.

Public function UFunction BlueprintCallable, Category

void

 

SetInitialTransform

(
    const FRigElementKey& InKey,
    const FTransform& InTransform
)

Sets the initial transform for a given element key.

Public function UFunction BlueprintCallable, Category

void

 

SetLocalTransform

(
    const FRigElementKey& InKey,
    const FTransform& InTransform
)

Sets the current local transform of a given element key.

Public function UFunction BlueprintCallable, Category

void

 

SetSpace

(
    const FRigSpace& InElement
)

Updates a single space.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss