OMK::Inp::GenericKeyExtension< OwnerClass > Class Template Reference
[User inputs]

Generic extension to handle a key. More...

#include <OMKGenericKeyExtension.h>

Inheritance diagram for OMK::Inp::GenericKeyExtension< OwnerClass >:

[legend]Collaboration diagram for OMK::Inp::GenericKeyExtension< OwnerClass >:

[legend]List of all members.

Protected Member Functions
bool	pressFct (Event *event)
	The call back method associated with the event listener for press.
bool	releaseFct (Event *event)
	The call back method associated with the event listener for release.
virtual void	action ()
	The method to overwrite for press action.
virtual void	actionRelease ()
	The method to overwrite for release action.
Configuration loaders
virtual bool	loadExtensionParameters (const ConfigurationParameterDescriptor *node)
	Configuration parameters loader of Extension.
Protected Attributes
EventListener *	_eventListenerPress
	The event listener which receives the key press event.
EventListener *	_eventListenerRelease
	The event listener which receives the key release event.
const std::string	_defaultKey
	The default key.

---

Detailed Description

template<class OwnerClass>
class OMK::Inp::GenericKeyExtension< OwnerClass >

Generic extension to handle a key.

Date:

2007-03-14

Author:

Benoît Chanclou

Defines a generic extension which handles a key. This is a template class, the parameters are:

• OwnerClass, it is the class of the owner, a extensible simulated object. The creation is done dynamically through the following configuration:

  myObject
  {
    Class MyObject
    ...
    Extensions
    {
      boundingBox
      {
        Class BoundingBox
        Key f3 // the default is given in the constructor
        VisuName visualisation // the default is "visualisation" needed to create the key listener
        ActionOn Press // or Release or Both, by default it is Press
      }
      ...
    }
  }
   *
  

  The code for the key could found in the InputExtension class.

There is two ways to use those extnsion.

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

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

Definition at line 61 of file OMKGenericKeyExtension.h.

---

Constructor & Destructor Documentation

template<class OwnerClass>

OMK::Inp::GenericKeyExtension< OwnerClass >::GenericKeyExtension	(	ExtensibleSimulatedObject *	owner,
		const Name &	id,
		bool	registerExtension,
		const std::string &	defaultKey
	)			[inline, protected]

Constructor.

It is protected, because it is only called by the friend creator.

Definition at line 69 of file OMKGenericKeyExtension.h.

  : ExtensionT< OwnerClass >( owner, id ),
    _eventListenerPress( 0 ),
    _eventListenerRelease( 0 ),
    _defaultKey( defaultKey )
  {
  }

template<class OwnerClass>

virtual OMK::Inp::GenericKeyExtension< OwnerClass >::~GenericKeyExtension

(

)

[inline, virtual]

Definition at line 77 of file OMKGenericKeyExtension.h.

  {
    delete _eventListenerPress ;
    delete _eventListenerRelease ;
  }

template<class OwnerClass>

OMK::Inp::GenericKeyExtension< OwnerClass >::GenericKeyExtension	(	ExtensibleSimulatedObject *	owner,
		const Name &	id,
		bool	registerExtension,
		const std::string &	defaultKey
	)			[inline, protected]

Constructor.

It is protected, because it is only called by the friend creator.

Definition at line 69 of file OMKGenericKeyExtension.h.

  : ExtensionT< OwnerClass >( owner, id ),
    _eventListenerPress( 0 ),
    _eventListenerRelease( 0 ),
    _defaultKey( defaultKey )
  {
  }

template<class OwnerClass>

virtual OMK::Inp::GenericKeyExtension< OwnerClass >::~GenericKeyExtension

(

)

[inline, virtual]

Definition at line 77 of file OMKGenericKeyExtension.h.

  {
    delete _eventListenerPress ;
    delete _eventListenerRelease ;
  }

---

Member Function Documentation

template<class OwnerClass>

virtual bool OMK::Inp::GenericKeyExtension< OwnerClass >::loadExtensionParameters

(

const ConfigurationParameterDescriptor *

node

)

[inline, protected, virtual]

Configuration parameters loader of Extension.

Retrieves the key (by default it is B), then creates the event listener and the key listener for the defined key.

Reimplemented from OMK::Extension.

Reimplemented in OMK::Inp::DebugOverlayExtension, OMK::Inp::KeyEmitterExtension, OMK::Inp::KeyEmitterExtensionT< T, ModelType >, OMK::Inp::OverlayExtension, and OMK::Inp::PlusMinusExtension< T >.

Definition at line 96 of file OMKGenericKeyExtension.h.

Referenced by OMK::Inp::PlusMinusExtension< T >::loadExtensionParameters().

  {
    bool ok = true ;
    std::string key( _defaultKey ) ;
    ParametersAccessor::get( node, "Key", key ) ;
    std::string visuName( "visualisation" ) ;
    ok = ok && ParametersAccessor::get( node, "VisuName", visuName, _owner ) ;
    // What kind of action
    bool press = true ;
    bool release = false ;
    std::string actionOn ;
    if( ParametersAccessor::get( node, "ActionOn", actionOn ) )
    {
      std::transform( actionOn.begin(), actionOn.end(), actionOn.begin(), toupper ) ;
      press = ( actionOn == "PRESS" ) || ( actionOn == "BOTH" ) ;
      release = ( actionOn == "RELEASE" ) || ( actionOn == "BOTH" ) ;
    }
    // initialisation of the listeners
    if( ok && press )
    {
      _eventListenerPress = new EventListenerCallBack< GenericKeyExtension< OwnerClass > >
          ( *_owner, this, 
            (typename EventListenerCallBack< GenericKeyExtension< OwnerClass > >::CallBackFct)&GenericKeyExtension< OwnerClass >::pressFct, 
            OMK::Inp::KeyListener::getKeyPressCode( key ) ) ;
      _owner->sendValuedEvent( visuName, OMK::Inp::InputExtension::ADD_KEY, OMK::Inp::AddInputKeyPrm( key, _owner->getName() ) ) ;
    }
    if( ok && release )
    {
      _eventListenerRelease = new EventListenerCallBack< GenericKeyExtension< OwnerClass > >
          ( *_owner, this, 
            (typename EventListenerCallBack< GenericKeyExtension< OwnerClass > >::CallBackFct)&GenericKeyExtension< OwnerClass >::releaseFct, 
            OMK::Inp::KeyListener::getKeyReleaseCode( key ) ) ;
      _owner->sendValuedEvent( visuName, OMK::Inp::InputExtension::ADD_KEY, OMK::Inp::AddInputKeyPrm( key, _owner->getName() ) ) ;
    }
    return ok ;
  }

template<class OwnerClass>

bool OMK::Inp::GenericKeyExtension< OwnerClass >::pressFct

(

Event *

event

)

[inline, protected]

The call back method associated with the event listener for press.

Definition at line 151 of file OMKGenericKeyExtension.h.

  {
    action() ;
    // Returns false because may be another key listener wants to see the event
    return false ;
  }

template<class OwnerClass>

bool OMK::Inp::GenericKeyExtension< OwnerClass >::releaseFct

(

Event *

event

)

[inline, protected]

The call back method associated with the event listener for release.

Definition at line 158 of file OMKGenericKeyExtension.h.

  {
    actionRelease() ;
    // Returns false because may be another key listener wants to see the event
    return false ;
  }

template<class OwnerClass>

virtual void OMK::Inp::GenericKeyExtension< OwnerClass >::action

(

)

[inline, protected, virtual]

The method to overwrite for press action.

Reimplemented in OMK::Inp::BoundingBoxExtension, OMK::Inp::DebugOverlayExtension, OMK::Inp::KeyEmitterExtension, OMK::Inp::KeyEmitterExtensionT< T, ModelType >, OMK::Inp::OverlayExtension, OMK::Inp::PlusMinusExtension< T >, and OMK::Inp::SceneDetailsExtension.

Definition at line 165 of file OMKGenericKeyExtension.h.

Referenced by OMK::Inp::GenericKeyExtension< OMK::ExtensibleSimulatedObject >::pressFct().

{}

template<class OwnerClass>

virtual void OMK::Inp::GenericKeyExtension< OwnerClass >::actionRelease

(

)

[inline, protected, virtual]

The method to overwrite for release action.

Reimplemented in OMK::Inp::PlusMinusExtension< T >.

Definition at line 167 of file OMKGenericKeyExtension.h.

Referenced by OMK::Inp::GenericKeyExtension< OMK::ExtensibleSimulatedObject >::releaseFct().

{}

---

Member Data Documentation

template<class OwnerClass>

EventListener* OMK::Inp::GenericKeyExtension< OwnerClass >::_eventListenerPress [protected]

The event listener which receives the key press event.

It is created in the loadExtensionParameters method, it is a EventListenerCallBack which is associated with the callBackFct method.

Definition at line 142 of file OMKGenericKeyExtension.h.

Referenced by OMK::Inp::PlusMinusExtension< T >::actionRelease(), OMK::Inp::GenericKeyExtension< OMK::ExtensibleSimulatedObject >::loadExtensionParameters(), and OMK::Inp::GenericKeyExtension< OMK::ExtensibleSimulatedObject >::~GenericKeyExtension().

template<class OwnerClass>

EventListener* OMK::Inp::GenericKeyExtension< OwnerClass >::_eventListenerRelease [protected]

The event listener which receives the key release event.

It is created in the loadExtensionParameters method, it is a EventListenerCallBack which is associated with the callBackFct method.

Definition at line 147 of file OMKGenericKeyExtension.h.

Referenced by OMK::Inp::PlusMinusExtension< T >::action(), OMK::Inp::GenericKeyExtension< OMK::ExtensibleSimulatedObject >::loadExtensionParameters(), and OMK::Inp::GenericKeyExtension< OMK::ExtensibleSimulatedObject >::~GenericKeyExtension().

template<class OwnerClass>

const std::string OMK::Inp::GenericKeyExtension< OwnerClass >::_defaultKey [protected]

The default key.

Definition at line 149 of file OMKGenericKeyExtension.h.

Referenced by OMK::Inp::GenericKeyExtension< OMK::ExtensibleSimulatedObject >::loadExtensionParameters().

---