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

Input listener to control the detail level of the objects in the scene. More...

#include <OMKSceneDetailsExtension.h>

Inheritance diagram for OMK::Inp::SceneDetailsExtension:

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

[legend]List of all members.

Protected Member Functions
virtual void	action ()
	The overwritten method.
Protected Attributes
Ogre::Camera *	_camera
	The camera to update.
int	_sceneDetailIndex
	The level of details.
Private Member Functions
	DECLARE_EXTENSION_FACTORY (SceneDetailsExtension)
	Factory and constructor/destructor.

---

Detailed Description

Input listener to control the detail level of the objects in the scene.

Date:

2007-03-14

Author:

Benoît Chanclou

Defines a extension which switches between display modes of a visualisation object. The level of details are:

• normal
• wireframe
• points

This extension must be used as an extension of the OgreVis object. The creation is done dynamically through the following configuration:

visualisation
{
  Class OgreVis
  ...
  Extensions
  {
    sceneDetails
    {
      Class SceneDetails
      Key f3 // the default is "B"
      VisuName visualisation // the default is "visualisation" needed to create the key listener
    }
    ...
  }
}
 *

There is two ways to change the display of the details.

• Let the input extension does the job when the user presses the defined key.
• Send to the visualisation object the same event than when the key is pressed. With the previous configuration the event will be:

  the_sender_object->sendEvent( "visualisation", OMK::Inp::KeyListener::getKeyPressCode( "f3" ) ) ;
  

Definition at line 56 of file OMKSceneDetailsExtension.h.

---

Member Function Documentation

OMK::Inp::SceneDetailsExtension::DECLARE_EXTENSION_FACTORY

(

SceneDetailsExtension

)

[private]

Factory and constructor/destructor.

See Extension feature

void OMK::Inp::SceneDetailsExtension::action

(

)

[protected, virtual]

The overwritten method.

Switches the details level.

Reimplemented from OMK::Inp::GenericKeyExtension< OMK::Vis::OgreVis >.

Definition at line 27 of file OMKSceneDetailsExtension.cpp.

References _camera, OMK::ExtensionT< OMK::Vis::OgreVis >::_owner, _sceneDetailIndex, and OMK::Vis::OgreVis::touchRoot().

{
  static Ogre::PolygonMode mode[] = { Ogre::PM_SOLID, Ogre::PM_WIREFRAME, Ogre::PM_POINTS } ;

  _sceneDetailIndex = ( 2 == _sceneDetailIndex ) ? 0 :( _sceneDetailIndex + 1 ) ;
  
  _camera = _camera ? _camera : ( _owner 
        && _owner->touchRoot().getAutoCreatedWindow() 
        && _owner->touchRoot().getAutoCreatedWindow()->getViewport( 0 ) ? 
        _owner->touchRoot().getAutoCreatedWindow()->getViewport( 0 )->getCamera() : 0 ) ;
  if( _camera ) _camera->setPolygonMode( mode[ _sceneDetailIndex ] ) ; 
}

---

Member Data Documentation

Ogre::Camera* OMK::Inp::SceneDetailsExtension::_camera [protected]

The camera to update.

It is retrieved by dynamically casting the owner of the extension in setTheOwner method.

Definition at line 66 of file OMKSceneDetailsExtension.h.

Referenced by action().

int OMK::Inp::SceneDetailsExtension::_sceneDetailIndex [protected]

The level of details.

• 0 normal
• 1 wireframe
• 2 points

Definition at line 71 of file OMKSceneDetailsExtension.h.

Referenced by action().

---