AxisDisplayInfo Namespace Reference

Functions
CORE_API EAxisList::Type	GetAxisDisplayCoordinateSystem ()
CORE_API FText	GetAxisDisplayName (EAxisList::Type Axis)
CORE_API FText	GetAxisDisplayNameShort (EAxisList::Type Axis)
CORE_API FText	GetAxisToolTip (EAxisList::Type Axis)
CORE_API FLinearColor	GetAxisColor (EAxisList::Type Axis)
CORE_API bool	UseForwardRightUpDisplayNames ()
CORE_API FText	GetRotationAxisName (EAxisList::Type Axis)
CORE_API FText	GetRotationAxisNameShort (EAxisList::Type Axis)
CORE_API FText	GetRotationAxisToolTip (EAxisList::Type Axis)
CORE_API FIntVector4	GetTransformAxisSwizzle ()

Function Documentation

GetAxisColor()

FLinearColor AxisDisplayInfo::GetAxisColor

(

EAxisList::Type

Axis

)

Gets the color to use for the given axis.

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

Parameters

Axis	The axis whose color you are requesting

Returns

The color corresponding to the given axis

GetAxisDisplayCoordinateSystem()

EAxisList::Type AxisDisplayInfo::GetAxisDisplayCoordinateSystem

(

)

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

FText AxisDisplayInfo::GetAxisDisplayName

(

EAxisList::Type

Axis

)

Gets the display name to use for the given axis.

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

Parameters

Axis	The axis whose display name you are requesting

Returns

The display name corresponding to the given axis

GetAxisDisplayNameShort()

FText AxisDisplayInfo::GetAxisDisplayNameShort

(

EAxisList::Type

Axis

)

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

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

Parameters

Axis	The axis whose short display name you are requesting

Returns

The short display name corresponding to the given axis

GetAxisToolTip()

FText AxisDisplayInfo::GetAxisToolTip

(

EAxisList::Type

Axis

)

GetRotationAxisName()

CORE_API FText AxisDisplayInfo::GetRotationAxisName

(

EAxisList::Type

Axis

)

GetRotationAxisNameShort()

FText AxisDisplayInfo::GetRotationAxisNameShort

(

EAxisList::Type

Axis

)

GetRotationAxisToolTip()

FText AxisDisplayInfo::GetRotationAxisToolTip

(

EAxisList::Type

Axis

)

GetTransformAxisSwizzle()

FIntVector4 AxisDisplayInfo::GetTransformAxisSwizzle

(

)

Default swizzle for displaying axis in transform displays Swizzle maps from the default X, Y, Z, W positions to new position { 1, 2, 0, 3 } would map position 0 to fetch Y, position 1 to fetch Z, etc

UseForwardRightUpDisplayNames()

bool AxisDisplayInfo::UseForwardRightUpDisplayNames

(

)

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

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