UGizmoComponentAxisSource

[UGizmoComponentAxisSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\UGizmoComponentAxisSource) is an [IGizmoAxisSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoAxisSource) implementation that provides one of the X/Y/Z axes of a Component's local coordinate system, mapped to World, based on an integer AxisIndex in range [0,2].

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UGizmoComponentAxisSource

References

Module

InteractiveToolsFramework

Header

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

Include

#include "BaseGizmos/AxisSources.h"

Syntax

class UGizmoComponentAxisSource :
    public UObject,
    public IGizmoAxisSource

Remarks

UGizmoComponentAxisSource is an IGizmoAxisSource implementation that provides one of the X/Y/Z axes of a Component's local coordinate system, mapped to World, based on an integer AxisIndex in range [0,2]. The Axis Origin is the Component's transform origin. Tangent vectors are provided.

Variables

Name Description

Public variable

int

 

AxisIndex

Clamped internally to 0,1,2

Public variable

bool

 

bLocalAxes

If false, returns World axes

Public variable

TObjectPtr< USc...

 

Component

Functions

Name Description

Public function Static

UGizmoCompon...

 

Construct

(
    USceneComponent* ComponentIn,
    int LocalAxisIndex,
    bool bUseLocalAxes,
    UObject* Outer
)

Overridden from IGizmoAxisSource

Name Description

Public function Virtual Const

FVector

 

GetDirection()

Public function Virtual Const

FVector

 

GetOrigin()

Public function Virtual Const

void

 

GetTangentVectors

(
    FVector& TangentXOut,
    FVector& TangentYOut
)

Get the two tangent vectors that are orthogonal to the Direction vector.

Public function Virtual Const

bool

 

HasTangentVectors()