IAxisDisplayInfo Class Reference

#include <AxisDisplayInfo.h>

Inheritance diagram for IAxisDisplayInfo:

Public Member Functions
virtual	~IAxisDisplayInfo ()=default
virtual EAxisList::Type	GetAxisDisplayCoordinateSystem () const =0
virtual FText	GetAxisToolTip (EAxisList::Type Axis) const =0
virtual FText	GetAxisDisplayName (EAxisList::Type Axis)=0
virtual FText	GetAxisDisplayNameShort (EAxisList::Type Axis)=0
virtual FLinearColor	GetAxisColor (EAxisList::Type Axis)=0
virtual FText	GetRotationAxisToolTip (EAxisList::Type Axis) const =0
virtual FText	GetRotationAxisName (EAxisList::Type Axis)=0
virtual FText	GetRotationAxisNameShort (EAxisList::Type Axis)=0
virtual FIntVector4	DefaultAxisComponentDisplaySwizzle () const =0
virtual bool	UseForwardRightUpDisplayNames ()=0

Static Public Member Functions
static FName	GetModularFeatureName ()

Constructor & Destructor Documentation

~IAxisDisplayInfo()

virtual IAxisDisplayInfo::~IAxisDisplayInfo ( )

virtualdefault

Member Function Documentation

DefaultAxisComponentDisplaySwizzle()

virtual FIntVector4 IAxisDisplayInfo::DefaultAxisComponentDisplaySwizzle ( ) const

pure virtual

Defines the swizzle for slate widgets displaying axis components such as SVectorInputBox and SRotatorInputBox Generally, these widgets will be ordered X, Y and Z

GetAxisColor()

virtual FLinearColor IAxisDisplayInfo::GetAxisColor ( EAxisList::Type  Axis )

pure virtual

Gets the color to use for the given axis.

Parameters

Axis	The axis whose color you are requesting

Returns

The color corresponding to the given axis

GetAxisDisplayCoordinateSystem()

virtual EAxisList::Type IAxisDisplayInfo::GetAxisDisplayCoordinateSystem ( ) const

pure virtual

Gets the axis display coordinate system to use.

The return value may be driven by the config system and therefore it should not be cached until the editor has finished loading.

Returns

The display coordinate system, either EAxisList::XYZ or EAxisList::LeftUpForward

GetAxisDisplayName()

virtual FText IAxisDisplayInfo::GetAxisDisplayName ( EAxisList::Type  Axis )

pure virtual

Gets the display name to use for the given axis.

Parameters

Axis	The axis whose display name you are requesting

Returns

The display name corresponding to the given axis

GetAxisDisplayNameShort()

virtual FText IAxisDisplayInfo::GetAxisDisplayNameShort ( EAxisList::Type  Axis )

pure virtual

Gets the short display name to use for the given axis.

Parameters

Axis	The axis whose short display name you are requesting

Returns

The short display name corresponding to the given axis

GetAxisToolTip()

virtual FText IAxisDisplayInfo::GetAxisToolTip ( EAxisList::Type  Axis ) const

pure virtual

Gets the tool tip text used for axis components of widgets describing translations and scales

GetModularFeatureName()

static FName IAxisDisplayInfo::GetModularFeatureName ( )

inlinestatic

GetRotationAxisName()

virtual FText IAxisDisplayInfo::GetRotationAxisName ( EAxisList::Type  Axis )

pure virtual

Gets the display name use for axis components of widgets describing rotations Typically this would be used as a label or title

GetRotationAxisNameShort()

virtual FText IAxisDisplayInfo::GetRotationAxisNameShort ( EAxisList::Type  Axis )

pure virtual

Gets a short display name use for axis components of widgets describing rotations Typically this would be used as a label or title where little room is available

GetRotationAxisToolTip()

virtual FText IAxisDisplayInfo::GetRotationAxisToolTip ( EAxisList::Type  Axis ) const

pure virtual

Gets the tool tip text used for axis components of widgets describing rotations

UseForwardRightUpDisplayNames()

virtual bool IAxisDisplayInfo::UseForwardRightUpDisplayNames ( )

pure virtual

Gets whether or not the engine uses forward/right/up nomenclature for display names.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Core/Public/Misc/AxisDisplayInfo.h