hud::HudBox Class Reference

Draws a 2D box. More...

#include <_src_hud_hud_box.hh>

Inheritance diagram for hud::HudBox:

List of all members.

Classes
struct	Definition3D
	Optional definition of 2D box in 3D terms. More...
Public Member Functions
	HudBox (const Rect< int > &rect=Rect< int >(), const RGBA color=RGBA())
	~HudBox ()
void	Set2D (const Rect< int > &rect)
void	Set3D (const WorldVertex &pos3, const uint width2, const uint height2)
void	SetColor (const RGBA color)
void	SetDrawX (const bool drawX)
Private Types
typedef HudObject	Parent
Private Member Functions
virtual void	Update (View &view)
Private Attributes
Rect< int >	mRect
	box's rectangle
RGBA	mColor
	box's color
Definition3D	m3D
	optional definition in terms of 3D world space
bool	mDrawX
	draw X over box (to indicate radar-lock)
Friends
class	Hud

Detailed Description

Draws a 2D box.

Set2D() vs. Set3D(): -------------------- HudBox is a 2D box. But it can be defined in terms of either 2D or 3D. Set3D() is for enclosing a 3D object in world space. It computes a 2D rectangle in terms of a 3D position and 2D width,height.

Member Typedef Documentation

typedef HudObject hud::HudBox::Parent [private]

Constructor & Destructor Documentation

hud::HudBox::HudBox	(	const Rect< int > &	rect = `Rect<int>()`,
		const RGBA	color = `RGBA()`
	)

ctor/dtor.

hud::HudBox::~HudBox ( )

Member Function Documentation

void hud::HudBox::Set2D ( const Rect< int > & rect )

Define box in 2D terms.

void hud::HudBox::Set3D	(	const WorldVertex &	pos3,
		const uint	width2,
		const uint	height2
	)

Define box in 3D terms.

void hud::HudBox::SetColor ( const RGBA color ) [inline]

void hud::HudBox::SetDrawX ( const bool drawX ) [inline]

virtual void hud::HudBox::Update ( View & view ) [private, virtual]

Friends And Related Function Documentation

friend class Hud [friend]

Member Data Documentation

Definition3D hud::HudBox::m3D [private]

optional definition in terms of 3D world space

RGBA hud::HudBox::mColor [private]

box's color

bool hud::HudBox::mDrawX [private]

draw X over box (to indicate radar-lock)

Rect<int> hud::HudBox::mRect [private]

box's rectangle

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

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Palomino Flight Simulator documents generated by doxygen 1.7.1 on Tue May 15 2012 22:40:11