1. Epic GamesDeveloper
  3. AControlRigShapeActor

AControlRigShapeActor

An actor used to represent a rig control

API > API/Plugins > API/Plugins/ControlRig

Inheritance Hierarchy

  • AActor
  • IViewportSelectableObject
  • AControlRigShapeActor

References

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

Syntax

UCLASS (NotPlaceable, Transient)  
class AControlRigShapeActor :  
    public AActor,  
    public IViewportSelectableObject

Remarks

An actor used to represent a rig control

Variables

  Type Name Description
Public variable UProperty TObjectPtr< class USceneComponent > ActorRootComponent This is the one holding transform for the controls
Public variable UProperty FName ColorParameterName The name of the color parameter on the material
Public variable UProperty FName ControlName The name of the control this actor is referencing
Public variable UProperty TWeakObjectPtr< UControlRig > ControlRig Control rig this actor is referencing we can have multiple control rig's visible
Public variable UProperty uint32 ControlRigIndex The name of the control this actor is referencing
Public variable FTransform OffsetTransform  
Public variable FLinearColor OverrideColor  
Public variable UProperty FName ShapeName The name of the shape to use on this actor
Public variable UProperty Category, Meta BlueprintReadOnly visibleanywhere TObjectPtr< class UStaticMeshComponent > StaticMeshComponent This is visual representation of the transform

Constructors

  Type Name Description
Public function  

AControlRigShapeActor ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const FRigElementKey Returns the key of the control element this shape actor represents
Public function Const UFunction BlueprintPure, Category FTransform  
Public function Virtual Const UFunction blueprintgetter bool Get whether the control is enabled/disabled
Public function Virtual Const UFunction blueprintgetter bool Get whether the control is hovered
Public function Virtual Const bool Get wether the control is selectable/unselectable
Public function Virtual Const UFunction blueprintgetter bool Get whether the control is selected/unselected
Public function UFunction BlueprintImplementableEvent void

OnEnabledChanged ( bool bIsEnabled
)

 Event called when the enabled state of this control has changed
Public function UFunction BlueprintImplementableEvent void

OnHoveredChanged ( bool bIsSelected
)

 Event called when the hovered state of this control has changed
Public function UFunction BlueprintImplementableEvent void

OnManipulatingChanged ( bool bIsManipulating
)

 Event called when the manipulating state of this control has changed
Public function UFunction BlueprintImplementableEvent void

OnSelectionChanged ( bool bIsSelected
)

 Event called when the selection state of this control has changed
Public function UFunction BlueprintImplementableEvent void

OnTransformChanged ( const FTransform& NewTransform
)

 Event called when the transform of this control has changed
Public function Virtual UFunction blueprintsetter void

SetEnabled ( bool bInEnabled
)

 Set the control to be enabled/disabled
Public function UFunction BlueprintCallable, Category void

SetGlobalTransform ( const FTransform& InTransform
)

 This returns root component transform based on attach when there is no attach, it is based on 0
Public function Virtual UFunction blueprintsetter void

SetHovered ( bool bInHovered
)

 Set the control to be hovered
Public function Virtual UFunction blueprintsetter void

SetSelectable ( bool bInSelectable
)

 Set the control to be selected/unselected
Public function Virtual UFunction blueprintsetter void

SetSelected ( bool bInSelected
)

 Set the control to be selected/unselected
Public function Virtual void

SetShapeColor ( const FLinearColor& InColor
)

 Changes the shape color
Public function Virtual void Called from the edit mode each tick
Public function bool

UpdateControlSettings ( ERigHierarchyNotification InNotif,
UControlRig* InControlRig,
const FRigControlElement* InControlElement,
bool bHideManipulators,
bool bIsInLevelEditor
)

 Try to update the actor with the latest settings

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page