#include <GizmoInterfaces.h>

Inheritance diagram for IGizmoAxisSource:

Public Member Functions
virtual FVector	GetOrigin () const =0

virtual FVector	GetDirection () const =0

virtual bool	HasTangentVectors () const

virtual void	GetTangentVectors (FVector &TangentXOut, FVector &TangentYOut) const

INTERACTIVETOOLSFRAMEWORK_API void	GetAxisFrame (FVector &PlaneNormalOut, FVector &PlaneAxis1Out, FVector &PlaneAxis2Out) const

Detailed Description

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).

Member Function Documentation

◆ GetAxisFrame()

void IGizmoAxisSource::GetAxisFrame	(	FVector &	PlaneNormalOut,
		FVector &	PlaneAxis1Out,
		FVector &	PlaneAxis2Out
	)		const

Utility function that always returns a 3D coordinate system (ie plane normal and perpendicular axes). Internally calls GetTangentVectors() if available, otherwise constructs arbitrary mutually perpendicular vectors.

◆ GetDirection()

virtual FVector IGizmoAxisSource::GetDirection ( ) const

pure virtual

Returns: Direction Vector of axis

Implemented in UGizmoConstantAxisSource, UGizmoConstantFrameAxisSource, UGizmoWorldAxisSource, and UGizmoComponentAxisSource.

◆ GetOrigin()

virtual FVector IGizmoAxisSource::GetOrigin ( ) const

pure virtual

Returns: Origin Point of axis

Implemented in UGizmoConstantAxisSource, UGizmoConstantFrameAxisSource, UGizmoWorldAxisSource, and UGizmoComponentAxisSource.

◆ GetTangentVectors()

virtual void IGizmoAxisSource::GetTangentVectors	(	FVector &	TangentXOut,
		FVector &	TangentYOut
	)		const

inlinevirtual

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

Warning: Only valid if HasTangentVectors() returns true

Reimplemented in UGizmoComponentAxisSource, and UGizmoConstantFrameAxisSource.

◆ HasTangentVectors()

virtual bool IGizmoAxisSource::HasTangentVectors ( ) const