CCmpFootprint Class Reference

Inheritance diagram for CCmpFootprint:

Public Member Functions
virtual void	Init (const CParamNode &paramNode)
virtual void	Deinit ()
virtual void	Serialize (ISerializer &serialize)
virtual void	Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)
virtual void	GetShape (EShape &shape, entity_pos_t &size0, entity_pos_t &size1, entity_pos_t &height)
	Return the shape of this footprint. More...
virtual CFixedVector3D	PickSpawnPoint (entity_id_t spawned)
	Pick a sensible position to place a newly-spawned entity near this footprint, such that it won't be in an invalid (obstructed) location regardless of the spawned unit's orientation. More...
Public Member Functions inherited from ICmpFootprint
CScriptVal	GetShape_wrapper ()
	GetShape wrapper for script calls. More...
Public Member Functions inherited from IComponent
virtual	~IComponent ()
virtual void	HandleMessage (const CMessage &msg, bool global)
CEntityHandle	GetEntityHandle () const
void	SetEntityHandle (CEntityHandle ent)
entity_id_t	GetEntityId () const
CEntityHandle	GetSystemEntity () const
const CSimContext &	GetSimContext () const
void	SetSimContext (const CSimContext &context)
virtual JSClass *	GetJSClass () const
virtual jsval	GetJSInstance () const

Static Public Member Functions
static void	ClassInit (CComponentManager &componentManager)
static IComponent *	Allocate (ScriptInterface &, jsval)
static void	Deallocate (IComponent *cmp)
static std::string	GetSchema ()
Static Public Member Functions inherited from IComponent
static std::string	GetSchema ()
static u8	GetSerializationVersion ()

Public Attributes
EShape	m_Shape
entity_pos_t	m_Size0
entity_pos_t	m_Size1
entity_pos_t	m_Height

Additional Inherited Members
Public Types inherited from ICmpFootprint
enum	EShape { CIRCLE, SQUARE }

Detailed Description

Definition at line 32 of file CCmpFootprint.cpp.

Member Function Documentation

static IComponent* CCmpFootprint::Allocate ( ScriptInterface &  , jsval    )

inlinestatic

Definition at line 39 of file CCmpFootprint.cpp.

static void CCmpFootprint::ClassInit ( CComponentManager &  componentManager )

inlinestatic

Definition at line 35 of file CCmpFootprint.cpp.

static void CCmpFootprint::Deallocate ( IComponent *  cmp )

inlinestatic

Definition at line 39 of file CCmpFootprint.cpp.

virtual void CCmpFootprint::Deinit ( )

inlinevirtual

Implements IComponent.

Definition at line 102 of file CCmpFootprint.cpp.

virtual void CCmpFootprint::Deserialize ( const CParamNode &  paramNode, IDeserializer &  deserialize  )

inlinevirtual

Implements IComponent.

Definition at line 111 of file CCmpFootprint.cpp.

static std::string CCmpFootprint::GetSchema ( )

inlinestatic

Definition at line 46 of file CCmpFootprint.cpp.

virtual void CCmpFootprint::GetShape ( EShape &  shape, entity_pos_t &  size0, entity_pos_t &  size1, entity_pos_t &  height  )

inlinevirtual

Return the shape of this footprint.

Shapes are horizontal circles or squares, extended vertically upwards to make cylinders or boxes.

Parameters

[out]	shape	either CIRCLE or SQUARE
[out]	size0	if CIRCLE then radius, else width (size in X axis)
[out]	size1	if CIRCLE then radius, else depth (size in Z axis)
[out]	height	size in Y axis

Implements ICmpFootprint.

Definition at line 116 of file CCmpFootprint.cpp.

virtual void CCmpFootprint::Init ( const CParamNode &  paramNode )

inlinevirtual

Implements IComponent.

Definition at line 79 of file CCmpFootprint.cpp.

virtual CFixedVector3D CCmpFootprint::PickSpawnPoint ( entity_id_t  spawned )

inlinevirtual

Pick a sensible position to place a newly-spawned entity near this footprint, such that it won't be in an invalid (obstructed) location regardless of the spawned unit's orientation.

Returns

the X and Z coordinates of the spawn point, with Y = 0; or the special value (-1, -1, -1) if there's no space

Implements ICmpFootprint.

Definition at line 124 of file CCmpFootprint.cpp.

virtual void CCmpFootprint::Serialize ( ISerializer &  serialize )

inlinevirtual

Implements IComponent.

Definition at line 106 of file CCmpFootprint.cpp.

Member Data Documentation

entity_pos_t CCmpFootprint::m_Height

Definition at line 44 of file CCmpFootprint.cpp.

EShape CCmpFootprint::m_Shape

Definition at line 41 of file CCmpFootprint.cpp.

entity_pos_t CCmpFootprint::m_Size0

Definition at line 42 of file CCmpFootprint.cpp.

entity_pos_t CCmpFootprint::m_Size1

Definition at line 43 of file CCmpFootprint.cpp.

---

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

• /home/sathyam/0ad.svn/source/simulation2/components/CCmpFootprint.cpp