dxf Namespace Reference

Classes

class Console

struct JoystickCaps

class Controller

struct FontNode

class Font

class RegistrarInterface

class Game

class Model

class Music

class Sound

class Sprite

class GameState

class GameStateGUI

class StateManager

struct TextureInfo

class Texture

class View

Typedefs

typedef void(*) CommandFunction (std::vector< std::wstring > &argv)

typedef std::map< std::wstring,
CommandFunction > CommandMap

typedef CommandMap::const_iterator CommandMapConstIter

typedef std::vector< FontNode * > FontNodeVector

typedef std::vector< FontNode
* >::iterator FontNodeVectorIter

typedef std::map< std::wstring,
GameState * > StateMap

typedef std::map< std::wstring,
GameState * >::iterator StateMapIterator

typedef std::vector< GameState * > StateVector

typedef std::vector< GameState
* >::iterator StateVectorIterator

typedef std::map< std::wstring,
TextureInfo * > TextureInfoMap

typedef std::map< std::wstring,
TextureInfo * >::iterator TextureInfoMapIter

Enumerations

enum eButtonState { BUTTON_UP, BUTTON_PRESSED, BUTTON_DOWN, BUTTON_RELEASED }

enum eMouseButton {
MBUTTON_LEFT, MBUTTON_RIGHT, MBUTTON_MIDDLE, MBUTTON_SIDE1,
MBUTTON_SIDE2
}

Functions

void DXFRegisterCommand (const wchar_t *command, CommandFunction function)

eButtonState DXFCheckKeyboard (BYTE key)

void DXFGetBufferedInput (std::wstring &input)

eButtonState DXFCheckMouse (eMouseButton button)

int DXFGetMouseWheelDelta ()

POINT DXFGetMousePosition ()

const JoystickCaps * DXFGetJoystickCapabilities ()

eButtonState DXFCheckJoystick (int button)

const DIJOYSTATE2 * DXFGetJoystickState ()

void DXFChangeState (const std::wstring &name)

void DXFRegisterState (const std::wstring &name, GameState *pState)

void DXFSetClear (bool clearEachFrame)

void DXFSetClearColor (D3DCOLOR clearColor)

void DXFSetClearRect (const D3DRECT &clearRect)

void help (std::vector< std::wstring > &argv)

void fps (std::vector< std::wstring > &argv)

void mouse (std::vector< std::wstring > &argv)

void quit (std::vector< std::wstring > &argv)

void DXFUpdateConsole ()

void DXFRenderConsole ()

void DXFPollInput ()

GameState * GetCurrentGameState ()

void DXFRenderPre2D (double fTime, float fElapsedTime)

void DXFRender3D (double fTime, float fElapsedTime)

void DXFRender2D (double fTime, float fElapsedTime)

void CALLBACK OnGameStateGUIEvent (UINT nEvent, int nControlID, CDXUTControl *pControl, void *pUserContext)

std::wstring towstring (const int &i)

std::wstring towstring (const unsigned int &i)

std::wstring towstring (const unsigned long &i)

std::wstring towstring (const double &f)

std::wstring tohexwstring (const int &i)

int toint (const std::wstring &word)

int hextoint (const std::wstring &word)

double round (const double &n)

bool checkIntersection (const POINT &p, const D3DRECT &extent)

ID3DXSprite * DXFGetD3DXSprite ()

Variables

bool gFPS = false

bool gMouse = false

bool gMouse

bool gFPS

Detailed Description

Global header for DXFramework project. This is the only header that applications using DXFramework need to include.

Typedef Documentation

typedef void(*) dxf::CommandFunction(std::vector< std::wstring > &argv)

Definition at line 35 of file dxf_console.h.

typedef std::map<std::wstring, CommandFunction> dxf::CommandMap

Definition at line 38 of file dxf_console.h.

typedef CommandMap::const_iterator dxf::CommandMapConstIter

Definition at line 39 of file dxf_console.h.

typedef std::vector<FontNode*> dxf::FontNodeVector

Definition at line 47 of file dxf_font.h.

typedef std::vector<FontNode*>::iterator dxf::FontNodeVectorIter

Definition at line 48 of file dxf_font.h.

typedef std::map<std::wstring, GameState*> dxf::StateMap

Definition at line 182 of file dxf_statemanager.h.

typedef std::map<std::wstring, GameState*>::iterator dxf::StateMapIterator

Definition at line 183 of file dxf_statemanager.h.

typedef std::vector<GameState*> dxf::StateVector

Definition at line 185 of file dxf_statemanager.h.

typedef std::vector<GameState*>::iterator dxf::StateVectorIterator

Definition at line 186 of file dxf_statemanager.h.

typedef std::map<std::wstring, TextureInfo*> dxf::TextureInfoMap

Definition at line 47 of file dxf_texture.h.

typedef std::map<std::wstring, TextureInfo*>::iterator dxf::TextureInfoMapIter

Definition at line 48 of file dxf_texture.h.

Enumeration Type Documentation

enum dxf::eButtonState

Buttons go through four states: up --> pressed --> down --> released

Enumerator:

BUTTON_UP	button is up now and was up last frame
BUTTON_PRESSED	button is down now and was up last frame
BUTTON_DOWN	button is down now and was down last frame
BUTTON_RELEASED	button is up now and was down last frame

Definition at line 39 of file dxf_controller.h.

enum dxf::eMouseButton

Enumerator:

MBUTTON_LEFT	left mouse button
MBUTTON_RIGHT	right mouse button
MBUTTON_MIDDLE	middle mouse button
MBUTTON_SIDE1	?? side buttons?
MBUTTON_SIDE2	?? side buttons?

Definition at line 46 of file dxf_controller.h.

Function Documentation

void dxf::DXFRegisterCommand	(	const wchar_t *	command,
		CommandFunction	function
	)

Registers a new command using the function pointer. If the first argument of a command typed in to the console matches (or partially matches) the first parameter passed here, the function passed as the second parameter is called with the tokenized command line.

Definition at line 377 of file dxf_console.cpp.

References dxf::Console::Instance(), and dxf::Console::RegisterCommand().

eButtonState dxf::DXFCheckKeyboard ( BYTE key )

Use to check the state of a key specified by the passed virtual key code. Use the capital character notation for letter keys on the keyboard. For example:

DXFCheckKeyboard('V'); // checks the state of the v key

Definition at line 310 of file dxf_controller.cpp.

References dxf::Controller::CheckKeyboard(), and dxf::Controller::Instance().

void dxf::DXFGetBufferedInput ( std::wstring & input )

Used to retrieve buffered input, clearing the buffered input buffer in the process.

Definition at line 311 of file dxf_controller.cpp.

References dxf::Controller::GetBufferedInput(), and dxf::Controller::Instance().

eButtonState dxf::DXFCheckMouse ( eMouseButton button )

Use to check the state of a mouse button specified by the passed parameter.

Definition at line 312 of file dxf_controller.cpp.

References dxf::Controller::CheckMouse(), and dxf::Controller::Instance().

int dxf::DXFGetMouseWheelDelta ( )

Use to see how much the mouse moved last frame.

Definition at line 313 of file dxf_controller.cpp.

References dxf::Controller::GetMouseWheelDelta(), and dxf::Controller::Instance().

POINT dxf::DXFGetMousePosition ( )

Returns the back buffer coordinates where the mouse is pointing.

Definition at line 314 of file dxf_controller.cpp.

References dxf::Controller::GetMousePosition(), and dxf::Controller::Instance().

const JoystickCaps * dxf::DXFGetJoystickCapabilities ( )

Finds out what capabilities the joystick has. See the JoystickCaps structure documentation.

Definition at line 315 of file dxf_controller.cpp.

References g_JoystickCaps.

eButtonState dxf::DXFCheckJoystick ( int button )

Use to check the state of a joystick button specified by the passed parameter.

Definition at line 316 of file dxf_controller.cpp.

References dxf::Controller::CheckJoystick(), and dxf::Controller::Instance().

const DIJOYSTATE2 * dxf::DXFGetJoystickState ( )

Returns a snapshot of the current joystick state

Definition at line 317 of file dxf_controller.cpp.

References dxf::Controller::GetJoystickState(), and dxf::Controller::Instance().

void dxf::DXFChangeState ( const std::wstring & name )

Use to change states, pass the name of the new state. The name should match the name used when registering the states.

Definition at line 83 of file dxf_model.cpp.

References dxf::StateManager::ChangeState(), and dxf::Model::Instance().

void dxf::DXFRegisterState	(	const std::wstring &	name,
		GameState *	pState
	)

Use to register states for use in the framework. The name is an arbitrary, unique identifier used to switch to the state.

Definition at line 84 of file dxf_model.cpp.

References dxf::Model::Instance(), and dxf::StateManager::RegisterState().

void dxf::DXFSetClear ( bool clearEachFrame )

Definition at line 257 of file dxf_view.cpp.

References dxf::View::Instance(), and dxf::View::SetClear().

void dxf::DXFSetClearColor ( D3DCOLOR clearColor )

Definition at line 258 of file dxf_view.cpp.

References dxf::View::Instance(), and dxf::View::SetClearColor().

void dxf::DXFSetClearRect ( const D3DRECT & clearRect )

Definition at line 259 of file dxf_view.cpp.

References dxf::View::Instance(), and dxf::View::SetClearRect().

void dxf::help ( std::vector< std::wstring > & argv )

Definition at line 37 of file dxf_console.cpp.

References dxf::Console::Instance(), and dxf::Console::ListCommands().

Referenced by dxf::Console::Load().

void dxf::fps ( std::vector< std::wstring > & argv )

Definition at line 41 of file dxf_console.cpp.

References gFPS.

Referenced by dxf::Console::Load().

void dxf::mouse ( std::vector< std::wstring > & argv )

Definition at line 45 of file dxf_console.cpp.

References gMouse.

Referenced by dxf::Console::Load().

void dxf::quit ( std::vector< std::wstring > & argv )

Definition at line 49 of file dxf_console.cpp.

Referenced by dxf::Console::Load().

void dxf::DXFUpdateConsole ( )

Definition at line 375 of file dxf_console.cpp.

References dxf::Console::Instance(), and dxf::Console::Update().

Referenced by dxf::Model::OnFrameMove().

void dxf::DXFRenderConsole ( )

Definition at line 376 of file dxf_console.cpp.

References dxf::Console::Instance(), and dxf::Console::Render2D().

Referenced by dxf::View::OnFrameRender().

void dxf::DXFPollInput ( )

Definition at line 309 of file dxf_controller.cpp.

References dxf::Controller::Instance(), and dxf::Controller::Poll().

Referenced by dxf::Model::OnFrameMove().

GameState* dxf::GetCurrentGameState ( )

Definition at line 79 of file dxf_model.cpp.

References dxf::StateManager::GetCurrentGameState(), and dxf::Model::Instance().

void dxf::DXFRenderPre2D	(	double	fTime,
		float	fElapsedTime
	)

Definition at line 80 of file dxf_model.cpp.

References dxf::Model::Instance(), and dxf::Model::RenderPre2D().

Referenced by dxf::View::OnFrameRender().

void dxf::DXFRender3D	(	double	fTime,
		float	fElapsedTime
	)

Definition at line 81 of file dxf_model.cpp.

References dxf::Model::Instance(), and dxf::Model::Render3D().

Referenced by dxf::View::OnFrameRender().

void dxf::DXFRender2D	(	double	fTime,
		float	fElapsedTime
	)

Definition at line 82 of file dxf_model.cpp.

References dxf::Model::Instance(), and dxf::Model::Render2D().

Referenced by dxf::View::OnFrameRender().

void CALLBACK dxf::OnGameStateGUIEvent	(	UINT	nEvent,
		int	nControlID,
		CDXUTControl *	pControl,
		void *	pUserContext
	)

Definition at line 36 of file dxf_statemanager.cpp.

References dxf::StateManager::GetCurrentGameState(), dxf::Model::Instance(), and dxf::GameState::OnGUIEvent().

Referenced by dxf::GameStateGUI::Load().

std::wstring dxf::towstring ( const int & i )

convert the integer to a string

Definition at line 34 of file dxf_tools.cpp.

std::wstring dxf::towstring ( const unsigned int & i )

convert the unsigned integer to a string

Definition at line 40 of file dxf_tools.cpp.

std::wstring dxf::towstring ( const unsigned long & i )

convert the unsigned long to a string

Definition at line 46 of file dxf_tools.cpp.

std::wstring dxf::towstring ( const double & f )

convert the double to a string

Definition at line 52 of file dxf_tools.cpp.

std::wstring dxf::tohexwstring ( const int & i )

convert the integer to hexidecimal notation in string form

Definition at line 58 of file dxf_tools.cpp.

int dxf::toint ( const std::wstring & word )

convert the string to an integer

Definition at line 66 of file dxf_tools.cpp.

Referenced by dxf::Sprite::Init().

int dxf::hextoint ( const std::wstring & word )

convert the string in hex notation to an integer

Definition at line 72 of file dxf_tools.cpp.

double dxf::round ( const double & n )

rount the double to the nearest integer according to normal rounding rules (>= .5 rounds up, <= .5 rounds down)

Definition at line 78 of file dxf_tools.cpp.

Referenced by dxf::Texture::Ellipse().

bool dxf::checkIntersection	(	const POINT &	p,
		const D3DRECT &	extent
	)

check to see if the point lies inside of the rectangle

Definition at line 83 of file dxf_tools.cpp.

Referenced by dxf::Sprite::CheckIntersection().

ID3DXSprite * dxf::DXFGetD3DXSprite ( )

Definition at line 256 of file dxf_view.cpp.

References dxf::View::GetD3DXSprite(), and dxf::View::Instance().

Referenced by dxf::Font::GetTextExtent(), dxf::Sprite::Render2D(), and dxf::Font::Render2D().

Variable Documentation

bool dxf::gFPS = false

Definition at line 34 of file dxf_console.cpp.

Referenced by fps(), and dxf::Model::Render2D().

bool dxf::gMouse = false

Definition at line 35 of file dxf_console.cpp.

Referenced by mouse(), and dxf::Controller::SetMousePosition().

bool dxf::gMouse

Definition at line 35 of file dxf_console.cpp.

Referenced by mouse(), and dxf::Controller::SetMousePosition().

bool dxf::gFPS

Definition at line 34 of file dxf_console.cpp.

Referenced by fps(), and dxf::Model::Render2D().

Generated on Fri Aug 18 12:01:28 2006 for DXFramework by

1.4.7


Classes
class	Console
struct	JoystickCaps
class	Controller
struct	FontNode
class	Font
class	RegistrarInterface
class	Game
class	Model
class	Music
class	Sound
class	Sprite
class	GameState
class	GameStateGUI
class	StateManager
struct	TextureInfo
class	Texture
class	View
Typedefs
typedef void(*)	CommandFunction (std::vector< std::wstring > &argv)
typedef std::map< std::wstring, CommandFunction >	CommandMap
typedef CommandMap::const_iterator	CommandMapConstIter
typedef std::vector< FontNode * >	FontNodeVector
typedef std::vector< FontNode * >::iterator	FontNodeVectorIter
typedef std::map< std::wstring, GameState * >	StateMap
typedef std::map< std::wstring, GameState * >::iterator	StateMapIterator
typedef std::vector< GameState * >	StateVector
typedef std::vector< GameState * >::iterator	StateVectorIterator
typedef std::map< std::wstring, TextureInfo * >	TextureInfoMap
typedef std::map< std::wstring, TextureInfo * >::iterator	TextureInfoMapIter
Enumerations
enum	eButtonState { BUTTON_UP, BUTTON_PRESSED, BUTTON_DOWN, BUTTON_RELEASED }
enum	eMouseButton { MBUTTON_LEFT, MBUTTON_RIGHT, MBUTTON_MIDDLE, MBUTTON_SIDE1, MBUTTON_SIDE2 }
Functions
void	DXFRegisterCommand (const wchar_t *command, CommandFunction function)
eButtonState	DXFCheckKeyboard (BYTE key)
void	DXFGetBufferedInput (std::wstring &input)
eButtonState	DXFCheckMouse (eMouseButton button)
int	DXFGetMouseWheelDelta ()
POINT	DXFGetMousePosition ()
const JoystickCaps *	DXFGetJoystickCapabilities ()
eButtonState	DXFCheckJoystick (int button)
const DIJOYSTATE2 *	DXFGetJoystickState ()
void	DXFChangeState (const std::wstring &name)
void	DXFRegisterState (const std::wstring &name, GameState *pState)
void	DXFSetClear (bool clearEachFrame)
void	DXFSetClearColor (D3DCOLOR clearColor)
void	DXFSetClearRect (const D3DRECT &clearRect)
void	help (std::vector< std::wstring > &argv)
void	fps (std::vector< std::wstring > &argv)
void	mouse (std::vector< std::wstring > &argv)
void	quit (std::vector< std::wstring > &argv)
void	DXFUpdateConsole ()
void	DXFRenderConsole ()
void	DXFPollInput ()
GameState *	GetCurrentGameState ()
void	DXFRenderPre2D (double fTime, float fElapsedTime)
void	DXFRender3D (double fTime, float fElapsedTime)
void	DXFRender2D (double fTime, float fElapsedTime)
void CALLBACK	OnGameStateGUIEvent (UINT nEvent, int nControlID, CDXUTControl pControl, void pUserContext)
std::wstring	towstring (const int &i)
std::wstring	towstring (const unsigned int &i)
std::wstring	towstring (const unsigned long &i)
std::wstring	towstring (const double &f)
std::wstring	tohexwstring (const int &i)
int	toint (const std::wstring &word)
int	hextoint (const std::wstring &word)
double	round (const double &n)
bool	checkIntersection (const POINT &p, const D3DRECT &extent)
ID3DXSprite *	DXFGetD3DXSprite ()
Variables
bool	gFPS = false
bool	gMouse = false
bool	gMouse
bool	gFPS