OMKInteractorExtension.h

Go to the documentation of this file.

/************************************************************************/
/* This file is part of openMask(c) INRIA, CNRS, Universite de Rennes 1 */
/* 1993-2002, thereinafter the Software                                 */
/*                                                                      */
/* The Software has been developped within the Siames Project.          */
/* INRIA, the University of Rennes 1 and CNRS jointly hold intellectual */
/* property rights                                                      */
/*                                                                      */
/* The Software has been registered with the Agence pour la Protection  */
/* des Programmes (APP) under registration number                       */
/* IDDN.FR.001.510008.00.S.P.2001.000.41200                             */
/*                                                                      */
/* This file may be distributed under the terms of the Q Public License */
/* version 1.0 as defined by Trolltech AS of Norway and appearing in    */
/* the file LICENSE.QPL included in the packaging of this file.         */
/*                                                                      */
/* Licensees holding valid specific licenses issued by INRIA, CNRS or   */
/* Universite Rennes 1 for the software may use this file in            */
/* acordance with that specific license                                 */
/************************************************************************/
                
#if !defined OMK_III_INTERACTOREXTENSION_H
#define OMK_III_INTERACTOREXTENSION_H

#include "OMKExtension.h"
#include "OMKInteractorOutput.h"
#include "OMKInteractiveEventId.h"

namespace OMK  
{
  class ExtensibleSimulatedObject ;
  namespace Iii 
  {
class EventInteractorListener ;
class SessionPrm ;
// Predefined classes


class OMKIII_API InteractorExtension
: public ExtensionT< ExtensibleSimulatedObject >
{

public:
  virtual ~InteractorExtension() ;
protected:
  InteractorExtension( ExtensibleSimulatedObject* owner, const Name& id, bool registerExtension = true ) ;




  virtual bool loadExtensionParameters( const ConfigurationParameterDescriptor * node ) ;
  virtual void startInteractor() ;


public:
  virtual void startSessionWith( const Name& interactiveObject ) ; 
  virtual void closeSessionWith( const Name& interactiveObject ) ; 
  SessionPrm* getSessionWith( const Name& interactiveObject ) ;
  void closeAllSessions() ; 
protected:
  virtual SessionPrm* createSession( const Name& interactiveObject ) ; 
  SessionsMap _sessionsPrm ;
public:
  ExtensibleSimulatedObject* getInteractor() { return _owner ; }
  OMK::Type::AccessLevel getAccessLevel() const { return _access._level ; }
  void setAccessLevel( OMK::Type::AccessLevel level = 0 ) { _access._level = level ; }
  const OMK::Name& getGroup() const { return _access._groupName ; }
  void setGroup( const OMK::Name& name ) { _access._groupName = name ; }
  const OMK::Type::AccessGroup& getAccessGroup() const { return _access ; }
protected:
  OMK::Type::AccessGroup _access ;

protected:
  EventListener * _accessibleConnectorsListener ;
  EventListener * _currentValuesSentAndControlTakenListener ;
  EventListener * _controlReleasedListener ;
  EventListener * _controlEndedListener ;
  EventListener * _controlTakenByListener ;
  EventListener * _controlReleasedByListener ;
  EventListener * _currentValuesSentListener ;
  virtual bool processAccessibleParameters( Type::AccessibleParametersListEvent *event ) ;
  virtual bool processCurrentValuesSentAndControlTaken( Type::ControlTakenEvent *event ) ;
  virtual bool processControlReleased( Type::ControlReleasedEvent *event ) ;
  virtual bool processControlEnded( Type::ControlEndedEvent *event ) ;
  virtual bool processControlTakenBy( Type::ControlUpdatedEvent *event ) ;
  virtual bool processControlReleasedBy( Type::ControlUpdatedEvent *event ) ;
  virtual bool processCurrentValuesSent( Event* event ) ;
public:
  void addInteractorOutput( InteractorOutput* interactorOutput ) ;
protected:
  InteractorOutputsMap _interactorOutputs ;
} ;

  }// namespace Iii
}// namespace OMK

#endif // defined OMK_III_INTERACTOREXTENSION_H

---