COgreWindow Class Reference

An OgreWindow visualises a 3D scene This class manages a RenderWindow which contents are visualised in a single viewport. More...

Public Member Functions

 COgreWindow (const OpenViBE::Kernel::IKernelContext &rKernelContext, const Ogre::String &rName, COgreVisualisation *pOgreVis, COgreScene *pOgreScene)
 Constructor. More...
 
 ~COgreWindow ()
 Destructor.
 
const Ogre::String & getName ()
 Get window name.
 
OpenViBE::boolean createRenderWindow (const std::string &rExternalHandle, unsigned int uiWidth, unsigned int uiHeight)
 Create a RenderWindow. More...
 
void update ()
 Refresh 3D window contents.
 
Event handling
OpenViBE::boolean handleRealizeEvent ()
 
OpenViBE::boolean handleUnrealizeEvent ()
 
OpenViBE::boolean handleSizeAllocateEvent (unsigned int uiWidth, unsigned int uiHeight)
 
OpenViBE::boolean handleExposeEvent ()
 
OpenViBE::boolean handleMotionEvent (int iX, int iY)
 
OpenViBE::boolean handleButtonPressEvent (unsigned int uiButton, int iX, int iY)
 
OpenViBE::boolean handleButtonReleaseEvent (unsigned int uiButton, int iX, int iY)
 
3D API
OpenViBE::boolean setBackgroundColor (OpenViBE::float32 f32ColorRed, OpenViBE::float32 f32ColorGreen, OpenViBE::float32 f32ColorBlue)
 
OpenViBE::boolean setCameraToEncompassObjects ()
 
OpenViBE::boolean setCameraSphericalCoordinates (OpenViBE::float32 f32Theta, OpenViBE::float32 f32Phi, OpenViBE::float32 f32Radius)
 
OpenViBE::boolean getCameraSphericalCoordinates (OpenViBE::float32 &rTheta, OpenViBE::float32 &rPhi, OpenViBE::float32 &rRadius)
 

Detailed Description

An OgreWindow visualises a 3D scene This class manages a RenderWindow which contents are visualised in a single viewport.

Author
Vincent Delannoy (INRIA/IRISA)
Date
2008-06

Constructor & Destructor Documentation

COgreWindow ( const OpenViBE::Kernel::IKernelContext rKernelContext,
const Ogre::String &  rName,
COgreVisualisation pOgreVis,
COgreScene pOgreScene 
)

Constructor.

Parameters
[in]rKernelContextOpenViBE kernel context
[in]rNameWindow name
[in]pOgreVisPointer to Ogre visualisation
[in]pOgreScenePointer to the scene this window is a view of

Member Function Documentation

OpenViBE::boolean createRenderWindow ( const std::string &  rExternalHandle,
unsigned int  uiWidth,
unsigned int  uiHeight 
)

Create a RenderWindow.

Parameters
rExternalHandleExternal window handle of window in which to embed the RenderWindow
uiWidthWidth of RenderWindow to be created
uiHeightHeight of RenderWindow to be created
Returns