IGizmoAxisSource

[IGizmoAxisSource](API\Runtime\InteractiveToolsFramework\BaseGizmos\IGizmoAxisSource) is an interface which is used to get information about a 3D Axis.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

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

Include

#include "BaseGizmos/GizmoInterfaces.h"

Syntax

class IGizmoAxisSource

Remarks

IGizmoAxisSource is an interface which is used to get information about a 3D Axis. At minimum this includes a 3D Direction Vector and Origin Point. Optionally the implementation may provide two Tangent Vectors which are assumed to be mutually-orthogonal and perpendicular to the Axis Direction (ie that's the normal and the 3 vectors form a coordinate frame).

Functions

Name Description

Public function Const

void

 

GetAxisFrame

(
    FVector& PlaneNormalOut,
    FVector& PlaneAxis1Out,
    FVector& PlaneAxis2Out
)

Utility function that always returns a 3D coordinate system (ie plane normal and perpendicular axes).

Public function Const

FVector

 

GetDirection()

Public function 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()