SCR_CompassUIComponent Class Reference

Inheritance diagram for SCR_CompassUIComponent:

Protected Member Functions
void	UpdateRotation (float timeSlice)
override void	HandlerAttachedScripted (Widget w)
override void	HandlerDeattached (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>

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.

Definition at line 5 of file SCR_CompassUIComponent.c.

Member Function Documentation

HandlerAttachedScripted()

override void SCR_CompassUIComponent::HandlerAttachedScripted ( Widget w )

inlineprotected

Definition at line 51 of file SCR_CompassUIComponent.c.

HandlerDeattached()

override void SCR_CompassUIComponent::HandlerDeattached ( Widget w )

inlineprotected

Definition at line 74 of file SCR_CompassUIComponent.c.

UpdateRotation()

void SCR_CompassUIComponent::UpdateRotation ( float timeSlice )

inlineprotected

Update compass rtation base don the current view.

Parameters

timeSlice

Time since the last frame

Definition at line 33 of file SCR_CompassUIComponent.c.

Member Data Documentation

m_fLabelsDistance

float SCR_CompassUIComponent::m_fLabelsDistance

protected

Definition at line 8 of file SCR_CompassUIComponent.c.

m_Labels

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

protected

Definition at line 27 of file SCR_CompassUIComponent.c.

m_sEastWidgetName

string SCR_CompassUIComponent::m_sEastWidgetName

protected

Definition at line 14 of file SCR_CompassUIComponent.c.

m_sNorthWidgetName

string SCR_CompassUIComponent::m_sNorthWidgetName

protected

Definition at line 23 of file SCR_CompassUIComponent.c.

m_sSouthWidgetName

string SCR_CompassUIComponent::m_sSouthWidgetName

protected

Definition at line 17 of file SCR_CompassUIComponent.c.

m_sTextureWidgetName

string SCR_CompassUIComponent::m_sTextureWidgetName

protected

Definition at line 11 of file SCR_CompassUIComponent.c.

m_sWestWidgetName

string SCR_CompassUIComponent::m_sWestWidgetName

protected

Definition at line 20 of file SCR_CompassUIComponent.c.

m_TextureWidget

ImageWidget SCR_CompassUIComponent::m_TextureWidget

protected

Definition at line 26 of file SCR_CompassUIComponent.c.

m_World

BaseWorld SCR_CompassUIComponent::m_World

protected

Definition at line 25 of file SCR_CompassUIComponent.c.

---

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

• scripts/Game/UI/Components/SCR_CompassUIComponent.c