IControlRigManipulatable

Windows
MacOS
Linux

Inheritance Hierarchy

IControlRigManipulatable

UControlRig

UAdditiveControlRig

References

Module

ControlRig

Header

/Engine/Plugins/Experimental/ControlRig/Source/ControlRig/Public/Manipulatable/IControlRigManipulatable.h

Include

#include "Manipulatable/IControlRigManipulatable.h"

Syntax

class IControlRigManipulatable

Constructors

Name Description

Public function

IControlRigManipulatable()

Functions

Name Description

Public function Const

const TArray...

 

AvailableControls()

Returns a list of available controls on the subject.

Public function Const

const TArray...

 

AvailableSpaces()

Returns a list of available spaces on the subject.

Public function

bool

 

ClearControlSelection()

Clear selection on all controls.

Public function

FFilterContr...

 

ControlFilter()

Returns a event that can be used to subscribe to filtering control data when needed

Public function

FControlModi...

 

ControlModified()

Returns a event that can be used to subscribe to change notifications coming from the manipulated subject.

Public function

FControlSele...

 

ControlSelected()

Returns a event that can be used to subscribe to selection changes coming from the manipulated subject.

Public function Virtual

void

 

CreateRigControlsForCurveContainer()

Create RigControls for Curves, they will get added to the AvailableControls.

Public function Const

TArray< FNam...

 

CurrentControlSelection()

Get the current selection.

Public function

FRigControl ...

 

FindControl

(
    const FName& InControlName
)

Returns a control given its name.

Public function

FRigSpace &#...

 

FindSpace

(
    const FName& InSpaceName
)

Returns a space given its name.

Public function Const

FTransform

 

GetControlGlobalTransform

(
    const FName& InControlName
)

Returns the global / world transform of a Control.

Public function

const FRigCo...

 

GetControlValue

(
    const FName& InControlName
)

Returns the value of a Control.

Public function

FRigControlV...

 

GetControlValueFromGlobalTransform

(
    const FName& InControlName,
    const FTransform& InGlobalTransfor...
)

Returns the value given a global transform.

Public function Virtual Const

UControlRigG...

 

GetGizmoLibrary()

Returns the gizmo library used for generating gizmos.

Public function Const

FString

 

GetName()

Get Name.

Public function Virtual Const

TSharedPtr< ...

 

GetObjectBinding()

Get bindings to a runtime object.

Public function

FTransform

 

GetSpaceGlobalTransform

(
    const FName& InSpaceName
)

Gets a space's transform given a global / world transform.

Public function Const

bool

 

IsControlSelected

(
    const FName& InControlName
)

Is the Specified Control Selected.

Public function Virtual Const

bool

 

ManipulationEnabled()

Returns true if this manipulatable subject is currently available for manipulation / is enabled.

Public function

void

 

SelectControl

(
    const FName& InControlName,
    bool bSelect
)

Select or deselected the specified control.

Public function

bool

 

SetControlGlobalTransform

(
    const FName& InControlName,
    const FTransform& InGlobalTransfor...,
    EControlRigSetKey InSetKey
)

Sets the global / world transform of a Control.

Public function

bool

 

SetControlSpace

(
    const FName& InControlName,
    const FName& InSpaceName
)

Sets a Control's Space (for space switching), returns true when successful.

Public function

void

 

SetControlValue

(
    const FName& InControlName,
    const FRigControlValue& InValue,
    bool bNotify,
    EControlRigSetKey InSetKey
)

Sets the relative value of a Control.

Public function

void

 

SetControlValue

(
    const FName& InControlName,
    T InValue,
    bool bNotify,
    EControlRigSetKey InSetKey
)

Sets the relative value of a Control.

Public function Virtual

bool

 

SetManipulationEnabled

(
    bool Enabled
)

Sets the manipulatable subject to enabled or disabled.

Public function Virtual

void

 

SetObjectBinding

Set Object Binding.

Public function

bool

 

SetSpaceGlobalTransform

(
    const FName& InSpaceName,
    const FTransform& InTransform
)

Sets a space's transform given a global / world transform. Returns true when successful.

Classes

Name

Description

Public class

FControlModifiedEvent

Bindable event for external objects to be notified of Control changes

Public class

FControlSelectedEvent

Bindable event for external objects to be notified that a Control is Selected

Public class

FFilterControlEvent

Bindable event for external objects to contribute to / filter a control value

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