CEL

Public API Reference

iCelEntityTracker Struct Reference

This structure maintains a tracker for entities. More...

#include <physicallayer/pl.h>

Inheritance diagram for iCelEntityTracker:

List of all members.

Public Member Functions

virtual void AddEntities (iCelEntityTracker *tracker)=0
 Add all entities in the given tracker to this tracker.
virtual bool AddEntity (iCelEntity *entity)=0
 Add an entity to this tracker.
virtual csPtr< iCelEntityListFindNearbyEntities (iSector *sector, const csVector3 &pos, float radius, csStringID cls=csInvalidStringID)=0
 Find all entities that are within a certain radius of a given object.
virtual csPtr< iCelEntityIteratorGetIterator ()=0
 Get an iterator for all entities in this tracker.
virtual const char * GetName () const =0
 Get the name of this tracker.
virtual void RemoveEntities (iCelEntityTracker *tracker)=0
 Remove all entities in the given tracker from this tracker.
virtual void RemoveEntities ()=0
 Remove all entities from this tracker.
virtual void RemoveEntity (iCelEntity *entity)=0
 Remove an entity from this tracker.

Detailed Description

This structure maintains a tracker for entities.

You can use this to find all entities near some location. Note that this only works on entities with a pcmesh property class.

Definition at line 688 of file pl.h.


Member Function Documentation

virtual void iCelEntityTracker::AddEntities ( iCelEntityTracker tracker  )  [pure virtual]

Add all entities in the given tracker to this tracker.

virtual bool iCelEntityTracker::AddEntity ( iCelEntity entity  )  [pure virtual]

Add an entity to this tracker.

This only works on entities that have a pcmesh property class. It will return false if that property class is missing.

virtual csPtr<iCelEntityList> iCelEntityTracker::FindNearbyEntities ( iSector sector,
const csVector3 pos,
float  radius,
csStringID  cls = csInvalidStringID 
) [pure virtual]

Find all entities that are within a certain radius of a given object.

Parameters:
cls If this is not equal to csInvalidStringID then only entities that have that class will be returned.
virtual csPtr<iCelEntityIterator> iCelEntityTracker::GetIterator (  )  [pure virtual]

Get an iterator for all entities in this tracker.

virtual const char* iCelEntityTracker::GetName (  )  const [pure virtual]

Get the name of this tracker.

virtual void iCelEntityTracker::RemoveEntities ( iCelEntityTracker tracker  )  [pure virtual]

Remove all entities in the given tracker from this tracker.

virtual void iCelEntityTracker::RemoveEntities (  )  [pure virtual]

Remove all entities from this tracker.

virtual void iCelEntityTracker::RemoveEntity ( iCelEntity entity  )  [pure virtual]

Remove an entity from this tracker.


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

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1