SCR_CompassUIComponent Interface Reference

Simple radial compass which will rotate based on current camera position. More...

Inheritance diagram for SCR_CompassUIComponent:

Public Member Functions
void	UpdateRotation (float timeSlice)
	Update compass rtation base don the current view.
override void	HandlerAttachedScripted (Widget w)
	Event called when subcomponent is initialized.
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from MenuRootSubComponent
Widget	GetWidget ()
	Get widget to which the component belongs to.
MenuRootBase	GetMenu ()
	Get menu of which the widget is part of.
MenuRootComponent	GetRootComponent ()
	Get root component of this subcomponent,.
override void	HandlerAttached (Widget w)

Protected Attributes
float	m_fLabelsDistance
string	m_sTextureWidgetName
string	m_sEastWidgetName
string	m_sSouthWidgetName
string	m_sWestWidgetName
string	m_sNorthWidgetName
BaseWorld	m_World
ImageWidget	m_TextureWidget
ref map< Widget, float >	m_Labels = new map<Widget, float>

Additional Inherited Members
Protected Member Functions inherited from MenuRootSubComponent
bool	IsUnique ()
	Is the component to exist only in one instance?

Detailed Description

Simple radial compass which will rotate based on current camera position.

Has to be attached to MenuRootBase to be updated automatically, otherwise call UpdateRotation() manually.

Member Function Documentation

HandlerAttachedScripted()

override void SCR_CompassUIComponent.HandlerAttachedScripted

(

Widget

w

)

Event called when subcomponent is initialized.

Called only after all other subcomponents were registered as well and can be searched for. To be overwritten by inherited classes.

Parameters

Widget

Implements MenuRootSubComponent.

HandlerDeattached()

override void SCR_CompassUIComponent.HandlerDeattached

(

Widget

w

)

Implements MenuRootSubComponent.

UpdateRotation()

void SCR_CompassUIComponent.UpdateRotation

(

float

timeSlice

)

Update compass rtation base don the current view.

Parameters

timeSlice

Time since the last frame

Member Data Documentation

m_fLabelsDistance

float SCR_CompassUIComponent.m_fLabelsDistance

protected

m_Labels

ref map<Widget, float> SCR_CompassUIComponent.m_Labels = new map<Widget, float>

protected

m_sEastWidgetName

string SCR_CompassUIComponent.m_sEastWidgetName

protected

m_sNorthWidgetName

string SCR_CompassUIComponent.m_sNorthWidgetName

protected

m_sSouthWidgetName

string SCR_CompassUIComponent.m_sSouthWidgetName

protected

m_sTextureWidgetName

string SCR_CompassUIComponent.m_sTextureWidgetName

protected

m_sWestWidgetName

string SCR_CompassUIComponent.m_sWestWidgetName

protected

m_TextureWidget

ImageWidget SCR_CompassUIComponent.m_TextureWidget

protected

m_World

BaseWorld SCR_CompassUIComponent.m_World

protected

---

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

• Game/UI/Components/SCR_CompassUIComponent.c