SCR_TooltipPositionPreset Interface Reference

Public Member Functions
void	GetGoalPosition (vector tooltipSize, Widget hoverWidget, vector absolutePosition, out vector goalPosition, out vector goalAlignment, out vector goalAlpha)
	Requires DPI scaled values.
bool	CheckOverflow (float tooltipSize, float maxAreaSize, inout float desiredPos, inout float offset, inout float alignment)
	Returns true if the desired position causes the Tooltip to overflow, and prevents it by inverting the alignment.
float	GetContentAlignmentHorizontal ()
float	GetContentAlignmentVertical ()

Public Attributes
SCR_ETooltipAnchor	m_eAnchor
SCR_ETooltipAlignmentHorizontal	m_eHorizontalAlignment
SCR_ETooltipAlignmentVertical	m_eVerticalAlignment
vector	m_vOffset
SCR_ETooltipOverflowHandling	m_eOverflowHandling

Static Public Attributes
const float	ALIGNMENT_CENTER = 0.5
const float	ALIGNMENT_LEFT_TOP = 0
const float	ALIGNMENT_RIGHT_DOWN = 1

Protected Member Functions
void	CalculateGoalPosition (int alignmentCase, float targetSize, float tooltipSize, float maxAreaSize, inout float desiredPos, inout float offset, inout float alignment)

Member Function Documentation

CalculateGoalPosition()

void SCR_TooltipPositionPreset.CalculateGoalPosition ( int  alignmentCase, float  targetSize, float  tooltipSize, float  maxAreaSize, inout float  desiredPos, inout float  offset, inout float  alignment  )

protected

CheckOverflow()

bool SCR_TooltipPositionPreset.CheckOverflow	(	float	tooltipSize,
		float	maxAreaSize,
		inout float	desiredPos,
		inout float	offset,
		inout float	alignment
	)

Returns true if the desired position causes the Tooltip to overflow, and prevents it by inverting the alignment.

The tooltip is forcefully anchored to 0, 0 on Show(), so we just need to work with alignment

GetContentAlignmentHorizontal()

float SCR_TooltipPositionPreset.GetContentAlignmentHorizontal

(

)

GetContentAlignmentVertical()

float SCR_TooltipPositionPreset.GetContentAlignmentVertical

(

)

GetGoalPosition()

void SCR_TooltipPositionPreset.GetGoalPosition	(	vector	tooltipSize,
		Widget	hoverWidget,
		vector	absolutePosition,
		out vector	goalPosition,
		out vector	goalAlignment,
		out vector	goalAlpha
	)

Requires DPI scaled values.

Member Data Documentation

ALIGNMENT_CENTER

const float SCR_TooltipPositionPreset.ALIGNMENT_CENTER = 0.5

static

ALIGNMENT_LEFT_TOP

const float SCR_TooltipPositionPreset.ALIGNMENT_LEFT_TOP = 0

static

ALIGNMENT_RIGHT_DOWN

const float SCR_TooltipPositionPreset.ALIGNMENT_RIGHT_DOWN = 1

static

m_eAnchor

SCR_ETooltipAnchor SCR_TooltipPositionPreset.m_eAnchor

m_eHorizontalAlignment

SCR_ETooltipAlignmentHorizontal SCR_TooltipPositionPreset.m_eHorizontalAlignment

m_eOverflowHandling

SCR_ETooltipOverflowHandling SCR_TooltipPositionPreset.m_eOverflowHandling

m_eVerticalAlignment

SCR_ETooltipAlignmentVertical SCR_TooltipPositionPreset.m_eVerticalAlignment

m_vOffset

vector SCR_TooltipPositionPreset.m_vOffset

---

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

• Game/UI/Components/WidgetLibrary/SCR_ScriptedWidgetTooltip.c