My Project
Classes | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
ParaEngine::CGUIHighlightManager Class Reference

Holds the CGUIHighlight controls. More...

#include <GUIHighlight.h>

Classes

struct  MarkerInstance
 marker instance More...
 

Public Member Functions

CGUIHighlightGetHighlight (int style)
 Get a highlight effect. More...
 
CGUIHighlightGetHighlight (const char *szName)
 
void AddHighlight (int style, CGUIHighlight *pHighlight)
 add a new highlighting style
 
void ClearAllInstance ()
 clear all instances in the post render list. More...
 
void AddNewInstance (GUIState *pGUIState, RECT &rcScreen, float fElapsedTime, int style)
 add a new instance into the post render list. More...
 
HRESULT Render (GUIState *pGUIState, float fElapsedTime, bool bAutoCleanInstance=true)
 render all highlighting markers in the post rendering list More...
 
void Finalize ()
 
CGUIHighlightCreateCustomHighlight (const char *szName, const char *szParentName)
 Create a custom highlight effect from an existing highlight effect The new effect can has different parameter of the parent effect.
 

Static Public Member Functions

static HRESULT Render (GUIState *pGUIState, RECT &rcScreen, float fElapsedTime, int style)
 this function is not used, unless you do not want to post render an instance. More...
 

Protected Attributes

map< int, CGUIHighlight * > m_items
 
map< string, CGUIHighlight * > m_customs
 
list< MarkerInstancem_instaces
 post render instances
 

Detailed Description

Holds the CGUIHighlight controls.

Is a singleton, use CSingleton to hold it.

Member Function Documentation

§ AddNewInstance()

void CGUIHighlightManager::AddNewInstance ( GUIState pGUIState,
RECT rcScreen,
float  fElapsedTime,
int  style 
)

add a new instance into the post render list.

This function is called at the end of the rendering pipeline of each control.

§ ClearAllInstance()

void CGUIHighlightManager::ClearAllInstance ( )

clear all instances in the post render list.

This function is called at the beginning of each frame.

§ GetHighlight()

CGUIHighlight * CGUIHighlightManager::GetHighlight ( int  style)

Get a highlight effect.

Returns
: Null if not exists.

§ Render() [1/2]

HRESULT CGUIHighlightManager::Render ( GUIState pGUIState,
float  fElapsedTime,
bool  bAutoCleanInstance = true 
)

render all highlighting markers in the post rendering list

Parameters
pGUIState
fElapsedTime
bAutoCleanInstanceif true ClearAllInstance() will be called before this function returns
Returns

§ Render() [2/2]

HRESULT CGUIHighlightManager::Render ( GUIState pGUIState,
RECT rcScreen,
float  fElapsedTime,
int  style 
)
static

this function is not used, unless you do not want to post render an instance.

a short-cut for getting a highlight style and render the style


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