Drag[en]gine Game Engine  1.0
deBaseGraphicModule Class Referenceabstract

Base Graphic Module. More...

#include <deBaseGraphicModule.h>

Inheritance diagram for deBaseGraphicModule:
deBaseModule

Public Member Functions

Constructors and Destructors
 deBaseGraphicModule (deLoadableModule &loadableModule)
 
virtual ~deBaseGraphicModule ()
 
Module Management
virtual bool Init (deRenderWindow *renderWindow)=0
 
virtual void CleanUp ()=0
 
virtual void InputOverlayCanvasChanged ()
 Input system overlay canvas view changed. More...
 
virtual void RenderWindows ()=0
 Render windows. More...
 
Notifications
virtual deBaseGraphicBillboardCreateBillboard (deBillboard *billboard)=0
 
virtual deBaseGraphicCanvasCreateCanvas (deCanvas *canvas)
 Create a peer for the given canvas. More...
 
virtual deBaseGraphicCaptureCanvasCreateCaptureCanvas (deCaptureCanvas *captureCanvas)
 Create peer for capture canvas. More...
 
virtual deBaseGraphicCameraCreateCamera (deCamera *camera)=0
 
virtual deBaseGraphicComponentCreateComponent (deComponent *comp)=0
 
virtual deBaseGraphicDebugDrawerCreateDebugDrawer (deDebugDrawer *debugDrawer)=0
 
virtual deBaseGraphicDecalCreateDecal (deDecal *decal)=0
 
virtual deBaseGraphicDynamicSkinCreateDynamicSkin (deDynamicSkin *dynamicSkin)
 
virtual deBaseGraphicEffectCreateEffect (deEffect *effect)=0
 
virtual deBaseGraphicEnvMapProbeCreateEnvMapProbe (deEnvMapProbe *envMapProbe)
 
virtual deBaseGraphicFontCreateFont (deFont *font)=0
 
virtual deBaseGraphicHeightTerrainCreateHeightTerrain (deHeightTerrain *heightTerrain)=0
 
virtual deBaseGraphicImageCreateImage (deImage *image)=0
 
virtual deBaseGraphicLightCreateLight (deLight *light)=0
 
virtual deBaseGraphicLumimeterCreateLumimeter (deLumimeter *lumimeter)=0
 
virtual deBaseGraphicModelCreateModel (deModel *model)=0
 
virtual deBaseGraphicOcclusionMeshCreateOcclusionMesh (deOcclusionMesh *occmesh)
 
virtual deBaseGraphicParticleEmitterCreateParticleEmitter (deParticleEmitter *emitter)=0
 
virtual deBaseGraphicParticleEmitterInstanceCreateParticleEmitterInstance (deParticleEmitterInstance *instance)=0
 
virtual deBaseGraphicPropFieldCreatePropField (dePropField *propField)=0
 
virtual deBaseGraphicRenderWindowCreateRenderWindow (deRenderWindow *renderWindow)=0
 
virtual deBaseGraphicSkinCreateSkin (deSkin *skin)=0
 
virtual deBaseGraphicSkyCreateSky (deSky *sky)=0
 
virtual deBaseGraphicSmokeEmitterCreateSmokeEmitter (deSmokeEmitter *smokeEmitter)=0
 
virtual deBaseGraphicVideoCreateVideo (deVideo *video)
 
virtual deBaseGraphicVideoPlayerCreateVideoPlayer (deVideoPlayer *videoPlayer)
 
virtual deBaseGraphicWorldCreateWorld (deWorld *world)=0
 
- Public Member Functions inherited from deBaseModule
 deBaseModule (deLoadableModule &loadableModule)
 Creates a new base module. More...
 
virtual ~deBaseModule ()
 Cleans up the base module. More...
 
virtual int GetParameterCount () const
 Retrieves the count of parameters. More...
 
virtual void GetParameterInfo (int index, deModuleParameter *parameter) const
 Retrieves the informations about the given indexec parameter. More...
 
virtual int FindParameter (const char *name) const
 Retrieves the index of the parameter with the given name or -1 if not found. More...
 
virtual float GetParameterValue (int index) const
 Retrieves the value of the parameter at the given index. More...
 
virtual void SetParameterValue (int index, float value)
 Sets the parameter of the parameter at the given index. More...
 
virtual void SendCommand (const decUnicodeArgumentList &command, decUnicodeString &answer)
 Sends a command to the module and retrieves an answer from it. More...
 
void LogInfo (const char *message)
 Outputs an information message on the console. More...
 
void LogInfoFormat (const char *message,...)
 Outputs a formated information message on the console. More...
 
void LogInfoFormatUsing (const char *message, va_list args)
 Outputs a formated information message on the console. More...
 
void LogWarn (const char *message)
 Outputs a warning message on the console. More...
 
void LogWarnFormat (const char *message,...)
 Outputs a formated warning message on the console. More...
 
void LogWarnFormatUsing (const char *message, va_list args)
 Outputs a formated warning message on the console. More...
 
void LogError (const char *message)
 Outputs an error message on the console. More...
 
void LogErrorFormat (const char *message,...)
 Outputs a formated error message on the console. More...
 
void LogErrorFormatUsing (const char *message, va_list args)
 Outputs a formated error message on the console. More...
 
void LogException (const deException &exception)
 Outputs an exception as error message on the console. More...
 
deEngineGetGameEngine () const
 Retrieves the game engine object. More...
 
deLoadableModuleGetLoadableModule () const
 Retrieves the loadable module. More...
 
deOSGetOS () const
 Retrieves the os object from the game engine. More...
 
deVirtualFileSystemGetVFS () const
 Retrieves the module virtual file system. More...
 
deErrorTracePointSetErrorTrace (const char *error, const char *sourceFunc, int sourceLine)
 Adds a new trace point and sets the error if the trace is empty. More...
 
deErrorTracePointSetErrorTrace (const deException &exception)
 Adds a new trace point and sets the error if the trace is empty. More...
 
deErrorTracePointAddErrorTracePoint (const char *sourceFunc, int sourceLine)
 Adds a new trace point to the engine error trace with an empty error. More...
 

Detailed Description

Base Graphic Module.

Author
Plss Roland
Version
1.0
Date
2008

Constructor & Destructor Documentation

◆ deBaseGraphicModule()

deBaseGraphicModule::deBaseGraphicModule ( deLoadableModule loadableModule)

Creates a new module.

◆ ~deBaseGraphicModule()

virtual deBaseGraphicModule::~deBaseGraphicModule ( )
virtual

Cleans up the module.

Member Function Documentation

◆ CleanUp()

virtual void deBaseGraphicModule::CleanUp ( )
pure virtual

Called to cleanup the module. All resources have to be freed and running threads stopped or killed if needed.

◆ CreateBillboard()

virtual deBaseGraphicBillboard* deBaseGraphicModule::CreateBillboard ( deBillboard billboard)
pure virtual

Create a peer for the given billboard.

◆ CreateCamera()

virtual deBaseGraphicCamera* deBaseGraphicModule::CreateCamera ( deCamera camera)
pure virtual

Create a peer for the given camera.

◆ CreateCanvas()

virtual deBaseGraphicCanvas* deBaseGraphicModule::CreateCanvas ( deCanvas canvas)
virtual

Create a peer for the given canvas.

◆ CreateCaptureCanvas()

virtual deBaseGraphicCaptureCanvas* deBaseGraphicModule::CreateCaptureCanvas ( deCaptureCanvas captureCanvas)
virtual

Create peer for capture canvas.

◆ CreateComponent()

virtual deBaseGraphicComponent* deBaseGraphicModule::CreateComponent ( deComponent comp)
pure virtual

Create a peer for the given component.

◆ CreateDebugDrawer()

virtual deBaseGraphicDebugDrawer* deBaseGraphicModule::CreateDebugDrawer ( deDebugDrawer debugDrawer)
pure virtual

Create a peer for the given debug drawer.

◆ CreateDecal()

virtual deBaseGraphicDecal* deBaseGraphicModule::CreateDecal ( deDecal decal)
pure virtual

Create a peer for the given decal.

◆ CreateDynamicSkin()

virtual deBaseGraphicDynamicSkin* deBaseGraphicModule::CreateDynamicSkin ( deDynamicSkin dynamicSkin)
virtual

Create a peer for the given dynamic skin.

◆ CreateEffect()

virtual deBaseGraphicEffect* deBaseGraphicModule::CreateEffect ( deEffect effect)
pure virtual

Create a peer for the given effect.

◆ CreateEnvMapProbe()

virtual deBaseGraphicEnvMapProbe* deBaseGraphicModule::CreateEnvMapProbe ( deEnvMapProbe envMapProbe)
virtual

Create a peer for the given environment map probe.

◆ CreateFont()

virtual deBaseGraphicFont* deBaseGraphicModule::CreateFont ( deFont font)
pure virtual

Create a peer for the given font.

◆ CreateHeightTerrain()

virtual deBaseGraphicHeightTerrain* deBaseGraphicModule::CreateHeightTerrain ( deHeightTerrain heightTerrain)
pure virtual

Create a peer for the given height terrain.

◆ CreateImage()

virtual deBaseGraphicImage* deBaseGraphicModule::CreateImage ( deImage image)
pure virtual

Create a peer for the given image.

◆ CreateLight()

virtual deBaseGraphicLight* deBaseGraphicModule::CreateLight ( deLight light)
pure virtual

Create a peer for the given light.

◆ CreateLumimeter()

virtual deBaseGraphicLumimeter* deBaseGraphicModule::CreateLumimeter ( deLumimeter lumimeter)
pure virtual

Create a peer for the given lumimeter.

◆ CreateModel()

virtual deBaseGraphicModel* deBaseGraphicModule::CreateModel ( deModel model)
pure virtual

Ccreat a peer for the given model.

◆ CreateOcclusionMesh()

virtual deBaseGraphicOcclusionMesh* deBaseGraphicModule::CreateOcclusionMesh ( deOcclusionMesh occmesh)
virtual

Create a peer for the given occlusion mesh.

◆ CreateParticleEmitter()

virtual deBaseGraphicParticleEmitter* deBaseGraphicModule::CreateParticleEmitter ( deParticleEmitter emitter)
pure virtual

Create a peer for the given particle emitter.

◆ CreateParticleEmitterInstance()

virtual deBaseGraphicParticleEmitterInstance* deBaseGraphicModule::CreateParticleEmitterInstance ( deParticleEmitterInstance instance)
pure virtual

Create a peer for the given particle emitter instance.

◆ CreatePropField()

virtual deBaseGraphicPropField* deBaseGraphicModule::CreatePropField ( dePropField propField)
pure virtual

Create a peer for the given prop field.

◆ CreateRenderWindow()

virtual deBaseGraphicRenderWindow* deBaseGraphicModule::CreateRenderWindow ( deRenderWindow renderWindow)
pure virtual

Create a peer for the given render window.

◆ CreateSkin()

virtual deBaseGraphicSkin* deBaseGraphicModule::CreateSkin ( deSkin skin)
pure virtual

Create a peer for the given skin.

◆ CreateSky()

virtual deBaseGraphicSky* deBaseGraphicModule::CreateSky ( deSky sky)
pure virtual

Create a peer for the given sky.

◆ CreateSmokeEmitter()

virtual deBaseGraphicSmokeEmitter* deBaseGraphicModule::CreateSmokeEmitter ( deSmokeEmitter smokeEmitter)
pure virtual

Create a peer for the given smoke emitter.

◆ CreateVideo()

virtual deBaseGraphicVideo* deBaseGraphicModule::CreateVideo ( deVideo video)
virtual

Create a peer for the given video.

◆ CreateVideoPlayer()

virtual deBaseGraphicVideoPlayer* deBaseGraphicModule::CreateVideoPlayer ( deVideoPlayer videoPlayer)
virtual

Create a peer for the given video player.

◆ CreateWorld()

virtual deBaseGraphicWorld* deBaseGraphicModule::CreateWorld ( deWorld world)
pure virtual

Create a peer for the given world.

◆ Init()

virtual bool deBaseGraphicModule::Init ( deRenderWindow renderWindow)
pure virtual

Called to init the module and prepare it for rendering. Returns true on success. To access the os of the engine use the GetOS function.

◆ InputOverlayCanvasChanged()

virtual void deBaseGraphicModule::InputOverlayCanvasChanged ( )
virtual

Input system overlay canvas view changed.

◆ RenderWindows()

virtual void deBaseGraphicModule::RenderWindows ( )
pure virtual

Render windows.

Tells the graphic module changes for this frame update are finished and the existing render windows can be rendered if required. Depending on the graphic module implementation this can be a synchronous rendering in the main thread or an asynchronous rendering in a render thread. Most modules will use a render thread though. This is a synchronization point and execution will return once the graphic module has finished all necessary preparation and rendering tasks if required. After the call returns the operating system window resources are guaranteed to be valid either with the current frame changes or the image rendered since the last call to RenderWindows(). It is at the distretion of the graphic module to decide if it shows the last frame or the current frame for best performance. For this reason run RenderWindows in regular intervals.


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