AGizmoActor

[AGizmoActor](API\Runtime\InteractiveToolsFramework\BaseGizmos\AGizmoActor) is a base class for Actors that would be created to represent Gizmos in the scene.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/GizmoActor.h

Include

#include "BaseGizmos/GizmoActor.h"

Syntax

class AGizmoActor : public AInternalToolFrameworkActor

Remarks

AGizmoActor is a base class for Actors that would be created to represent Gizmos in the scene. Currently this does not involve any special functionality, but a set of static functions are provided to create default Components commonly used in Gizmos.

Constructors

Name Description

Public function

AGizmoActor()

Functions

Name Description

Public function Static

UGizmoArrowC...

 

AddDefaultArrowComponent

(
    UWorld* World,
    AActor* Actor,
    UGizmoViewContext* GizmoViewCo...,
    const FLinearColor& Color,
    const FVector& LocalDirection,
    const float Length
)

Add standard arrow component to Actor, generally used for axis-translation

Public function Static

UGizmoBoxCom...

 

AddDefaultBoxComponent

(
    UWorld* World,
    AActor* Actor,
    UGizmoViewContext* GizmoViewCo...,
    const FLinearColor& Color,
    const FVector& Origin,
    const FVector& Dimensions
)

Add standard 3D box component to Actor.

Public function Static

UGizmoCircle...

 

AddDefaultCircleComponent

(
    UWorld* World,
    AActor* Actor,
    UGizmoViewContext* GizmoViewCo...,
    const FLinearColor& Color,
    const FVector& PlaneNormal,
    float Radius
)

Add standard circle component to Actor, generally used for axis-rotation

Public function Static

UGizmoLineHa...

 

AddDefaultLineHandleComponent

(
    UWorld* World,
    AActor* Actor,
    UGizmoViewContext* GizmoViewCo...,
    const FLinearColor& Color,
    const FVector& PlaneNormal,
    const FVector& LocalDirection,
    const float Length,
    const bool bImageScale
)

Add standard disk component to Actor, generally used for handles

Public function Static

UGizmoRectan...

 

AddDefaultRectangleComponent

(
    UWorld* World,
    AActor* Actor,
    UGizmoViewContext* GizmoViewCo...,
    const FLinearColor& Color,
    const FVector& PlaneAxis1,
    const FVector& PlaneAxisx2
)

Add standard rectangle component to Actor, generally used for plane-translation