coInteraction.h

Go to the documentation of this file.

/* This file is part of COVISE.
 
   You can use it under the terms of the GNU Lesser General Public License
   version 2.1 or later, see lgpl-2.1.txt.
 
 * License: LGPL 2+ */
 
#ifndef CO_INTERACTION
#define CO_INTERACTION
 
#include <util/coTypes.h>
#include <string>
 
namespace vrui
{
 
class OPENVRUIEXPORT coInteraction
{
    friend class coInteractionManager;
 
public:
    enum InteractionState
    {
        Idle = 0,
        PendingActive,
        Active,
        Paused,
        RemoteActive,
        ActiveNotify,
        Stopped
    };
 
    enum InteractionPriority
    {
        Low = 0,
        Navigation,
        NavigationHigh,
        Medium,
        High,
        Menu,
        Highest
    };
 
    enum InteractionType
    {
        ButtonA = 0, // vruiButtons is a bitmask while InteractionType can only be a consecutive number of types!!  = vruiButtons::ACTION_BUTTON,
        ButtonAction = ButtonA,
        ButtonB, // = vruiButtons::DRIVE_BUTTON,
        ButtonDrive = ButtonB,
        ButtonC, // = vruiButtons::XFORM_BUTTON,
        ButtonXform = ButtonC,
        ButtonD,
        ButtonForward = ButtonD,
        ButtonE,
        ButtonBack = ButtonE,
        ButtonToggleDocuments,
        ButtonDrag,
        ButtonZoom,
        ButtonMenu,
        ButtonQuit,
        ButtonNextInter,
        ButtonPrevInter,
        ButtonNextPerson,
        ButtonPrevPerson,
        LastButton = ButtonPrevPerson,
        WheelHorizontal,
        WheelVertical,
        Wheel = WheelVertical,
        Joystick,
        AllButtons, // = vruiButtons::ALL_BUTTONS | vruiButtons::WHEEL,
        NoButton, // non-zero relative input
        NumInteractorTypes
    };
 
    enum InteractionGroup
    {
        GroupNonexclusive,
        GroupNavigation,
    };
 
    enum RunningState
    {
        StateStarted = 0,
        StateRunning,
        StateStopped,
        StateNotRunning
    };
 
    coInteraction(InteractionType type, const std::string &name, InteractionPriority priority = Medium);
    virtual ~coInteraction();
 
    InteractionState getState() const
    {
        return state;
    }
    InteractionType getType() const
    {
        return type;
    }
    InteractionPriority getPriority() const
    {
        return priority;
    }
    InteractionGroup getGroup() const
    {
        return group;
    }
    void setGroup(InteractionGroup group);
    void requestActivation();
 
    virtual void update();
    virtual void cancelInteraction();
 
    virtual void setName(const std::string &name); // set new name (and possibly load appropriate icon)
    virtual void removeIcon(); // remove the indicator for this interaction
    virtual void addIcon(); // add    the indicator for this interaction
 
    virtual bool hasPriority(); // true: if the interaction's button is clicked, it is activated
 
    // these are called by the interaction manager, don't use these as client
    virtual void cancelPendingActivation();
    virtual void doActivation();
    virtual void pause();
    virtual const std::string &getName() const
    {
        return name;
    }
    virtual void resetState();
 
    bool activate(); // only call this in update!!!!
 
    bool isRegistered()
    {
        return registered;
    }
 
    void setNotifyOnly(bool flag);
    bool isNotifyOnly()
    {
        return notifyOnly;
    }
 
    bool wasStarted() const
    {
        return (runningState == StateStarted);
    }
    bool isRunning() const
    {
        return (runningState == StateRunning);
    }
    bool wasStopped() const
    {
        return (runningState == StateStopped);
    }
    bool isIdle() const
    {
        return (runningState == StateNotRunning);
    }
    InteractionState getState();
protected:
    std::string name;
 
 
    InteractionType type;
    InteractionPriority priority;
    InteractionGroup group = GroupNonexclusive;
    RunningState runningState;
 
    bool notifyOnly;
    bool hasPriorityFlag;
    bool registered;
 
    void setState(InteractionState s);
 
    private:
        InteractionState state;
};
}
#endif