OGLMachineLinux Class Reference
[VirtualMachine Related Documentations]

#include <OGLMachineLinux.h>

Inherits OGLMachine.

List of all members.


Detailed Description

Defines a AzurVeda Machine for linux systems, using OGLMachine for 3D and OSS for the sound server.

Definition at line 20 of file OGLMachineLinux.h.

Public Types

enum  eVMResult { vmr_OK = 0, vmr_FAILED }
 error enum for InitMachine() More...
enum  InternalObject3DBuffer_InitBit { bOb3D_VertexNormal = 1, bOb3D_VertexUVMapping = 2, bOb3D_VertexRGBA = 4 }
 see VirtualMachine::NewObject3DBuffer() More...
enum  eMachineLocalization {
  eMachineLocalization_LocalisationNotImplemented = 0, eMachineLocalization_English, eMachineLocalization_French, eMachineLocalization_SpanishCastellano,
  eMachineLocalization_German, eMachineLocalization_Italian, eMachineLocalization_Polish, eMachineLocalization_Portuguese
}
 This enum spots a cultural langage. returned by GetCurrentWorldLocalizationEnum(). More...

Public Member Functions

 OGLMachineLinux (void)
 Constructor.
virtual ~OGLMachineLinux (void)
 Destructor.
virtual eVMResult InitMachine ()
 Init.
virtual void SwapMainScreenBuffer ()
 Swap buffer so that what was drawn is shown.
virtual void ProcessInterface ()
 Check the Process the message of the interface, in the real time:.
virtual void SetSoundCurrentTime (int _seconds, unsigned int _fraction)
 force a date to the clock passed to the sound objects.
virtual void GetCurrentSoundBufferImage (float **const _ppSoundBuffer, unsigned int *_pLength) const
 For Information, an image of the current sound buffer. This is always a 2 float(left,right) table: The buffer size may vary. It can be used by preview methods or live effects.
virtual void SetSoundVolume (float _newVolumeValue)
 tool: change main volume [0,1]. Yes, you can saturate when >1.
virtual float GetSoundVolume ()
 tool: get main volume value [0,1].
virtual float GetPlayFrequency ()
 Return the machine main play frequency, in herz, (tick per sec).
virtual eMachineLocalization GetCurrentWorldLocalizationEnum ()
 Return the language of the machine, as a simple enum. It can be used by exemple.
virtual bool FileRequester (const char *_pDisplayString, char *_pResultFileName, unsigned int _nameMaxLength)
 In edition mode, ask a file path to a file requester. the string format should vary, but will be compatible with LoadFile() and SaveFile().
virtual const char * LoadFile (const char *_pFilePath, unsigned int _pFileStart, unsigned int &_LoadByteLength, unsigned int _maximumSizeLoad=0xffffffff)
 load a file into a memory chunk. You can load all in one row, or stream. memory is to be deleted by the CALLER with operator: "delete [] pointer", for each succesfull call. return 0L if failed.
virtual bool SaveFile (const char *_pFilePath, const char *_chunkToWrite, unsigned int _ChunkLength, bool _append=false)
 write a file from a memory chunk. You can save all in one row, or stream.
virtual void Sleep (unsigned int _milliseconds)
 in edition mode, redirection of machine task wait.
virtual void NewObject3DBuffer (InternalObject3DBuffer **_ppVertexAndPolygonBufferOut, unsigned int _maxNbVertex, unsigned int _maxNbTriangle, unsigned int _extraMemberFlags)
 Ask the Creation of a new InternalObject3DBuffer you can then fill with InternalObject3DBuffer::GetFirstVertex() , InternalObject3DBuffer::GetFirstTriangle() and InternalObject3DBuffer::SetNumberOfActiveTriangle() . Then the object can be positionned with the matrix methods, and drawn with RenderMesh() The object shape can be dynamic and rebuilt, until a call to CompileAsStatic(). In edition mode, object has to be destroyed with DeleteObject3DBuffer().
virtual void NewObject3DBuffer (InternalObject3DBuffer **_ppVertexAndPolygonBufferOut, unsigned int _maxNbVertex, unsigned int _maxNbTriangle, unsigned int _extraMemberFlags)=0
 Ask the Creation of a new InternalObject3DBuffer you can then fill with InternalObject3DBuffer::GetFirstVertex() , InternalObject3DBuffer::GetFirstTriangle(). Important: All the vertex members and polygon index are inited to zero when built. and InternalObject3DBuffer::SetNumberOfActiveTriangle() . Then the object can be positionned with the matrix methods in VirtualMachine::InternalViewPort, and drawn with VirtualMachine::InternalViewPort::RenderMesh(). The object shape can be dynamic and rebuilt, until a call to VirtualMachine::InternalObject3DBuffer::CompileAsStatic(). In edition compilation mode, objects had to be destroyed with VirtualMachine::DeleteObject3DBuffer().
virtual void DeleteObject3DBuffer (InternalObject3DBuffer **_ppBufferToDestroy)=0
 Destroy objects previously created with NewObject3DBuffer().
virtual void NewTexture (InternalTexture **_ppTextureOut)
 Ask the Creation of a new InternalTexture, then used to render 3D objects with RenderMesh(). In edition mode, InternalTexture has to be destroyed with DeleteTexture().
virtual void NewTexture (InternalTexture **_ppTextureOut)=0
 Ask the Creation of a new InternalTexture, then used to render 3D objects with RenderMesh(). In edition mode, InternalTexture has to be destroyed with DeleteTexture().
virtual void DeleteTexture (InternalTexture **_ppTextureToDestroy)
 Destroy objects previously created with NewTexture().
virtual void DeleteTexture (InternalTexture **_ppTextureToDestroy)=0
 Destroy objects previously created with NewTexture().
virtual void NewViewPortChild (InternalViewPort **_ppViewPortOut, InternalViewPort *_pFatherViewPort=0L)
 Ask the Creation of a new InternalViewPort, that must be the child of another ViewPort, specified by _pFatherViewPort.if no father is specified, the new ViewPort will be the child of the default root ViewPort. To create another Root ViewPort, create a texture and use VirtualMedia::NewViewPortOnTexture(). In edition mode, each InternalViewPort has to be destroyed with DeleteViewPort().
virtual void NewViewPortChild (InternalViewPort **_ppViewPortOut, InternalViewPort *_pFatherViewPort=0L)=0
 Ask the Creation of a new InternalViewPort, that must be the child of another ViewPort, specified by _pFatherViewPort.if no father is specified, the new ViewPort will be the child of the default root ViewPort. To create another Root ViewPort, create a texture and use VirtualMedia::NewViewPortOnTexture(). In edition mode, each InternalViewPort has to be destroyed with DeleteViewPort().
virtual void NewViewPortOnTexture (InternalViewPort **_ppViewPortOut, InternalTexture *_pRootTexture, unsigned int _np2PixelWidth, unsigned int _np2PixelHeight, InternalTexture::TextureImageLayerEnum _layerToAffect)
 Ask the Creation of a new Root InternalViewPort, that will render on a texture image. specified by _pRootTexture. You got to create a texture first for parameter _pRootTexture. In edition mode, each InternalViewPort has to be destroyed with DeleteViewPort().
virtual void NewViewPortOnTexture (InternalViewPort **_ppViewPortOut, InternalTexture *_pRootTexture, unsigned int _np2PixelWidth, unsigned int _np2PixelHeight, InternalTexture::TextureImageLayerEnum _layerToAffect)=0
 Ask the Creation of a new Root InternalViewPort, that will render on a texture image. specified by _pRootTexture. You got to create a texture first for parameter _pRootTexture. In edition mode, each InternalViewPort has to be destroyed with DeleteViewPort().
virtual void DeleteViewPort (InternalViewPort **_ppViewPortToDestroy)
 Destroy any objects previously created with NewViewPortChild() or NewViewPortOnTexture().
virtual void DeleteViewPort (InternalViewPort **_ppViewPortToDestroy)=0
 Destroy any objects previously created with NewViewPortChild() or NewViewPortOnTexture(). If it has children, children are detached , not destoyed, but are invalid.
InternalViewPortGetDefaultViewPort ()
 Access to the default screen object created with InitMachine().
virtual void EnableMediaSound (SoundInterface *_pNoisyObject, bool _enable=true)
 Register a SoundInterface object that will then generate a mixed sound through SoundInterface::ProcessSoundInterupt(). The sound will start instantly. if false, Unregister a media object previously registered with EnableMediaSound(,true). The sound stops instantly. Note, that if you choose to use the BaseObject implementation, class VirtualMedia will manage the sound in its own way, and you will not need to use this method.
virtual void ShutTheFuckUp ()
 Now, AzurVeda virtual machine implements a very efficient BASS technology known as "ShutTheFuckUp" ! Yes, it will unregister all sound objects to silent the machine.
bool GetQuitMessage ()
 If true, means that the user want to quit:.

Static Public Member Functions

static void UpdateCircularSoundBuffer ()
 Method that update the cicular buffer. It is to be thrown by the main task message handling, for event GetSoundBufferEventHandle().

Static Public Attributes

static PFNGLACTIVETEXTUREARBPROC glActiveTextureARB
static PFNGLCLIENTACTIVETEXTUREARBPROC glClientActiveTextureARB
static bool m_RenderObjectExtension
static PFNGLGENRENDERBUFFERSEXTPROC glGenRenderbuffersEXT
static PFNGLGENFRAMEBUFFERSEXTPROC glGenFramebuffersEXT
static PFNGLBINDRENDERBUFFEREXTPROC glBindRenderbufferEXT
static PFNGLRENDERBUFFERSTORAGEEXTPROC glRenderbufferStorageEXT
static PFNGLDELETEFRAMEBUFFERSEXTPROC glDeleteFramebuffersEXT
static PFNGLDELETERENDERBUFFERSEXTPROC glDeleteRenderbuffersEXT
static PFNGLBINDFRAMEBUFFEREXTPROC glBindFramebufferEXT
static PFNGLFRAMEBUFFERTEXTURE2DEXTPROC glFramebufferTexture2DEXT
static PFNGLFRAMEBUFFERRENDERBUFFEREXTPROC glFramebufferRenderbufferEXT

Protected Member Functions

bool SoundInit ()
 protected sound init
void SoundExit ()
 protected sound exit

Protected Attributes

bool m_fullscreen
 true if fullscreen.
bool m_active
 true when windows or screen is shown, so we got to draw:
volatile unsigned int m_Width
 screen dimension: can change when resizing:
volatile unsigned int m_Height
 screen dimension: can change when resizing:
GLWindow m_GLWin
 GLWin object.
float m_SoundVolume
 the current main sound volume of the machine.[0,1]
unsigned int m_TotalPlaySize
 the total of amount played by a machine.
int m_LastStartPlayTime_SecondUnit
unsigned int m_LastStartPlayTime_SecondFrac
OGLMachineLinuxm_pNextMachine
InternalViewPortm_pDefaultViewPort
 this is the default viewport, it stands the whole screen by default. Used by GetDefaultViewPort().
bool m_QuitMessage
 If true, means that the user want to quit. Updated by ProcessInterface().
SoundUpdateListCell * m_pFirstSoundObject
 start of the chained list of the sound object update method:

Static Protected Attributes

static OGLMachineLinuxm_LastInstance
 to be reached from process functions
static OGLMachineLinuxm_pFirstMachine
 link the machine to a static machine list
static volatile bool m_MachineIsLockedForSoundManagement
 true if MachineIsLockedForSoundManagement. so that we don't use a list that is worked on.
static volatile bool m_MachineIsLockedForSoundUpdate

Classes

struct  GLWindow


Constructor & Destructor Documentation

OGLMachineLinux void   ) 
 

Constructor.

virtual ~OGLMachineLinux void   )  [virtual]
 

Destructor.


Member Function Documentation

virtual void DeleteTexture InternalTexture **  _ppTextureToDestroy  )  [virtual, inherited]
 

Destroy objects previously created with NewTexture().

Parameters:
_ppTextureToDestroy object to destroy, and set to 0L.

virtual void DeleteViewPort InternalViewPort **  _ppViewPortToDestroy  )  [virtual, inherited]
 

Destroy any objects previously created with NewViewPortChild() or NewViewPortOnTexture().

Parameters:
_ppViewPortToDestroy pointer to object to destroy, and set to 0L.

virtual bool FileRequester const char *  _pDisplayString,
char *  _pResultFileName,
unsigned int  _nameMaxLength
[virtual]
 

In edition mode, ask a file path to a file requester. the string format should vary, but will be compatible with LoadFile() and SaveFile().

Parameters:
_pDisplayString a string to inform to what's the file for.
_pResultFileName the file path , returned.
_nameMaxLength the maximum buffer size to write.
Returns:
true if _pDisplayString valid.

Implements VirtualMachine.

virtual void GetCurrentSoundBufferImage float **const   _ppSoundBuffer,
unsigned int *  _pLength
const [virtual]
 

For Information, an image of the current sound buffer. This is always a 2 float(left,right) table: The buffer size may vary. It can be used by preview methods or live effects.

Parameters:
_ppSoundBuffer pointer on pointer on the buffer to return.
_pLength pointer on a unsigned int that return the length.

Implements VirtualMachine.

virtual eMachineLocalization GetCurrentWorldLocalizationEnum  )  [inline, virtual]
 

Return the language of the machine, as a simple enum. It can be used by exemple.

Returns:
an enum integer.

Implements VirtualMachine.

Definition at line 100 of file OGLMachineLinux.h.

References VirtualMachine::eMachineLocalization_LocalisationNotImplemented.

virtual float GetPlayFrequency  )  [virtual]
 

Return the machine main play frequency, in herz, (tick per sec).

Returns:
freq (44100.0,22050.0,...)

Implements VirtualMachine.

virtual float GetSoundVolume  )  [virtual]
 

tool: get main volume value [0,1].

Returns:
VolumeValue [0,1]

Implements VirtualMachine.

virtual eVMResult InitMachine  )  [virtual]
 

Init.

Reimplemented from OGLMachine.

virtual const char* LoadFile const char *  _pFilePath,
unsigned int  _pFileStart,
unsigned int &  _LoadByteLength,
unsigned int  _maximumSizeLoad = 0xffffffff
[virtual]
 

load a file into a memory chunk. You can load all in one row, or stream. memory is to be deleted by the CALLER with operator: "delete [] pointer", for each succesfull call. return 0L if failed.

Parameters:
_pFilePath the path of the file to load
_pFileStart an offset of where to start reading the file. 0 if all file.
_LoadByteLength return the exact real length of what was read and returned, if OK.
_maximumSizeLoad the maximum length to read
Returns:
the memory chunk, or 0L if failed.

virtual void NewObject3DBuffer InternalObject3DBuffer **  _ppVertexAndPolygonBufferOut,
unsigned int  _maxNbVertex,
unsigned int  _maxNbTriangle,
unsigned int  _extraMemberFlags
[virtual, inherited]
 

Ask the Creation of a new InternalObject3DBuffer you can then fill with InternalObject3DBuffer::GetFirstVertex() , InternalObject3DBuffer::GetFirstTriangle() and InternalObject3DBuffer::SetNumberOfActiveTriangle() . Then the object can be positionned with the matrix methods, and drawn with RenderMesh() The object shape can be dynamic and rebuilt, until a call to CompileAsStatic(). In edition mode, object has to be destroyed with DeleteObject3DBuffer().

Parameters:
_ppVertexAndPolygonBufferOut the object returned, or 0L if failed.(no mem ?)
_maxNbVertex maximum number of vertex to fill.
_maxNbTriangle maximum number of Triangle to fill.
_extraMemberFlags or'ed bits (bOb3D_...) to activate extra vertex members.

virtual void NewTexture InternalTexture **  _ppTextureOut  )  [pure virtual, inherited]
 

Ask the Creation of a new InternalTexture, then used to render 3D objects with RenderMesh(). In edition mode, InternalTexture has to be destroyed with DeleteTexture().

Parameters:
_ppTextureOut the object returned, or 0L if failed.(no mem ?)

virtual void NewTexture InternalTexture **  _ppTextureOut  )  [virtual, inherited]
 

Ask the Creation of a new InternalTexture, then used to render 3D objects with RenderMesh(). In edition mode, InternalTexture has to be destroyed with DeleteTexture().

Parameters:
_ppTextureOut the object returned, or 0L if failed.(no mem ?)

virtual void NewViewPortChild InternalViewPort **  _ppViewPortOut,
InternalViewPort _pFatherViewPort = 0L
[virtual, inherited]
 

Ask the Creation of a new InternalViewPort, that must be the child of another ViewPort, specified by _pFatherViewPort.if no father is specified, the new ViewPort will be the child of the default root ViewPort. To create another Root ViewPort, create a texture and use VirtualMedia::NewViewPortOnTexture(). In edition mode, each InternalViewPort has to be destroyed with DeleteViewPort().

Parameters:
_ppViewPortOut the object returned, or 0L if failed.(no mem ?)
_pFatherViewPort the father viewport. If 0L, it uses the default root.

virtual void NewViewPortOnTexture InternalViewPort **  _ppViewPortOut,
InternalTexture *  _pRootTexture,
unsigned int  _np2PixelWidth,
unsigned int  _np2PixelHeight,
InternalTexture::TextureImageLayerEnum  _layerToAffect
[virtual, inherited]
 

Ask the Creation of a new Root InternalViewPort, that will render on a texture image. specified by _pRootTexture. You got to create a texture first for parameter _pRootTexture. In edition mode, each InternalViewPort has to be destroyed with DeleteViewPort().

Parameters:
_ppViewPortOut the object returned, or 0L if failed.(no mem ?)
_pRootTexture an InternalTexture. Can't be null.
_np2PixelWidth integer which can be 1,2,4,8,16,32,64,128,256,512 that stand for the square of the pixel width.
_np2PixelHeight integer which can be 1,2,4,8,16,32,64,128,256,512 that stand for the square of the pixel height.
_layerToAffect the texture layer (simple mapping, environment) where to render.

virtual void ProcessInterface  )  [virtual]
 

Check the Process the message of the interface, in the real time:.

Implements VirtualMachine.

virtual bool SaveFile const char *  _pFilePath,
const char *  _chunkToWrite,
unsigned int  _ChunkLength,
bool  _append = false
[virtual]
 

write a file from a memory chunk. You can save all in one row, or stream.

Parameters:
_pFilePath the path of the file to write
_chunkToWrite your memory chunk to save, as char *.
_ChunkLength the length of _chunkToWrite
_append if true, file is continued. if false, file is rewritten. default to false.
Returns:
true if OK, false if not.

Implements VirtualMachine.

virtual void SetSoundCurrentTime int  _seconds,
unsigned int  _fraction
[virtual]
 

force a date to the clock passed to the sound objects.

Parameters:
_seconds in second units.
_fraction the following after-the-point-units of _seconds, like if the whole were a 64 bits integer.

Implements VirtualMachine.

virtual void SetSoundVolume float  _newVolumeValue  )  [virtual]
 

tool: change main volume [0,1]. Yes, you can saturate when >1.

Parameters:
_newVolumeValue [0,1]

Implements VirtualMachine.

virtual void Sleep unsigned int  _milliseconds  )  [virtual]
 

in edition mode, redirection of machine task wait.

Parameters:
_milliseconds time to wait.

Implements VirtualMachine.

void SoundExit  )  [protected]
 

protected sound exit

bool SoundInit  )  [protected]
 

protected sound init

Parameters:
_window 

virtual void SwapMainScreenBuffer  )  [virtual]
 

Swap buffer so that what was drawn is shown.

Implements OGLMachine.

static void UpdateCircularSoundBuffer  )  [static]
 

Method that update the cicular buffer. It is to be thrown by the main task message handling, for event GetSoundBufferEventHandle().


Member Data Documentation

bool m_active [protected]
 

true when windows or screen is shown, so we got to draw:

Definition at line 157 of file OGLMachineLinux.h.

bool m_fullscreen [protected]
 

true if fullscreen.

Definition at line 155 of file OGLMachineLinux.h.

GLWindow m_GLWin [protected]
 

GLWin object.

Definition at line 196 of file OGLMachineLinux.h.

volatile unsigned int m_Height [protected]
 

screen dimension: can change when resizing:

Definition at line 161 of file OGLMachineLinux.h.

OGLMachineLinux* m_LastInstance [static, protected]
 

to be reached from process functions

Definition at line 153 of file OGLMachineLinux.h.

volatile bool m_MachineIsLockedForSoundManagement [static, protected]
 

true if MachineIsLockedForSoundManagement. so that we don't use a list that is worked on.

Definition at line 254 of file OGLMachineLinux.h.

InternalViewPort* m_pDefaultViewPort [protected, inherited]
 

this is the default viewport, it stands the whole screen by default. Used by GetDefaultViewPort().

Definition at line 840 of file VirtualMachine.h.

Referenced by VirtualMachine::GetDefaultViewPort().

OGLMachineLinux* m_pFirstMachine [static, protected]
 

link the machine to a static machine list

Definition at line 245 of file OGLMachineLinux.h.

SoundUpdateListCell* m_pFirstSoundObject [protected, inherited]
 

start of the chained list of the sound object update method:

Definition at line 852 of file VirtualMachine.h.

bool m_QuitMessage [protected, inherited]
 

If true, means that the user want to quit. Updated by ProcessInterface().

Definition at line 843 of file VirtualMachine.h.

Referenced by VirtualMachine::GetQuitMessage().

float m_SoundVolume [protected]
 

the current main sound volume of the machine.[0,1]

Definition at line 221 of file OGLMachineLinux.h.

unsigned int m_TotalPlaySize [protected]
 

the total of amount played by a machine.

Definition at line 238 of file OGLMachineLinux.h.

volatile unsigned int m_Width [protected]
 

screen dimension: can change when resizing:

Definition at line 159 of file OGLMachineLinux.h.


The documentation for this class was generated from the following file:
      /\/\        4         N         k         !         N         D
                      _______  _ __ ___  _____            ___ _ _  ____
     ___________  __//___   /________  |/    / ___________\_______/    \
    /   _   _   \/   _     /    _   /      _/_/____/    _       __     /
   /    /   /       /     /    /    \      \/     /    /    \   \     /
  \\___/___/___/    ¯    _____/_____/       ______\___/_____/\________\\
               \________/_ ___ __ l____\      /elD!  
                 http://www.m4nkind.com \____/