CrystalSpace

Public API Reference

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

csRegion Class Reference

A region. More...

#include <region.h>

Inheritance diagram for csRegion:

csObject iObject iBase List of all members.

Public Methods

 csRegion (csEngine *)
 Initialize an empty region. More...

virtual ~csRegion ()
 Delete the region without deleting the entities in it. More...

virtual void Add (iObject *obj)
 Add an object to this region. More...

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

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

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

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

virtual bool Prepare ()
 Prepare all objects 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 32 of file csengine/region.h.


Constructor & Destructor Documentation

csRegion::csRegion csEngine  
 

Initialize an empty region.

virtual csRegion::~csRegion   [virtual]
 

Delete the region without deleting the entities in it.

The entities in this region will simply get unconnected.


Member Function Documentation

virtual void csRegion::Add iObject   obj [inline, virtual]
 

Add an object to this region.

Definition at line 52 of file csengine/region.h.

References csObject::ObjAdd.

virtual void csRegion::DeleteAll   [virtual]
 

Delete all entities in this region.

virtual bool csRegion::IsInRegion iObject   obj [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 csRegion::Prepare   [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 csRegion::PrepareTextures   [virtual]
 

Prepare all textures and materials in this region.

virtual bool csRegion::ShineLights   [virtual]
 

Do lighting calculations (or read from cache).


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