OMK::Inp::DistributedCameraListener Class Reference
[User inputs]

Simulated Object to control the camera. More...

#include <OMKDistributedCameraListener.h>

Inheritance diagram for OMK::Inp::DistributedCameraListener:

[legend]Collaboration diagram for OMK::Inp::DistributedCameraListener:

[legend]List of all members.

Protected Member Functions
virtual void	windowResized (Ogre::RenderWindow *rw)
virtual void	windowClosed (Ogre::RenderWindow *rw)
virtual bool	processUnbufferedKeyInput (const Ogre::FrameEvent &evt)
virtual bool	processUnbufferedMouseInput (const Ogre::FrameEvent &evt)
virtual bool	frameStarted (const Ogre::FrameEvent &evt)
virtual void	init ()
	initialise the object.
virtual void	finish ()
	finish calculation of evolution.
virtual void	compute ()
	compute evolution of this object.
void	readConfigurationParameters ()
Protected Attributes
Vis::OgreVis *	_ogreVis
Type::Transform	_transform
bool	_updateTransform
float	_translationSpeed
float	_wheelTranslationSpeed
float	_rotationSpeed
OIS::InputManager *	_inputManager
OIS::Mouse *	_mouse
OIS::Keyboard *	_keyboard
Private Member Functions
	DECLARE_OBJECT_FACTORY (DistributedCameraListener)

---

Detailed Description

Simulated Object to control the camera.

Date:

200 7-02-28

Author:

Michaël Rouillé

Module description :

Define a frame and windowEvent listener which control the camera of a VisOgre object.

Definition at line 27 of file OMKDistributedCameraListener.h.

---

Member Function Documentation

OMK::Inp::DistributedCameraListener::DECLARE_OBJECT_FACTORY

(

DistributedCameraListener

)

[private]

virtual void OMK::Inp::DistributedCameraListener::windowResized

(

Ogre::RenderWindow *

rw

)

[protected, virtual]

Referenced by init().

virtual void OMK::Inp::DistributedCameraListener::windowClosed

(

Ogre::RenderWindow *

rw

)

[protected, virtual]

Referenced by finish().

virtual bool OMK::Inp::DistributedCameraListener::processUnbufferedKeyInput

(

const Ogre::FrameEvent &

evt

)

[protected, virtual]

virtual bool OMK::Inp::DistributedCameraListener::processUnbufferedMouseInput

(

const Ogre::FrameEvent &

evt

)

[protected, virtual]

virtual bool OMK::Inp::DistributedCameraListener::frameStarted

(

const Ogre::FrameEvent &

evt

)

[protected, virtual]

void DistributedCameraListener::init

(

)

[protected, virtual]

initialise the object.

Use this member function for any initilisation than can only be done when all the simulated objects have been created. In particular, plugging the input of the objects should be done here. By default, this member function calls the initialisation of the associated computational object.

Reimplemented from OMK::SimulatedObject.

Definition at line 45 of file OMKDistributedCameraListener.cpp.

References _inputManager, _keyboard, _mouse, _ogreVis, readConfigurationParameters(), OMK::Vis::OgreVis::touchRoot(), and windowResized().

{
  readConfigurationParameters() ;

  ParamList pl ;
  size_t windowHnd( 0 ) ;
  std::ostringstream windowHndStr ;

#if defined WIN32
  // Uncomment these two lines to allow users to switch keyboards via the language bar
  pl.insert(std::make_pair( std::string( "w32_keyboard" ), std::string( "DISCL_FOREGROUND" ) ) );
  pl.insert(std::make_pair( std::string( "w32_keyboard" ), std::string( "DISCL_NONEXCLUSIVE" ) ) );

#elif defined OIS_LINUX_PLATFORM
  pl.insert( std::make_pair( std::string( "XAutoRepeatOn" ), std::string( "true") ) );    
  pl.insert( std::make_pair( std::string( "x11_mouse_hide" ), std::string( "false" ) ) );    
  pl.insert( std::make_pair( std::string( "x11_mouse_grab" ), std::string( "false" ) ) );    
  pl.insert( std::make_pair( std::string( "x11_keyboard_grab" ), std::string( "false" ) ) );    
#endif

  _ogreVis->touchRoot().getAutoCreatedWindow()->getCustomAttribute( "WINDOW", &windowHnd ) ;
  windowHndStr << windowHnd ;
  pl.insert( std::make_pair( std::string( "WINDOW" ), windowHndStr.str() ) ) ;

  _inputManager = InputManager::createInputSystem( pl ) ;

  //create devices
  _keyboard = static_cast<Keyboard*>( _inputManager->createInputObject( OISKeyboard, false ) ) ;
  _mouse = static_cast<Mouse*>( _inputManager->createInputObject( OISMouse, false ) ) ;

  //Set initial mouse clipping size
  windowResized( _ogreVis->touchRoot().getAutoCreatedWindow() );

  //Register as a Window listener
  WindowEventUtilities::addWindowEventListener( _ogreVis->touchRoot().getAutoCreatedWindow(), this ) ;

  //register as a frame listener
  _ogreVis->touchRoot().addFrameListener( this ) ;
}

void DistributedCameraListener::finish

(

)

[protected, virtual]

finish calculation of evolution.

by default, this member function does nothing. Finish is usefull in the event of having the simulation restarted whitout complete destruction of the objects

Reimplemented from OMK::SimulatedObject.

Definition at line 89 of file OMKDistributedCameraListener.cpp.

References _ogreVis, OMK::Vis::OgreVis::touchRoot(), and windowClosed().

{
  //Remove ourself as a Window listener
  WindowEventUtilities::removeWindowEventListener( _ogreVis->touchRoot().getAutoCreatedWindow(), this ) ;
  windowClosed( _ogreVis->touchRoot().getAutoCreatedWindow() ) ;
}

void DistributedCameraListener::compute

(

)

[protected, virtual]

compute evolution of this object.

Reimplemented from OMK::SimulatedObject.

Definition at line 100 of file OMKDistributedCameraListener.cpp.

References _transform, and _updateTransform.

{
  if ( _updateTransform == true )
  {
   // std::cerr << "DistributedCameraListener::compute() Signal" << std::endl ;
    fireValuedSignal< TransformType >( "moveCamera", _transform ) ;
    _updateTransform = false ;
  }
}

void DistributedCameraListener::readConfigurationParameters

(

)

[protected]

Definition at line 114 of file OMKDistributedCameraListener.cpp.

References _ogreVis, OMK::ParametersAccessor::get(), OMK::SimulatedObject::getConfigurationParameters(), OMK::SimulatedObject::getController(), OMK::Vis::OgreVis::getRoot(), and OMASSERT.

Referenced by init().

{
  const ConfigurationParameterDescriptor* node( getConfigurationParameters() ) ;

  // Retrieve the VisuName parameter
  std::string visuName ;
  ParametersAccessor::get( node, "VisuName", visuName ) ;
  OMASSERT( ( visuName.empty() == false ) && "The VisuName configuration parameter must be declared" ) ;
  SimulatedObject* vis( getController().getPointerToSimulatedObjectNamed( visuName ) ) ;
  OMASSERT( ( vis != NULL ) && "The VisuName configuration parameter is not a SimulatedObject" ) ;
  _ogreVis = dynamic_cast<OgreVis*>( vis ) ;
  OMASSERT( ( _ogreVis != NULL ) && "The VisuName configuration parameter is not an OgreVis" ) ;
  OMASSERT( ( _ogreVis->getRoot().isInitialised() == true ) && "The OgreVis 'VisuName' is incorrectly initialised" ) ;
}

---

Member Data Documentation

Vis::OgreVis* OMK::Inp::DistributedCameraListener::_ogreVis [protected]

Definition at line 57 of file OMKDistributedCameraListener.h.

Referenced by finish(), init(), and readConfigurationParameters().

Type::Transform OMK::Inp::DistributedCameraListener::_transform [protected]

Definition at line 58 of file OMKDistributedCameraListener.h.

Referenced by compute().

bool OMK::Inp::DistributedCameraListener::_updateTransform [protected]

Definition at line 59 of file OMKDistributedCameraListener.h.

Referenced by compute().

float OMK::Inp::DistributedCameraListener::_translationSpeed [protected]

Definition at line 60 of file OMKDistributedCameraListener.h.

float OMK::Inp::DistributedCameraListener::_wheelTranslationSpeed [protected]

Definition at line 61 of file OMKDistributedCameraListener.h.

float OMK::Inp::DistributedCameraListener::_rotationSpeed [protected]

Definition at line 62 of file OMKDistributedCameraListener.h.

OIS::InputManager* OMK::Inp::DistributedCameraListener::_inputManager [protected]

Definition at line 65 of file OMKDistributedCameraListener.h.

Referenced by init().

OIS::Mouse* OMK::Inp::DistributedCameraListener::_mouse [protected]

Definition at line 66 of file OMKDistributedCameraListener.h.

Referenced by init().

OIS::Keyboard* OMK::Inp::DistributedCameraListener::_keyboard [protected]

Definition at line 67 of file OMKDistributedCameraListener.h.

Referenced by init().

---