Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
ControlBarSchemeManager Class Reference

#include <ControlBarScheme.h>

Public Member Functions

 ControlBarSchemeManager (void)
 
 ~ControlBarSchemeManager (void)
 
void init (void)
 Initialize from the INI files.
 
void update (void)
 move the animations if we have any
 
void drawForeground (ICoord2D offset)
 draw function to be called within a w3d draw procedure for the foreground
 
void drawBackground (ICoord2D offset)
 draw function to be called within a w3d draw procedure for the background
 
void setControlBarSchemeByPlayer (Player *p)
 Based off the playerTemplate, pick the right scheme for the control bar.
 
void setControlBarSchemeByPlayerTemplate (const PlayerTemplate *pt, Bool useSmall=FALSE)
 
void setControlBarScheme (AsciiString schemeName)
 SchemeName must be a valid INI entry.
 
const FieldParse * getFieldParse () const
 returns the parsing fields
 
ControlBarScheme * findControlBarScheme (AsciiString name)
 attempt to find the control bar scheme by it's name
 
ControlBarScheme * newControlBarScheme (AsciiString name)
 create a new control bar scheme and return it.
 
void preloadAssets (TimeOfDay timeOfDay)
 preload the assets
 

Static Public Member Functions

static void parseImagePart (INI *ini, void *instance, void *store, const void *userData)
 Parse the image part of the INI file.
 
static void parseAnimatingPart (INI *ini, void *instance, void *store, const void *userData)
 Parse the animation part of the INI file.
 
static void parseAnimatingPartImage (INI *ini, void *instance, void *store, const void *userData)
 parse the image part of the animation part :)
 

Static Public Attributes

static const FieldParse m_controlBarSchemeFieldParseTable []
 the parse table
 

Detailed Description

Definition at line 249 of file ControlBarScheme.h.

Constructor & Destructor Documentation

◆ ControlBarSchemeManager()

ControlBarSchemeManager::ControlBarSchemeManager ( void )

Definition at line 840 of file ControlBarScheme.cpp.

◆ ~ControlBarSchemeManager()

ControlBarSchemeManager::~ControlBarSchemeManager ( void )

Definition at line 850 of file ControlBarScheme.cpp.

Member Function Documentation

◆ drawBackground()

void ControlBarSchemeManager::drawBackground ( ICoord2D offset)

draw function to be called within a w3d draw procedure for the background

Definition at line 1095 of file ControlBarScheme.cpp.

◆ drawForeground()

void ControlBarSchemeManager::drawForeground ( ICoord2D offset)

draw function to be called within a w3d draw procedure for the foreground

Definition at line 1089 of file ControlBarScheme.cpp.

◆ findControlBarScheme()

ControlBarScheme * ControlBarSchemeManager::findControlBarScheme ( AsciiString name)

attempt to find the control bar scheme by it's name

Definition at line 964 of file ControlBarScheme.cpp.

◆ getFieldParse()

const FieldParse * ControlBarSchemeManager::getFieldParse ( ) const
inline

returns the parsing fields

Definition at line 265 of file ControlBarScheme.h.

◆ init()

void ControlBarSchemeManager::init ( void )

Initialize from the INI files.

Definition at line 1031 of file ControlBarScheme.cpp.

◆ newControlBarScheme()

ControlBarScheme * ControlBarSchemeManager::newControlBarScheme ( AsciiString name)

create a new control bar scheme and return it.

Definition at line 933 of file ControlBarScheme.cpp.

◆ parseAnimatingPart()

void ControlBarSchemeManager::parseAnimatingPart ( INI * ini,
void * instance,
void * store,
const void * userData )
static

Parse the animation part of the INI file.

Definition at line 911 of file ControlBarScheme.cpp.

◆ parseAnimatingPartImage()

void ControlBarSchemeManager::parseAnimatingPartImage ( INI * ini,
void * instance,
void * store,
const void * userData )
static

parse the image part of the animation part :)

Definition at line 891 of file ControlBarScheme.cpp.

◆ parseImagePart()

void ControlBarSchemeManager::parseImagePart ( INI * ini,
void * instance,
void * store,
const void * userData )
static

Parse the image part of the INI file.

Definition at line 871 of file ControlBarScheme.cpp.

◆ preloadAssets()

void ControlBarSchemeManager::preloadAssets ( TimeOfDay timeOfDay)

preload the assets

Definition at line 989 of file ControlBarScheme.cpp.

◆ setControlBarScheme()

void ControlBarSchemeManager::setControlBarScheme ( AsciiString schemeName)

SchemeName must be a valid INI entry.

Definition at line 1060 of file ControlBarScheme.cpp.

◆ setControlBarSchemeByPlayer()

void ControlBarSchemeManager::setControlBarSchemeByPlayer ( Player * p)

Based off the playerTemplate, pick the right scheme for the control bar.

Definition at line 1163 of file ControlBarScheme.cpp.

◆ setControlBarSchemeByPlayerTemplate()

void ControlBarSchemeManager::setControlBarSchemeByPlayerTemplate ( const PlayerTemplate * pt,
Bool useSmall = FALSE )

Definition at line 1102 of file ControlBarScheme.cpp.

◆ update()

void ControlBarSchemeManager::update ( void )

move the animations if we have any

Definition at line 1082 of file ControlBarScheme.cpp.

Member Data Documentation

◆ m_controlBarSchemeFieldParseTable

const FieldParse ControlBarSchemeManager::m_controlBarSchemeFieldParseTable
static

the parse table

Definition at line 78 of file ControlBarScheme.h.

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