Planeshift
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes

GEMClientObject Class Reference

An object that the client knows about. More...

#include <pscelclient.h>

List of all members.

Public Member Functions

virtual void ChangeName (const char *name)
virtual bool CheckLoadStatus ()
 Delayed mesh loading.
int Flags ()
 Get the flag bit field.
 GEMClientObject ()
 GEMClientObject (psCelClient *cel, EID id)
virtual const csBox3 & GetBBox () const
 Return the bounding box of this entity.
EID GetEID ()
psEffectGetEntityLabel ()
const char * GetFactName ()
virtual int GetMasqueradeType ()
iMeshWrapper * GetMesh () const
 Get the mesh that this object has.
virtual const char * GetName ()
virtual GEMOBJECT_TYPE GetObjectType ()
virtual csVector3 GetPosition ()
 Get position of entity.
virtual float GetRotation ()
 Get rotation of entity as returned by psWorld::Matrix2YRot.
virtual iSector * GetSector () const
 Get sector of entity.
virtual iSectorList * GetSectors () const
 Get list of sectors that entity is in.
psEffectGetShadow ()
int GetType ()
bool HasLabel () const
bool HasShadow () const
virtual bool IsAlive ()
 Indicate if this object is alive.
void LoadMesh ()
 Start loading the mesh.
void Move (const csVector3 &pos, const csVector3 &rotangle, const char *room)
 Set the position of mesh.
virtual void PostLoad (bool)
 Delayed load 'post-process'.
float RangeTo (GEMClientObject *obj, bool ignoreY)
void Rotate (float xRot, float yRot, float zRot)
 Set the rotation of mesh.
void SetEntityLabel (psEffect *el)
virtual void SetPosition (const csVector3 &pos, const csVector3 &rot, iSector *sector)
 Set position of entity.
void SetShadow (psEffect *shadow)
void SubstituteRacialMeshFact ()
 Performs helm group substitutions.
virtual void Update ()
virtual ~GEMClientObject ()

Static Public Member Functions

static void UnsetCelClient ()

Public Attributes

csRef< iMeshWrapper > pcmesh

Protected Attributes

EID eid
psEffectentitylabel
csString factName
int flags
 Various flags on the entity.
bool hasLabel
bool hasShadow
csRef< InstanceObjectinstance
csString matName
csString name
csRef< csShaderVariable > position
psEffectshadow
int type

Static Protected Attributes

static psCelClientcel

Detailed Description

An object that the client knows about.

This is the base object for any 'entity' that the client can be sent.

Definition at line 371 of file pscelclient.h.


Constructor & Destructor Documentation

GEMClientObject::GEMClientObject ( )
GEMClientObject::GEMClientObject ( psCelClient cel,
EID  id 
)
virtual GEMClientObject::~GEMClientObject ( ) [virtual]

Member Function Documentation

virtual void GEMClientObject::ChangeName ( const char *  name) [virtual]
virtual bool GEMClientObject::CheckLoadStatus ( ) [inline, virtual]

Delayed mesh loading.

Implements DelayedLoader.

Reimplemented in GEMClientActor, and GEMClientItem.

Definition at line 505 of file pscelclient.h.

int GEMClientObject::Flags ( ) [inline]

Get the flag bit field.

Returns:
The bit field that contains the flags on this actor.

Definition at line 478 of file pscelclient.h.

virtual const csBox3& GEMClientObject::GetBBox ( ) const [virtual]

Return the bounding box of this entity.

EID GEMClientObject::GetEID ( ) [inline]

Definition at line 425 of file pscelclient.h.

psEffect* GEMClientObject::GetEntityLabel ( ) [inline]

Definition at line 449 of file pscelclient.h.

const char* GEMClientObject::GetFactName ( ) [inline]

Definition at line 444 of file pscelclient.h.

virtual int GEMClientObject::GetMasqueradeType ( ) [virtual]

Reimplemented in GEMClientActor.

iMeshWrapper* GEMClientObject::GetMesh ( ) const

Get the mesh that this object has.

Returns:
The iMeshWrapper or 0 if no mesh.
virtual const char* GEMClientObject::GetName ( ) [inline, virtual]

Definition at line 438 of file pscelclient.h.

virtual GEMOBJECT_TYPE GEMClientObject::GetObjectType ( ) [inline, virtual]

Reimplemented in GEMClientActor, GEMClientItem, and GEMClientActionLocation.

Definition at line 378 of file pscelclient.h.

virtual csVector3 GEMClientObject::GetPosition ( ) [virtual]

Get position of entity.

virtual float GEMClientObject::GetRotation ( ) [virtual]

Get rotation of entity as returned by psWorld::Matrix2YRot.

Returns:
rotation about y axis
See also:
psWorld::Matrix2Yrot
virtual iSector* GEMClientObject::GetSector ( ) const [virtual]

Get sector of entity.

Reimplemented in GEMClientActor.

virtual iSectorList* GEMClientObject::GetSectors ( ) const [virtual]

Get list of sectors that entity is in.

psEffect* GEMClientObject::GetShadow ( ) [inline]

Definition at line 458 of file pscelclient.h.

int GEMClientObject::GetType ( ) [inline]

Definition at line 433 of file pscelclient.h.

bool GEMClientObject::HasLabel ( ) const [inline]

Definition at line 497 of file pscelclient.h.

bool GEMClientObject::HasShadow ( ) const [inline]

Definition at line 492 of file pscelclient.h.

virtual bool GEMClientObject::IsAlive ( ) [inline, virtual]

Indicate if this object is alive.

Reimplemented in GEMClientActor.

Definition at line 470 of file pscelclient.h.

void GEMClientObject::LoadMesh ( )

Start loading the mesh.

void GEMClientObject::Move ( const csVector3 &  pos,
const csVector3 &  rotangle,
const char *  room 
)

Set the position of mesh.

Parameters:
posthe coordinates of the mesh
rotanglethe y axis rotation of the mesh
roomthe sector in which the mesh is moved to
virtual void GEMClientObject::PostLoad ( bool  ) [inline, virtual]

Delayed load 'post-process'.

Definition at line 513 of file pscelclient.h.

float GEMClientObject::RangeTo ( GEMClientObject obj,
bool  ignoreY 
)
void GEMClientObject::Rotate ( float  xRot,
float  yRot,
float  zRot 
)

Set the rotation of mesh.

Parameters:
xRotthe variable used to set the x rotation of the item
yRotthe variable used to set the x rotation of the item
zRotthe variable used to set the z rotation of the item
void GEMClientObject::SetEntityLabel ( psEffect el) [inline]

Definition at line 453 of file pscelclient.h.

virtual void GEMClientObject::SetPosition ( const csVector3 &  pos,
const csVector3 &  rot,
iSector *  sector 
) [virtual]

Set position of entity.

void GEMClientObject::SetShadow ( psEffect shadow) [inline]

Definition at line 462 of file pscelclient.h.

void GEMClientObject::SubstituteRacialMeshFact ( )

Performs helm group substitutions.

static void GEMClientObject::UnsetCelClient ( ) [inline, static]

Definition at line 518 of file pscelclient.h.

virtual void GEMClientObject::Update ( ) [virtual]

Reimplemented in GEMClientActor.


Member Data Documentation

psCelClient* GEMClientObject::cel [static, protected]

Definition at line 524 of file pscelclient.h.

EID GEMClientObject::eid [protected]

Definition at line 529 of file pscelclient.h.

Definition at line 533 of file pscelclient.h.

csString GEMClientObject::factName [protected]

Definition at line 527 of file pscelclient.h.

Various flags on the entity.

Definition at line 532 of file pscelclient.h.

bool GEMClientObject::hasLabel [protected]

Definition at line 535 of file pscelclient.h.

bool GEMClientObject::hasShadow [protected]

Definition at line 536 of file pscelclient.h.

Definition at line 538 of file pscelclient.h.

csString GEMClientObject::matName [protected]

Definition at line 528 of file pscelclient.h.

csString GEMClientObject::name [protected]

Definition at line 526 of file pscelclient.h.

csRef<iMeshWrapper> GEMClientObject::pcmesh

Definition at line 429 of file pscelclient.h.

csRef<csShaderVariable> GEMClientObject::position [protected]

Definition at line 539 of file pscelclient.h.

Definition at line 534 of file pscelclient.h.

Definition at line 530 of file pscelclient.h.


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