1. Epic GamesDeveloper
  3. AControlRigShapeActor

AControlRigShapeActor

An actor used to represent a rig control

API > API/Plugins > API/Plugins/ControlRig

An actor used to represent a rig control

   
Name AControlRigShapeActor
Type class
Header File /Engine/Plugins/Animation/ControlRig/Source/ControlRig/Public/ControlRigGizmoActor.h
Include Path #include "ControlRigGizmoActor.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

AControlRigShapeActor ( const FObjectInitializer& ObjectInitializer
)

   ControlRigGizmoActor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActorRootComponent TObjectPtr< class USceneComponent > This is the one holding transform for the controls ControlRigGizmoActor.h  
CachedIndex FCachedRigElement   ControlRigGizmoActor.h  
ColorParameterName FName The name of the color parameter on the material ControlRigGizmoActor.h  
ControlName FName The name of the control this actor is referencing ControlRigGizmoActor.h  
ControlRig TWeakObjectPtr< UControlRig > Control rig this actor is referencing we can have multiple control rig's visible ControlRigGizmoActor.h  
ControlRigIndex uint32 The name of the control this actor is referencing ControlRigGizmoActor.h  
OffsetTransform FTransform   ControlRigGizmoActor.h  
OverrideColor FLinearColor   ControlRigGizmoActor.h  
ShapeName FName The name of the shape to use on this actor ControlRigGizmoActor.h  
StaticMeshComponent TObjectPtr< class UStaticMeshComponent > This is visual representation of the transform ControlRigGizmoActor.h
  • Category=StaticMesh
  • VisibleAnywhere
  • BlueprintReadOnly
  • Meta=(ExposeFunctionCategories="Mesh,Rendering,Physics,Components|StaticMesh", AllowPrivateAccess="true")

Protected

Name Type Remarks Include Path Unreal Specifiers
bHovered uint8 Whether this control is hovered ControlRigGizmoActor.h
  • BlueprintGetter=IsHovered
  • BlueprintSetter=SetHovered
  • Category="ControlRig|Shape"
bSelectable uint8 Whether or not this control is selectable ControlRigGizmoActor.h  
bSelected uint8 Whether this control is selected ControlRigGizmoActor.h
  • BlueprintGetter=IsSelectedInEditor
  • BlueprintSetter=SetSelected
  • Category="ControlRig|Shape"
CurrentColor FLinearColor Current color used to avoid color updates when unnecessary ControlRigGizmoActor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FRigElementKey GetElementKey()

 Returns the key of the control element this shape actor represents ControlRigGizmoActor.h  

FTransform GetGlobalTransform()

   ControlRigGizmoActor.h
  • BlueprintPure
  • Category="ControlRig|Shape"

virtual bool IsEnabled()

 Get whether the control is enabled/disabled ControlRigGizmoActor.h
  • BlueprintGetter

virtual bool IsHovered()

 Get whether the control is hovered ControlRigGizmoActor.h
  • BlueprintGetter

void OnEnabledChanged ( bool bIsEnabled
)

 Event called when the enabled state of this control has changed ControlRigGizmoActor.h
  • BlueprintImplementableEvent

void OnHoveredChanged ( bool bIsSelected
)

 Event called when the hovered state of this control has changed ControlRigGizmoActor.h
  • BlueprintImplementableEvent

void OnManipulatingChanged ( bool bIsManipulating
)

 Event called when the manipulating state of this control has changed ControlRigGizmoActor.h
  • BlueprintImplementableEvent

void OnSelectionChanged ( bool bIsSelected
)

 Event called when the selection state of this control has changed ControlRigGizmoActor.h
  • BlueprintImplementableEvent

void OnTransformChanged ( const FTransform& NewTransform
)

 Event called when the transform of this control has changed ControlRigGizmoActor.h
  • BlueprintImplementableEvent

virtual void SetEnabled ( bool bInEnabled
)

 Set the control to be enabled/disabled ControlRigGizmoActor.h
  • BlueprintSetter

void SetGlobalTransform ( const FTransform& InTransform
)

 This returns root component transform based on attach when there is no attach, it is based on 0 ControlRigGizmoActor.h
  • BlueprintCallable
  • Category="ControlRig|Shape"

virtual void SetHovered ( bool bInHovered
)

 Set the control to be hovered ControlRigGizmoActor.h
  • BlueprintSetter

virtual void SetSelectable ( bool bInSelectable
)

 Set the control to be selected/unselected ControlRigGizmoActor.h
  • BlueprintSetter

virtual void SetSelected ( bool bInSelected
)

 Set the control to be selected/unselected ControlRigGizmoActor.h
  • BlueprintSetter

virtual void SetShapeColor ( const FLinearColor& InColor,
const bool bForce
)

 Changes the shape color ControlRigGizmoActor.h  

virtual void TickControl()

 Called from the edit mode each tick ControlRigGizmoActor.h  

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

 Try to update the actor with the latest settings ControlRigGizmoActor.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual bool IsSelectable()

 Get wether the control is selectable/unselectable ControlRigGizmoActor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsSelectedInEditor()

 Get whether the control is selected/unselected ControlRigGizmoActor.h
  • BlueprintGetter

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page