Public API Reference

                 

---

csSectorList Class Reference

List of 3D engine sectors. More...

#include <sector.h>

Inheritance diagram for csSectorList:

List of all members.

Public Methods
	csSectorList (bool CleanupReferences)
	constructor. More...
virtual	~csSectorList ()
	destructor. More...
virtual void	FreeItem (iSector *item)
	Override FreeItem. More...
virtual int	GetCount () const
	Return the number of sectors in this list. More...
virtual iSector *	Get (int n) const
	Return a sector by index. More...
virtual int	Add (iSector *obj)
	Add a sector. More...
virtual bool	Remove (iSector *obj)
	Remove a sector. More...
virtual bool	Remove (int n)
	Remove the nth sector. More...
virtual void	RemoveAll ()
	Remove all sectors. More...
virtual int	Find (iSector *obj) const
	Find a sector and return its index. More...
virtual iSector *	FindByName (const char *Name) const
	Find a sector by name. More...

---

Detailed Description

List of 3D engine sectors.

Definition at line 555 of file csengine/sector.h.

---

Constructor & Destructor Documentation

csSectorList::csSectorList (  bool    CleanupReferences )

constructor.

virtual csSectorList::~csSectorList (    )  [inline, virtual]

destructor. Definition at line 567 of file csengine/sector.h. References RemoveAll.

---

Member Function Documentation

virtual int csSectorList::Add (  iSector *    obj )  [virtual]

Add a sector. Implements iSectorList.

virtual int csSectorList::Find (  iSector *    obj )  const [virtual]

Find a sector and return its index. Implements iSectorList.

virtual iSector* csSectorList::FindByName (  const char *    Name )  const [virtual]

Find a sector by name. Implements iSectorList.

virtual void csSectorList::FreeItem (  iSector *    item )  [virtual]

Override FreeItem.

virtual iSector* csSectorList::Get (  int    n )  const [inline, virtual]

Return a sector by index. Implements iSectorList. Definition at line 573 of file csengine/sector.h. References csArray< T *, csRefArrayElementHandler< T * > >::Get.

virtual int csSectorList::GetCount (    )  const [inline, virtual]

Return the number of sectors in this list. Implements iSectorList. Definition at line 572 of file csengine/sector.h. References csArray< T *, csRefArrayElementHandler< T * > >::Length.

virtual bool csSectorList::Remove (  int    n )  [virtual]

Remove the nth sector. Implements iSectorList.

virtual bool csSectorList::Remove (  iSector *    obj )  [virtual]

Remove a sector. Implements iSectorList.

virtual void csSectorList::RemoveAll (    )  [virtual]

Remove all sectors. Implements iSectorList. Referenced by ~csSectorList.

---

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

• csengine/sector.h

---