Public Methods |
virtual csEngine* | GetCsEngine ()=0 |
| @@KLUDGE: This will no longer be needed once the iEngine interface is complete.
|
virtual iObject* | QueryObject ()=0 |
| Get the iObject for the engine.
|
virtual bool | Prepare (iProgressMeter *meter=NULL)=0 |
| Prepare the engine. More...
|
virtual void | PrepareTextures ()=0 |
| Prepare the textures. More...
|
virtual void | PrepareMeshes ()=0 |
| Calls UpdateMove for all meshes to initialise bsp bounding boxes. More...
|
virtual void | ShineLights (iRegion *region=NULL, iProgressMeter *meter=NULL)=0 |
| Calculate all lighting information. More...
|
virtual int | GetTextureFormat () const=0 |
| Query the format to load textures (usually this depends on texture manager).
|
virtual bool | IsPVS () const=0 |
| Return true if engine want to use PVS.
|
virtual void | SelectRegion (const char *name)=0 |
| Create or select a new region (name can be NULL for the default main region). More...
|
virtual void | SelectRegion (iRegion *region)=0 |
| Create or select a new region (region can be NULL for the default main region). More...
|
virtual iRegion* | GetCurrentRegion () const=0 |
| Get a reference to the current region (or NULL if the default main region is selected).
|
virtual void | DeleteAll ()=0 |
| Delete everything in the engine.
|
virtual void | RegisterRenderPriority (const char *name, long priority, int rendsort=CS_RENDPRI_NONE)=0 |
| Register a new render priority. More...
|
virtual long | GetRenderPriority (const char *name) const=0 |
| Get a render priority by name.
|
virtual int | GetRenderPrioritySorting (const char *name) const=0 |
| Get the render priority sorting flag.
|
virtual int | GetRenderPrioritySorting (long priority) const=0 |
| Get the render priority sorting flag.
|
virtual long | GetSkyRenderPriority () const=0 |
| Get the render priority for sky objects (attached to 'sky' name).
|
virtual long | GetWallRenderPriority () const=0 |
| Get the render priority for wall objects (attached to 'wall' name).
|
virtual long | GetObjectRenderPriority () const=0 |
| Get the render priority for general objects (attached to 'object' name).
|
virtual long | GetAlphaRenderPriority () const=0 |
| Get the render priority for alpha objects (attached to 'alpha' name).
|
virtual void | ClearRenderPriorities ()=0 |
| Clear all render priorities.
|
virtual iMaterial* | CreateBaseMaterial (iTextureWrapper *txt)=0 |
| Create a base material that can be used to give to the texture manager.
|
virtual iMaterial* | CreateBaseMaterial (iTextureWrapper *txt, int num_layers, iTextureWrapper **wrappers, csTextureLayer *layers)=0 |
| Create a base material that can be used to give to the texture manager. More...
|
virtual iTextureWrapper* | CreateTexture (const char *name, const char *fileName, csColor *transp, int flags)=0 |
| Register a texture to be loaded during Prepare().
|
virtual iMaterialWrapper* | CreateMaterial (const char *name, iTextureWrapper *texture)=0 |
| Register a material to be loaded during Prepare().
|
virtual iSector* | CreateSector (const char *name)=0 |
| Create a empty sector with given name.
|
virtual iMeshWrapper* | CreateSectorWallsMesh (iSector *sector, const char *name)=0 |
| Conveniance function to create the thing containing the convex outline of a sector. More...
|
virtual iSectorList* | GetSectors ()=0 |
| Get the list of sectors.
|
virtual iMeshFactoryList* | GetMeshFactories ()=0 |
| Get the list of mesh factories.
|
virtual iMeshList* | GetMeshes ()=0 |
| Get the list of meshes.
|
virtual iCollectionList* | GetCollections ()=0 |
| Get the list of collections.
|
virtual iCameraPositionList* | GetCameraPositions ()=0 |
| Get the list of camera positions.
|
virtual iTextureList* | GetTextureList () const=0 |
| Get the list of all textures.
|
virtual iMaterialList* | GetMaterialList () const=0 |
| Get the list of all materials.
|
virtual iRegionList* | GetRegions ()=0 |
| Get the list of all regions.
|
virtual iMaterialWrapper* | FindMaterial (const char *name, iRegion *region=NULL)=0 |
| Find the given material. More...
|
virtual iTextureWrapper* | FindTexture (const char *name, iRegion *region=NULL)=0 |
| Find the given texture. More...
|
virtual iSector* | FindSector (const char *name, iRegion *region=NULL)=0 |
| Find the given sector. More...
|
virtual iMeshWrapper* | FindMeshObject (const char *name, iRegion *region=NULL)=0 |
| Find the given mesh object. More...
|
virtual iMeshFactoryWrapper* | FindMeshFactory (const char *name, iRegion *region=NULL)=0 |
| Find the given mesh factory. More...
|
virtual iCameraPosition* | FindCameraPosition (const char *name, iRegion *region=NULL)=0 |
| Find the given camera position. More...
|
virtual iCollection* | FindCollection (const char *name, iRegion *region=NULL)=0 |
| Find the given collection. More...
|
virtual void | SetLightingCacheMode (int mode)=0 |
| Set the mode for the lighting cache (combination of CS_ENGINE_CACHE_???). More...
|
virtual int | GetLightingCacheMode ()=0 |
| Get the mode for the lighting cache.
|
virtual int | GetLightmapCellSize () const=0 |
| Return the current lightmap cell size.
|
virtual void | SetLightmapCellSize (int Size)=0 |
| Set lightmap cell size.
|
virtual iCamera* | CreateCamera ()=0 |
| Create a new camera.
|
virtual iStatLight* | CreateLight (const char *name, const csVector3 &pos, float radius, const csColor &color, bool pseudoDyn)=0 |
| Create a static/pseudo-dynamic light. name can be NULL.
|
virtual iStatLight* | FindLight (const char *Name, bool RegionOnly=false) const=0 |
| Find a static/pseudo-dynamic light by name.
|
virtual iDynLight* | CreateDynLight (const csVector3 &pos, float radius, const csColor &color)=0 |
| Create a dynamic light.
|
virtual void | RemoveDynLight (iDynLight *)=0 |
| Remove a dynamic light.
|
virtual void | SetClearZBuf (bool yesno)=0 |
| Require that the Z-buffer is cleared every frame. More...
|
virtual bool | GetClearZBuf () const=0 |
| Get the value of the clear Z-buffer flag set with SetClearZBuf().
|
virtual int | GetBeginDrawFlags () const=0 |
| Get the required flags for 3D->BeginDraw() which should be called from the application. More...
|
virtual void | SetEngineMode (int mode)=0 |
| Set the desired engine mode. More...
|
virtual int | GetEngineMode () const=0 |
| Get the current engine mode. More...
|
virtual iClipper2D* | GetTopLevelClipper () const=0 |
| Get the top-level clipper.
|
virtual iMeshFactoryWrapper* | CreateMeshFactory (const char *classId, const char *name)=0 |
| Conveniance function to create a mesh factory from a given type. More...
|
virtual iMeshFactoryWrapper* | CreateMeshFactory (iMeshObjectFactory *, const char *name)=0 |
| Create a mesh factory wrapper for an existing mesh factory.
|
virtual iMeshFactoryWrapper* | CreateMeshFactory (const char *name)=0 |
| Create an uninitialized mesh factory wrapper.
|
virtual iLoaderContext* | CreateLoaderContext (iRegion *region=NULL)=0 |
| Create a loader context that you can give to loader plugins. More...
|
virtual iMeshFactoryWrapper* | LoadMeshFactory (const char *name, const char *loaderClassId, iDataBuffer *input)=0 |
| Conveniance function to load a mesh factory from a given loader plugin.
|
virtual iMeshWrapper* | CreateMeshWrapper (iMeshFactoryWrapper *factory, const char *name, iSector *sector=NULL, const csVector3 &pos=csVector3(0, 0, 0))=0 |
| Conveniance function to create a mesh object for a given factory. More...
|
virtual iMeshWrapper* | CreateMeshWrapper (iMeshObject *, const char *name, iSector *sector=NULL, const csVector3 &pos=csVector3(0, 0, 0))=0 |
| Create a mesh wrapper for an existing mesh object.
|
virtual iMeshWrapper* | CreateMeshWrapper (const char *name)=0 |
| Create an uninitialized mesh wrapper.
|
virtual iMeshWrapper* | LoadMeshWrapper (const char *name, const char *loaderClassId, iDataBuffer *input, iSector *sector, const csVector3 &pos)=0 |
| Conveniance function to load a mesh object from a given loader plugin. More...
|
virtual iMeshObjectType* | GetThingType () const=0 |
| @@ This function is deprecated! Please don't use it! Only the engine and thing mesh objects should use this now.
|
virtual void | Draw (iCamera *c, iClipper2D *clipper)=0 |
| Draw the 3D world given a camera and a clipper. More...
|
virtual void | DrawFunc (iCamera *c, iClipper2D *clipper, iDrawFuncCallback *callback)=0 |
| This function is similar to Draw. More...
|
virtual void | SetContext (iGraphics3D *)=0 |
| Set the drawing context.
|
virtual iGraphics3D* | GetContext () const=0 |
| Return the current drawing context.
|
virtual void | SetAmbientLight (const csColor &)=0 |
| Set the amount of ambient light. More...
|
virtual void | GetAmbientLight (csColor &) const=0 |
| Return the amount of ambient light.
|
virtual int | GetNearbyLights (iSector *sector, const csVector3 &pos, uint32 flags, iLight **lights, int max_num_lights)=0 |
| This routine returns all lights which might affect an object at some position according to the following flags:
. More...
|
virtual iSectorIterator* | GetNearbySectors (iSector *sector, const csVector3 &pos, float radius)=0 |
| This routine returns an iterator to iterate over all nearby sectors. More...
|
virtual iObjectIterator* | GetNearbyObjects (iSector *sector, const csVector3 &pos, float radius)=0 |
| This routine returns an iterator to iterate over all objects of a given type that are within a radius of a given position. More...
|
virtual bool | RemoveObject (iBase *object)=0 |
| Conveniance function to 'remove' a CS object from the engine. More...
|
virtual void | SetCacheManager (iCacheManager *cache_mgr)=0 |
| Set the cache manager that the engine will use. More...
|
virtual iCacheManager* | GetCacheManager ()=0 |
| Get the cache manager that the engine is currently using.
|
The engine is responsible for creating new engine-specific objects such as sectors, things, sprites and so on.