SCR_CaptureAndHoldObjectiveDisplayObject Interface Reference

This object serves as a wrapper for individual HUD objective widgets. More...

Public Member Functions
SCR_CaptureAndHoldArea	GetArea ()
	Returns the area this element represents.
Widget	GetRootWidget ()
	Returns root widget of this element.
void	SCR_CaptureAndHoldObjectiveDisplayObject (notnull Widget root, notnull SCR_CaptureAndHoldArea area)
	Create new wrapper for objective display.
void	UpdateStatic (float timeSlice)
	Update this widget as static UI element, ie. not reprojecting it automatically.
void	UpdateDynamic (IEntity playerEntity, float timeSlice)
	Update this widget as dynamic UI element projected to screen space.

Protected Member Functions
void	UpdateImageState (Widget root, float timeSlice)
	Update image state according to provided area state.

Protected Attributes
Widget	m_wRoot
	Topmost widget of this object.
TextWidget	m_wDistanceText
	Text that displays objective distance.
TextWidget	m_wNameText
	Text that displays name or symbol of the objective.
ImageWidget	m_wIcon
	The objective image.
ImageWidget	m_wUnderAttackIcon
	The objective is under attack symbol image.
ImageWidget	m_wMajorIcon
	The major objective symbol image.
ImageWidget	m_wBackdropIcon
	The backdrop image of this element.
VerticalLayoutWidget	m_wLayout
float	m_fBlendScreenPosition
	Blend progress of when within the area.
float	m_fOriginalXSize
float	m_fOriginalYSize
float	m_fOriginalTitleSize
float	m_fOriginalTextSize
SCR_CaptureAndHoldArea	m_AffiliatedArea
	The area this object represents.

Static Protected Attributes
const float	COLOR_BLEND_SPEED = 5.5
	Color blending rate.
const float	POSITION_BLEND_SPEED = 2.5
	Position blending rate.
const int	ATLAS_INDEX_NEUTRAL = 0
const int	ATLAS_INDEX_BLUFOR = 1
const int	ATLAS_INDEX_OPFOR = 2

Detailed Description

This object serves as a wrapper for individual HUD objective widgets.

Constructor & Destructor Documentation

SCR_CaptureAndHoldObjectiveDisplayObject()

void SCR_CaptureAndHoldObjectiveDisplayObject.SCR_CaptureAndHoldObjectiveDisplayObject	(	notnull Widget	root,
		notnull SCR_CaptureAndHoldArea	area
	)

Create new wrapper for objective display.

Member Function Documentation

GetArea()

SCR_CaptureAndHoldArea SCR_CaptureAndHoldObjectiveDisplayObject.GetArea

(

)

Returns the area this element represents.

GetRootWidget()

Widget SCR_CaptureAndHoldObjectiveDisplayObject.GetRootWidget

(

)

Returns root widget of this element.

UpdateDynamic()

void SCR_CaptureAndHoldObjectiveDisplayObject.UpdateDynamic	(	IEntity	playerEntity,
		float	timeSlice
	)

Update this widget as dynamic UI element projected to screen space.

UpdateImageState()

void SCR_CaptureAndHoldObjectiveDisplayObject.UpdateImageState ( Widget  root, float  timeSlice  )

protected

Update image state according to provided area state.

UpdateStatic()

void SCR_CaptureAndHoldObjectiveDisplayObject.UpdateStatic

(

float

timeSlice

)

Update this widget as static UI element, ie. not reprojecting it automatically.

Member Data Documentation

ATLAS_INDEX_BLUFOR

const int SCR_CaptureAndHoldObjectiveDisplayObject.ATLAS_INDEX_BLUFOR = 1

staticprotected

ATLAS_INDEX_NEUTRAL

const int SCR_CaptureAndHoldObjectiveDisplayObject.ATLAS_INDEX_NEUTRAL = 0

staticprotected

ATLAS_INDEX_OPFOR

const int SCR_CaptureAndHoldObjectiveDisplayObject.ATLAS_INDEX_OPFOR = 2

staticprotected

COLOR_BLEND_SPEED

const float SCR_CaptureAndHoldObjectiveDisplayObject.COLOR_BLEND_SPEED = 5.5

staticprotected

Color blending rate.

m_AffiliatedArea

SCR_CaptureAndHoldArea SCR_CaptureAndHoldObjectiveDisplayObject.m_AffiliatedArea

protected

The area this object represents.

m_fBlendScreenPosition

float SCR_CaptureAndHoldObjectiveDisplayObject.m_fBlendScreenPosition

protected

Blend progress of when within the area.

m_fOriginalTextSize

float SCR_CaptureAndHoldObjectiveDisplayObject.m_fOriginalTextSize

protected

m_fOriginalTitleSize

float SCR_CaptureAndHoldObjectiveDisplayObject.m_fOriginalTitleSize

protected

m_fOriginalXSize

float SCR_CaptureAndHoldObjectiveDisplayObject.m_fOriginalXSize

protected

m_fOriginalYSize

float SCR_CaptureAndHoldObjectiveDisplayObject.m_fOriginalYSize

protected

m_wBackdropIcon

ImageWidget SCR_CaptureAndHoldObjectiveDisplayObject.m_wBackdropIcon

protected

The backdrop image of this element.

m_wDistanceText

TextWidget SCR_CaptureAndHoldObjectiveDisplayObject.m_wDistanceText

protected

Text that displays objective distance.

m_wIcon

ImageWidget SCR_CaptureAndHoldObjectiveDisplayObject.m_wIcon

protected

The objective image.

m_wLayout

VerticalLayoutWidget SCR_CaptureAndHoldObjectiveDisplayObject.m_wLayout

protected

m_wMajorIcon

ImageWidget SCR_CaptureAndHoldObjectiveDisplayObject.m_wMajorIcon

protected

The major objective symbol image.

m_wNameText

TextWidget SCR_CaptureAndHoldObjectiveDisplayObject.m_wNameText

protected

Text that displays name or symbol of the objective.

m_wRoot

Widget SCR_CaptureAndHoldObjectiveDisplayObject.m_wRoot

protected

Topmost widget of this object.

m_wUnderAttackIcon

ImageWidget SCR_CaptureAndHoldObjectiveDisplayObject.m_wUnderAttackIcon

protected

The objective is under attack symbol image.

POSITION_BLEND_SPEED

const float SCR_CaptureAndHoldObjectiveDisplayObject.POSITION_BLEND_SPEED = 2.5

staticprotected

Position blending rate.

---

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

• Game/UI/CaptureAndHold/SCR_CaptureAndHoldObjectiveDisplayObject.c