VRS - The Virtual Rendering System

version 3.3

interactiontechnique.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2000-2008 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  is  free  software; you can redistribute it and/or  modify it
 * under the terms of the GNU Lesser General Public  License  as  published  by
 * the  Free  Software  Foundation;  either  version 2.1 of the License, or (at
 * your option) any later version. This library  is  distributed  in  the  hope
 * that  it will be useful, but  WITHOUT ANY WARRANTY; without even the implied
 * warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE.  See  the
 * GNU Lesser General Public License for more details. You should have received
 * a copy of the GNU Lesser+ General Public License along with this library; if
 * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: interactiontechnique.h 6426 2008-07-04 14:00:57Z Stefan_Maass $

#ifndef VRS_SG_INTERACTIONTECHNIQUE_H
#define VRS_SG_INTERACTIONTECHNIQUE_H

#include <vrs/sg/interactionconcept.h>
#include <vrs/sg/inputevent.h>

namespace VRS {

class ConstraintHint;
class KeyEvent;
class ButtonEvent;
class MotionEvent;
class TimeEvent;
class WheelEvent;
template<typename K, typename V> class NonPersistentDictionary;

         
class VRS_CORE_API InteractionTechnique : public SharedObj {
          
public:
    
    typedef InteractionConcept::ViewParameterSet ViewParameterSet;

    SO<ViewParameterSet> getViewParameters() const;
    
    SO<ViewParameterSet> getPreviousViewParameters() const;
    
    virtual void onTimer(SO<TimeEvent> event, double secondsSinceLastTimeEvent);
    
    SO<ConstraintHint> getConstraintHint();
    
    typedef int KeyFunctionID;
    typedef int MouseButtonFunctionID;

    void assignKey(
        KeyFunctionID id,
        unsigned int key,
        InputEvent::Modifier mustModifier = InputEvent::NoModifier,
        InputEvent::Modifier mustNotModifier = InputEvent::AllKeys);

    
    void assignMouseButton(
        MouseButtonFunctionID id,
        InputEvent::Button button,
        InputEvent::Modifier mustModifier = InputEvent::NoModifier,
        InputEvent::Modifier mustNotModifier = InputEvent::AllKeys,
                InputEvent::Change mustChange = InputEvent::NoChange,
                InputEvent::Change mustNotChange = InputEvent::DoubleClick);

    
    void disableKeyFunction(KeyFunctionID id);
    void disableMouseButtonFunction(MouseButtonFunctionID id);    

        bool getAssignedKey(
                KeyFunctionID id,
                unsigned int& key,
                InputEvent::Modifier& mustModifier, 
                InputEvent::Modifier& mustNotModifier) const;

        bool getAssignedMouseButton(
                MouseButtonFunctionID id,
                InputEvent::Button& button,
                InputEvent::Modifier& mustModifier,
                InputEvent::Modifier& mustNotModifier,
                InputEvent::Change& mustChange,
                InputEvent::Change& mustNotChange) const;


    void setWheelEnable(bool onOff);
    
    virtual void onKey(SO<KeyEvent> event, KeyFunctionID id);    
    
    virtual void onDragStart(int x, int y, SO<ButtonEvent>, MouseButtonFunctionID id);
    
    virtual void onDragMotion(
        int x, int y, 
        SO<MotionEvent>, 
        MouseButtonFunctionID id,         
        int startX, int startY);
    
    virtual void onDragEnd(
        int x, int y, 
        SO<ButtonEvent>, 
        MouseButtonFunctionID id,        
        int startX, int startY);
    
    virtual void onWheelEvent(SO<WheelEvent> we);
    
    virtual void onEvent(SO<Event> e);

    virtual void onEventPassive(SO<Event> e, bool modeActive);

    virtual void onActivation();

    virtual void onDeactivation();
    
    virtual bool checkEventRelevance(SO<Event> event) const;
    
    bool canWork() const;

        virtual bool preservingViewDirectionRequired() const;

    virtual void setEnabled(bool yesNo = true);
    virtual bool enabled() const;
    
    VRS_TYPEINFO(InteractionTechnique, SharedObj);
    VRS_SERIALIZABLE(InteractionTechnique);

protected:

    InteractionTechnique();
    
    void brake();
    
         
    void registerMouseButtonFunction(MouseButtonFunctionID id); 
    void registerKeyFunction(KeyFunctionID id);
    
    bool dragging(MouseButtonFunctionID id);
    
    bool pressed(KeyFunctionID id);
    
    SO<InteractionConcept> getParent() const;
        
private:
                   
    friend class InteractionMode;
    // The InteractionMode does only use the methods below

    void setParent(SO<InteractionConcept> parent);
    void handle(SO<Event> event);
    void activate();
    void deactivate();
    bool wakeUpAt(SO<Event> event) const; 
        // Returns true for all relevant user events. It is used by InteractionMode to choose
        // the currently active InteractionTechnique. 
    
    InteractionConcept* parent_;

    struct KeyAssignment : public SharedObj {        
        unsigned int key;
        InputEvent::Modifier mustModifier;
        InputEvent::Modifier mustNotModifier;        
        bool pressed; 
    };
    
    struct ButtonAssignment : public SharedObj {        
        InputEvent::Button button;
        InputEvent::Modifier mustModifier;
        InputEvent::Modifier mustNotModifier;
                InputEvent::Change mustChange;
                InputEvent::Change mustNotChange;
        bool pressed;
        int dragStartX;
        int dragStartY;
    };

    // find assignment and functionID for a given event
    SO<KeyAssignment> findKeyFunctionID(SO<KeyEvent> event, KeyFunctionID& id) const;    
    SO<ButtonAssignment> findMouseButtonFunctionID(SO<InputEvent> event, MouseButtonFunctionID& id) const;    

    SO<NonPersistentDictionary<KeyFunctionID, SO<KeyAssignment> > > keyAssignments_;
    SO<NonPersistentDictionary<MouseButtonFunctionID, SO<ButtonAssignment> > > buttonAssignments_;

    bool enableWheel_;
    bool m_enabled;
};

} // namespace VRS

#endif // VRS_SG_INTERACTIONTECHNIQUE_H

---

Generated on Thu May 23 06:00:19 2013 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact