CrystalSpace

Public API Reference

CS::Engine::MovableSectorList Class Reference

A list of sectors as the movable uses it. More...

#include <cstool/basemovable.h>

Inheritance diagram for CS::Engine::MovableSectorList:

List of all members.

Public Member Functions

virtual int Add (iSector *obj)
 Add a sector.
virtual int Find (iSector *obj) const
 Find a sector and return its index.
virtual iSectorFindByName (const char *Name) const
 Find a sector by its name.
virtual iSectorGet (int n) const
 Return the sector at the given index.
virtual int GetCount () const
 Return the number of sectors in this list.
virtual bool Remove (int n)
 Remove the sector at the given index.
virtual bool Remove (iSector *obj)
 Remove a sector.
virtual void RemoveAll ()
 Remove all sectors.

Detailed Description

A list of sectors as the movable uses it.

Definition at line 42 of file basemovable.h.


Member Function Documentation

virtual int CS::Engine::MovableSectorList::Add ( iSector obj  )  [virtual]

Add a sector.

Returns:
The index of the newly added sector.

Implements iSectorList.

virtual int CS::Engine::MovableSectorList::Find ( iSector obj  )  const [virtual]

Find a sector and return its index.

Returns:
The index of the sector, or csArrayItemNotFound if the sector was not found

Implements iSectorList.

virtual iSector* CS::Engine::MovableSectorList::FindByName ( const char *  Name  )  const [virtual]

Find a sector by its name.

Returns:
The sector with the given name, or 0 if the name was not found.

Implements iSectorList.

virtual iSector* CS::Engine::MovableSectorList::Get ( int  n  )  const [inline, virtual]

Return the sector at the given index.

Implements iSectorList.

Definition at line 62 of file basemovable.h.

virtual int CS::Engine::MovableSectorList::GetCount (  )  const [inline, virtual]

Return the number of sectors in this list.

Implements iSectorList.

Definition at line 61 of file basemovable.h.

virtual bool CS::Engine::MovableSectorList::Remove ( int  n  )  [virtual]

Remove the sector at the given index.

Returns:
True if the given index was valid, false otherwise.

Implements iSectorList.

virtual bool CS::Engine::MovableSectorList::Remove ( iSector obj  )  [virtual]

Remove a sector.

Returns:
True if the sector has been found and deleted, false otherwise.

Implements iSectorList.

virtual void CS::Engine::MovableSectorList::RemoveAll (  )  [virtual]

Remove all sectors.

Implements iSectorList.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1