CCmpHUD Class Reference

HUD Component. More...

#include <cmpHUD.h>

Inheritance diagram for CCmpHUD:

List of all members.

Public Member Functions
	CCmpHUD (CGameEntity *pGE)
	Create with default values.
Virtual methods
virtual int	set (const EDIT_DATA &editData)
	Set a value.
virtual int	get (EDIT_DATA &editData) const
	Get a value.
virtual int	act (const ACTION_DATA &actData)
	Preform an action.
virtual void	update ()
	Update this Cmp for a single frame.
Color methods
void	color (const VECTOR &color)
	Set the color of this HUD.
const VECTOR &	color () const
	Returns: An Acknex VECTOR cotaining the BGR values
void	red (const int red)
	Set red value.
int	red () const
	Get red value.
void	blue (const int blue)
	Set blue value.
int	blue () const
	Get blue value.
void	green (const int green)
	Set green value.
int	green () const
	Get green value.
Draw methods
void	draw (const char *cstr, int x=0, int y=0)
	Display a string at the position given.
void	draw (const unit f, int x=0, int y=0)
	Display a number at the position given.
void	draw (const CVector3D &v, int x=0, int y=0)
	Display a vector at the position given.
void	draw_bool (const bool b, int x=0, int y=0)
	Display a bool at the position given.
bool	draw (ENTITY *pEnt, const char *cstr, int x=0, int y=0)
	Display a string, offset from the ENTITY position.
bool	draw (ENTITY *pEnt, const unit f, int x=0, int y=0)
	Display a number, offset from the ENTITY position.
bool	draw (ENTITY *pEnt, const CVector3D &v, int x=0, int y=0)
	Display a vector, offset from the ENTITY position.
bool	draw_bool (ENTITY *pEnt, const bool b, int x=0, int y=0)
	Display a bool (true or false), offset from the ENTITY position.

---

Detailed Description

HUD Component.

The HUD displays text, numbers, and images directly to the screen.

(c) 2007-2008 oP group Germany GbR. All rights reserved.
This source code is provided "as is" with no warranty and must not be distributed without written permission.

Author:

Doug Poston

Version:

1.3

Date:

12/28/2007

---

Member Function Documentation

int CCmpHUD::set

(

const EDIT_DATA &

editData

)

[virtual]

Set a value.

If we have data of this type, use editData to set its value.

Parameters:

editData

Data type and value (see EDIT_DATA struct).

Returns:

Value less than zero on error, 0 if nothing found, positive otherwise.

See also:

EDIT_DATA

---

Handles the following EDIT_DATA:

• None.

Implements CCmp.

int CCmpHUD::get

(

EDIT_DATA &

editData

)

const [virtual]

Get a value.

If we have data of this type, use editData to get its value.

Parameters:

editData

Data type we are looking for, and memory to store value (see EDIT_DATA struct).

Returns:

Value less than zero on error, 0 if nothing found, positive otherwise.

See also:

EDIT_DATA

---

Handles the following EDIT_DATA:

• None.

Implements CCmp.

int CCmpHUD::act

(

const ACTION_DATA &

actData

)

[virtual]

Preform an action.

Handle the action passed in (ignore if we do not handle the action type).

Parameters:

actData

The data used to preform the action (see ACTION_DATA struct).

Returns:

Value less than zero on error, 0 if no action found, positive otherwise.

See also:

ACTION_DATA

---

Handles the following ACTION_DATA:

• None.

Implements CCmp.

void CCmpHUD::color

(

const VECTOR &

color

)

[inline]

Set the color of this HUD.

Parameters:

color

Acknex VECTOR containing the BGR values

void CCmpHUD::draw	(	const char *	cstr,
		int	x = 0,
		int	y = 0
	)

Display a string at the position given.

Parameters:

	cstr	String to be drawn.
	x	Screen X position.
	y	Screen Y position

void CCmpHUD::draw	(	const unit	f,
		int	x = 0,
		int	y = 0
	)

Display a number at the position given.

Parameters:

	f	Unit value to be drawn.
	x	Screen X position.
	y	Screen Y position

void CCmpHUD::draw	(	const CVector3D &	v,
		int	x = 0,
		int	y = 0
	)

Display a vector at the position given.

Parameters:

	v	Vector to be drawn.
	x	Screen X position.
	y	Screen Y position

void CCmpHUD::draw_bool	(	const bool	b,
		int	x = 0,
		int	y = 0
	)

Display a bool at the position given.

Parameters:

	b	Boolean to be drawn.
	x	Screen X position.
	y	Screen Y position

bool CCmpHUD::draw	(	ENTITY *	pEnt,
		const char *	cstr,
		int	x = 0,
		int	y = 0
	)

Display a string, offset from the ENTITY position.

Parameters:

	pEnt	Pointer to the entity whos screen position we will use.
	cstr	String to be drawn
	x	X offset
	y	Y offset

Returns:

true if on screen, false if not

bool CCmpHUD::draw	(	ENTITY *	pEnt,
		const unit	f,
		int	x = 0,
		int	y = 0
	)

Display a number, offset from the ENTITY position.

Parameters:

	pEnt	Pointer to the entity whos screen position we will use.
	f	Value to be drawn
	x	X offset
	y	Y offset

Returns:

true if on screen, false if not

bool CCmpHUD::draw	(	ENTITY *	pEnt,
		const CVector3D &	v,
		int	x = 0,
		int	y = 0
	)

Display a vector, offset from the ENTITY position.

Parameters:

	pEnt	Pointer to the entity whos screen position we will use.
	v	CVector3D to be drawn
	x	X offset
	y	Y offset

Returns:

true if on screen, false if not

bool CCmpHUD::draw_bool	(	ENTITY *	pEnt,
		const bool	b,
		int	x = 0,
		int	y = 0
	)

Display a bool (true or false), offset from the ENTITY position.

Parameters:

	pEnt	Pointer to the entity whos screen position we will use.
	b	True or False
	x	X offset
	y	Y offset

Returns:

true if on screen, false if not

---

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

• C:/Documents and Settings/slap/My Documents/Visual Studio 2005/Projects/Template7/template7/cmpHUD.h
• C:/Documents and Settings/slap/My Documents/Visual Studio 2005/Projects/Template7/template7/cmpHUD.cpp

---