BuildData

Project

Include

BuildData.h

Summary

BuildData	RulesCore
Constructors
BuildData	The ImageSet bitmap PlayerData constructor.
BuildData	The OpenGL-rendered bitmap BuildData constructor.
Variables
mRow	The row index on screen the BuildData should be in.
mPriority	The priority of the BuildData within its row.
mLogic	The name of the ILogic that determines the visibility of the BuildUI.
mRule	The name of the IRule that is executed when the BuildUI is clicked.
mImageKey	The image key group.
mImageName	The image name.
mGameObject	The IGameObject used to render the BuildData.
mDrawObject	The IDrawObject used to render the BuildData in OpenGL.

Constructors

BuildData

BuildData(		wxInt32		row,
		wxInt32		priority,
	const	wxString	&	logic,
	const	wxString	&	rule,
	const	wxString	&	imageKey,
	const	wxString	&	imageName	) : mRow(row), mPriority(priority), mLogic(logic), mRule(rule), mImageKey(imageKey), mImageName(imageName)

The ImageSet bitmap PlayerData constructor. Creates a PlayerData that uses the given ImageSet image key and image name to create its screen bitmap.

Parameters

row	The index of the BuildUI row the BuildData should be in on screen.
priority	The priority of the BuildData within its row.
logic	The name of the ILogic that determines if the BuildUI can be shown.
rule	The name of the IRule to execute when the BuildUI is clicked.
imageKey	The ImageSet image group key of the bitmap of the PlayerData.
imageName	The image name within the group given by the image key.

BuildData

BuildData(		wxInt32		row,
		wxInt32		priority,
	const	wxString	&	logic,
	const	wxString	&	rule,
	const	GameObjectPtr	&	gameObject,
	const	DrawObjectPtr	&	drawObject	) : mRow(row), mPriority(priority), mLogic(logic), mRule(rule), mGameObject(gameObject), mDrawObject(drawObject)

The OpenGL-rendered bitmap BuildData constructor. Creates a BuildData that uses the given IGameObject and IDrawObject to create its screen bitmap.

Parameters

row	The index of the BuildUI row the BuildData should be in on screen.
priority	The priority of the BuildData within its row.
logic	The name of the ILogic that determines if the BuildUI can be shown.
rule	The name of the IRule to execute when the BuildUI is clicked.
gameObject	The IGameObject representing the type of model to draw.
drawObject	The IDrawObject that renders the IGameObject in OpenGL.

Variables

mRow

wxInt32 mRow

The row index on screen the BuildData should be in.

mPriority

wxInt32 mPriority

The priority of the BuildData within its row.

mLogic

wxString mLogic

The name of the ILogic that determines the visibility of the BuildUI.

mRule

wxString mRule

The name of the IRule that is executed when the BuildUI is clicked.

mImageKey

wxString mImageKey

The image key group. If the value is not empty, the BuildData is assumed to be using the IImageEngine and an ImageSet to produce its screen bitmap. If empty, the OpenGL fields are used.

mImageName

wxString mImageName

The image name. Used in conjunction with the image key to retrieve the screen bitmap image from an ImageSet within the IImageEngine.

mGameObject

GameObjectPtr mGameObject

The IGameObject used to render the BuildData. An IDrawObject must always have an IGameObject to refer to when it renders itself in OpenGL.

mDrawObject

DrawObjectPtr mDrawObject

The IDrawObject used to render the BuildData in OpenGL.

RulesCore is the HOSS of Cities3D.

BuildData(		wxInt32		row,
		wxInt32		priority,
	const	wxString	&	logic,
	const	wxString	&	rule,
	const	wxString	&	imageKey,
	const	wxString	&	imageName	) : mRow(row), mPriority(priority), mLogic(logic), mRule(rule), mImageKey(imageKey), mImageName(imageName)

The ImageSet bitmap PlayerData constructor.

A repository of knowledge about a .tex file.

wxInt32 mRow

The row index on screen the BuildData should be in.

wxInt32 mPriority

The priority of the BuildData within its row.

wxString mLogic

The name of the ILogic that determines the visibility of the BuildUI.

The interface of a single piece of game logic.

Displays a possible action for the player.

wxString mRule

The name of the IRule that is executed when the BuildUI is clicked.

The interface for a single game rule.

wxString mImageKey

The image key group.

wxString mImageName

The image name.

GameObjectPtr mGameObject

The IGameObject used to render the BuildData.

An interface for all game objects.

DrawObjectPtr mDrawObject

The IDrawObject used to render the BuildData in OpenGL.

The interface for objects that are drawn on screen.

The interface of the image engine.