MercuryObject Class Reference

[actor] Base Object (abstract) More...

#include <MercuryObject.h>

Inheritance diagram for MercuryObject:

[legend]Collaboration diagram for MercuryObject:


Public Types
enum	HALIGN { LEFT = 0, CENTER, RIGHT }
enum	VALIGN { TOP = 0, VCENTER, BOTTOM }
Public Member Functions
	MercuryObject ()
	MercuryObject (const MString &name)
virtual	~MercuryObject ()
virtual void	Init ()
void	CalculateRealColor ()
void	SetName (const MString &name)
virtual void	SortDrawOrder ()
virtual void	AddObject (MercuryObject *object, bool bParentDelete=false)
virtual bool	RemoveObject (MercuryObject *object, bool bAllowDelete=true)
virtual bool	ReplaceObject (MercuryObject object, MercuryObject newobject)
void	Destroy ()
void	SetMaterial (MercuryMaterial *material)
void	SetDiffuse (const MercuryColor &c)
void	SetDiffusef (float r, float g, float b, float a)
void	SetEmissive (const MercuryColor &c)
void	SetEmissivef (float r, float g, float b, float a)
void	SetSpecular (const MercuryColor &c)
void	SetSpecularf (float r, float g, float b, float a)
void	SetAmbient (const MercuryColor &c)
void	SetAmbientf (float r, float g, float b, float a)
const MString &	GetName () const
const MercuryMaterial *	GetMaterial () const
const MercuryMaterial &	GetFinalMaterial () const
const MercuryColor &	GetDiffuse ()
const MercuryColor &	GetEmissive ()
const MercuryColor &	GetSpecular ()
const MercuryColor &	GetAmbient ()
void	GetDiffusef (float &r, float &g, float &b, float &a)
virtual MercuryObject *	Spawn (const MString &sClass, const MString &sName, PROJECTIONTYPE projection=PERSPECTIVE)
unsigned int	GetNumChildren () const
virtual void	SetHAlignment (HALIGN alignment)
HALIGN	GetHAlignment () const
virtual void	SetVAlignment (VALIGN alignment)
VALIGN	GetVAlignment () const
virtual void	Prerender ()
	Add another object to this object's children.
virtual void	Render ()
virtual void	CustomRender ()
void	ComputeCull ()
bool	IsCulled () const
virtual void	Update (const float dTime)
	[internal] Update (call this update last when abstracting because Update can destroy the object)
virtual void	SetDrawOrder (int order)
	Set this object's projection type (and all of its children).
virtual void	Draw ()
	[internal] Draw (CALL FIRST when using abstracted draw commands)
	CLASS_RTTI (MercuryObject, MercuryMessageHandler)
virtual void	Clonize ()
bool	IsInitalized () const
float	GetScaledRadius () const
State	GetState () const
MercuryGLState &	GetGLState ()
void	ComputeInheritedGLState ()
MercuryGLState	GetInheritedGLState ()
Public Attributes
MercuryTweenState	Tweening
	Complete tweening state.
MDeque< ParentHoldPair >	m_objects
Protected Attributes
bool	m_bClone
bool	m_bMarkedForDestroy
unsigned int	m_polys
MString	m_name
int	m_width
int	m_height
bool	m_drawable
bool	m_culled
MercuryMaterial	m_finalMaterial
MercuryMaterial *	m_pMaterial
State	m_state
MercuryGLState	m_glState
bool	m_initalized
Private Attributes
MercuryMaterial	m_modColor
MercuryMaterial	m_realColor
HALIGN	m_halignment
VALIGN	m_valignment
MercuryGLState	m_inheretedGLState
Classes
struct	ParentHoldPair
	[internal] Data structure to hold information about objects More...

Detailed Description

[actor] Base Object (abstract)

Definition at line 28 of file MercuryObject.h.

Member Enumeration Documentation

enum MercuryObject::HALIGN

Enumerator:

LEFT
CENTER
RIGHT

Definition at line 42 of file MercuryObject.h.

enum MercuryObject::VALIGN

Enumerator:

TOP
VCENTER
BOTTOM

Definition at line 48 of file MercuryObject.h.

Constructor & Destructor Documentation

MercuryObject::MercuryObject ( )

Definition at line 8 of file MercuryObject.cpp.

MercuryObject::MercuryObject ( const MString & name )

Definition at line 15 of file MercuryObject.cpp.

MercuryObject::~MercuryObject ( ) [virtual]

Definition at line 51 of file MercuryObject.cpp.

Member Function Documentation

void MercuryObject::Init ( ) [virtual]

Reimplemented from MercuryObjectBase.

Reimplemented in BetaBetaMari, ExplodingCokeCan, MercuryDynTex, MercuryLight, MercuryMesh, MercuryODEWorld, MercuryParticleField, MercuryScreen, MercurySprite, MercurySwapObject, MercuryText, Projectile, VirtualProjectile, RaceCar, ScreenCopper, ScreenDebugOverlay, ScreenExample2DSS, ScreenFPS, ScreenFPS2, ScreenGameForBlind, ScreenHelloWorld, ScreenJunq, TextList, ObjectControlPane, MercuryTextPrompt, ScreenMapEditor, ScreenNetTester, ScreenODETest, ScreenOutdoors, ScreenRallyRace, ScreenSound, ScreenTest, and ScreenHgTitle.

Definition at line 23 of file MercuryObject.cpp.

void MercuryObject::CalculateRealColor ( )

void MercuryObject::SetName ( const MString & name )

void MercuryObject::SortDrawOrder ( ) [virtual]

Definition at line 217 of file MercuryObject.cpp.

void MercuryObject::AddObject	(	MercuryObject *	object,
		bool	bParentDelete = `false`
	)			`[virtual]`

Definition at line 190 of file MercuryObject.cpp.

virtual bool MercuryObject::RemoveObject	(	MercuryObject *	object,
		bool	bAllowDelete = `true`
	)			`[virtual]`

Reimplemented in MercuryODEWorld, and MercuryScreen.

virtual bool MercuryObject::ReplaceObject	(	MercuryObject *	object,
		MercuryObject *	newobject
	)			`[virtual]`

void MercuryObject::Destroy ( ) [inline]

Definition at line 68 of file MercuryObject.h.

void MercuryObject::SetMaterial ( MercuryMaterial * material ) [inline]

Definition at line 69 of file MercuryObject.h.

void MercuryObject::SetDiffuse ( const MercuryColor & c ) [inline]

Definition at line 70 of file MercuryObject.h.

void MercuryObject::SetDiffusef	(	float	r,
		float	g,
		float	b,
		float	a
	)			`[inline]`

Definition at line 71 of file MercuryObject.h.

void MercuryObject::SetEmissive ( const MercuryColor & c ) [inline]

Definition at line 72 of file MercuryObject.h.

void MercuryObject::SetEmissivef	(	float	r,
		float	g,
		float	b,
		float	a
	)			`[inline]`

Definition at line 73 of file MercuryObject.h.

void MercuryObject::SetSpecular ( const MercuryColor & c ) [inline]

Definition at line 74 of file MercuryObject.h.

void MercuryObject::SetSpecularf	(	float	r,
		float	g,
		float	b,
		float	a
	)			`[inline]`

Definition at line 75 of file MercuryObject.h.

void MercuryObject::SetAmbient ( const MercuryColor & c ) [inline]

Definition at line 76 of file MercuryObject.h.

void MercuryObject::SetAmbientf	(	float	r,
		float	g,
		float	b,
		float	a
	)			`[inline]`

Definition at line 77 of file MercuryObject.h.

const MString& MercuryObject::GetName ( ) const [inline]

Definition at line 78 of file MercuryObject.h.

const MercuryMaterial* MercuryObject::GetMaterial ( ) const [inline]

Definition at line 79 of file MercuryObject.h.

const MercuryMaterial& MercuryObject::GetFinalMaterial ( ) const [inline]

Definition at line 80 of file MercuryObject.h.

const MercuryColor& MercuryObject::GetDiffuse ( ) [inline]

Definition at line 81 of file MercuryObject.h.

const MercuryColor& MercuryObject::GetEmissive ( ) [inline]

Definition at line 82 of file MercuryObject.h.

const MercuryColor& MercuryObject::GetSpecular ( ) [inline]

Definition at line 83 of file MercuryObject.h.

const MercuryColor& MercuryObject::GetAmbient ( ) [inline]

Definition at line 84 of file MercuryObject.h.

void MercuryObject::GetDiffusef	(	float &	r,
		float &	g,
		float &	b,
		float &	a
	)

virtual MercuryObject* MercuryObject::Spawn	(	const MString &	sClass,
		const MString &	sName,
		PROJECTIONTYPE	projection = `PERSPECTIVE`
	)			`[virtual]`

Reimplemented in MercuryScreen.

unsigned int MercuryObject::GetNumChildren ( ) const [inline]

Definition at line 87 of file MercuryObject.h.

virtual void MercuryObject::SetHAlignment ( HALIGN alignment ) [inline, virtual]

Definition at line 93 of file MercuryObject.h.

HALIGN MercuryObject::GetHAlignment ( ) const [inline]

Definition at line 94 of file MercuryObject.h.

virtual void MercuryObject::SetVAlignment ( VALIGN alignment ) [inline, virtual]

Definition at line 95 of file MercuryObject.h.

VALIGN MercuryObject::GetVAlignment ( ) const [inline]

Definition at line 96 of file MercuryObject.h.

void MercuryObject::Prerender ( ) [virtual]

Add another object to this object's children.

MercuryObject takes on an object and a ParentDelete. if bParentDelete == true, then the parent you are adding object to will delete object when the parent is deleted.

Reimplemented in MercuryCamera, MercuryDynTex, and MercuryTexture.

Definition at line 98 of file MercuryObject.cpp.

void MercuryObject::Render ( ) [virtual]

Reimplemented in MercuryCamera, MercuryLight, MercuryScreen, MercuryTexture, and ScreenMapEditor.

Definition at line 149 of file MercuryObject.cpp.

void MercuryObject::CustomRender ( ) [virtual]

Reimplemented in MercuryDynTex, MercuryParticleField, and MercuryText.

Definition at line 171 of file MercuryObject.cpp.

void MercuryObject::ComputeCull ( )

Definition at line 129 of file MercuryObject.cpp.

bool MercuryObject::IsCulled ( ) const [inline]

Definition at line 111 of file MercuryObject.h.