CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

iRegion Struct Reference
[Crystal Space 3D Engine]

A region. More...

#include <region.h>

Inheritance diagram for iRegion:

iBase List of all members.

Public Methods

virtual iObjectQueryObject ()=0
 Get the iObject for this region. More...

virtual void Clear ()=0
 Clear this region without removing the entities in it. More...

virtual void DeleteAll ()=0
 Delete all entities in this region. More...

virtual bool PrepareTextures ()=0
 Prepare all textures and materials in this region. More...

virtual bool ShineLights ()=0
 Do lighting calculations (or read from cache). More...

virtual bool Prepare ()=0
 Prepare all objects in this region. More...

virtual iSectorFindSector (const char *iName)=0
 Find a sector in this region by name. More...

virtual iMeshWrapperFindMeshObject (const char *iName)=0
 Find a sprite in this region by name. More...

virtual iMeshFactoryWrapperFindMeshFactory (const char *iName)=0
 Find a mesh factory in this region by name. More...

virtual iTextureWrapperFindTexture (const char *iName)=0
 Find a texture in this region by name. More...

virtual iMaterialWrapperFindMaterial (const char *iName)=0
 Find a material in this region by name. More...

virtual iCameraPositionFindCameraPosition (const char *iName)=0
 Find a camera position in this region by name. More...

virtual iCollectionFindCollection (const char *iName)=0
 Find a collection in this region by name. More...

virtual bool IsInRegion (iObject *obj)=0
 Check if some object is in this region. More...


Detailed Description

A region.

A region is basically a collection of objects in the 3D engine that can be treated as a unit.

Definition at line 48 of file iengine/region.h.


Member Function Documentation

virtual void iRegion::Clear   [pure virtual]
 

Clear this region without removing the entities in it.

The entities will simply get unconnected from this region.

virtual void iRegion::DeleteAll   [pure virtual]
 

Delete all entities in this region.

virtual iCameraPosition* iRegion::FindCameraPosition const char *    iName [pure virtual]
 

Find a camera position in this region by name.

virtual iCollection* iRegion::FindCollection const char *    iName [pure virtual]
 

Find a collection in this region by name.

virtual iMaterialWrapper* iRegion::FindMaterial const char *    iName [pure virtual]
 

Find a material in this region by name.

virtual iMeshFactoryWrapper* iRegion::FindMeshFactory const char *    iName [pure virtual]
 

Find a mesh factory in this region by name.

virtual iMeshWrapper* iRegion::FindMeshObject const char *    iName [pure virtual]
 

Find a sprite in this region by name.

virtual iSector* iRegion::FindSector const char *    iName [pure virtual]
 

Find a sector in this region by name.

virtual iTextureWrapper* iRegion::FindTexture const char *    iName [pure virtual]
 

Find a texture in this region by name.

virtual bool iRegion::IsInRegion iObject   obj [pure virtual]
 

Check if some object is in this region.

The speed of this function is independent of the number of objects in this region (i.e. very fast).

virtual bool iRegion::Prepare   [pure virtual]
 

Prepare all objects in this region.

This has to be called directly after loading new objects. This function is equivalent to calling PrepareTextures() followed by ShineLights().

virtual bool iRegion::PrepareTextures   [pure virtual]
 

Prepare all textures and materials in this region.

virtual iObject* iRegion::QueryObject   [pure virtual]
 

Get the iObject for this region.

virtual bool iRegion::ShineLights   [pure virtual]
 

Do lighting calculations (or read from cache).


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14