libogre/include/sirikata/ogre/input/InputEvents.hpp

Go to the documentation of this file.

/*  Sirikata libproxyobject -- Ogre Graphics Plugin
 *  InputEvents.hpp
 *
 *  Copyright (c) 2009, Daniel Reiter Horn
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of Sirikata nor the names of its contributors may
 *    be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SIRIKATA_INPUT_InputEvents_HPP__
#define SIRIKATA_INPUT_InputEvents_HPP__

#include <sirikata/ogre/input/InputDevice.hpp>

namespace Sirikata {

namespace Graphics {
class WebView;
}

namespace Input {

using Graphics::WebView;

class SIRIKATA_OGRE_EXPORT InputEvent {
    InputDeviceWPtr mDevice;

public:
    InputEvent(const InputDeviceWPtr &dev)
        : mDevice(dev)
    {
    }
    virtual ~InputEvent() {}

    InputDevicePtr getDevice() const {
        return mDevice.lock();
    }
};
typedef std::tr1::shared_ptr<InputEvent> InputEventPtr;

class SIRIKATA_OGRE_EXPORT ButtonEvent : public InputEvent {
public:
    KeyEvent mEvent; 
    KeyButton mButton; 
    Modifier mModifier; 

    virtual ~ButtonEvent(){}
    ButtonEvent(const InputDevicePtr &dev,
        KeyEvent event, unsigned int key, Modifier mod)
        : InputEvent(dev),
        mEvent(event),
        mButton(key),
        mModifier(mod)
        {
    }

    // Indicates if the button was in the depressed state.
    bool pressed() {
        return ( (mEvent == KEY_PRESSED) || (mEvent == KEY_DOWN) || (mEvent == KEY_REPEATED) );
    }
    // Indicates if the button was actively pressed, i.e. was pushed down
    // instead of just held down
    bool activelyPressed() {
        return ( (mEvent == KEY_PRESSED) || (mEvent == KEY_DOWN) );
    }
};
typedef std::tr1::shared_ptr<ButtonEvent> ButtonEventPtr;

class SIRIKATA_OGRE_EXPORT ButtonPressed :public ButtonEvent {
public:
    ButtonPressed(const InputDevicePtr &dev, unsigned int key, Modifier mod)
        : ButtonEvent(dev, KEY_PRESSED, key, mod) {
    }
    virtual ~ButtonPressed(){}
};
typedef std::tr1::shared_ptr<ButtonPressed> ButtonPressedEventPtr;

class SIRIKATA_OGRE_EXPORT ButtonRepeated :public ButtonEvent {
public:
    ButtonRepeated(const InputDevicePtr &dev, unsigned int key, Modifier mod)
        : ButtonEvent(dev, KEY_REPEATED, key, mod) {
    }
    virtual ~ButtonRepeated(){}
};
typedef std::tr1::shared_ptr<ButtonRepeated> ButtonRepeatedEventPtr;

class SIRIKATA_OGRE_EXPORT ButtonReleased :public ButtonEvent {
public:
    ButtonReleased(const InputDevicePtr &dev, unsigned int key, Modifier mod)
        : ButtonEvent(dev, KEY_RELEASED, key, mod) {
    }
    virtual ~ButtonReleased(){}
};
typedef std::tr1::shared_ptr<ButtonReleased> ButtonReleasedEventPtr;

class SIRIKATA_OGRE_EXPORT ButtonDown :public ButtonEvent {
public:
    ButtonDown(const InputDevicePtr &dev, unsigned int key, Modifier mod)
        : ButtonEvent(dev, KEY_DOWN, key, mod) {
    }
    virtual ~ButtonDown(){}
};
typedef std::tr1::shared_ptr<ButtonDown> ButtonDownEventPtr;

class SIRIKATA_OGRE_EXPORT AxisEvent: public InputEvent {
public:
    AxisIndex mAxis;
    AxisValue mValue;

    AxisEvent(const InputDevicePtr &dev, unsigned int axis, AxisValue value)
        : InputEvent(dev),
        mAxis(axis),
        mValue(value)
    {
    }
};
typedef std::tr1::shared_ptr<AxisEvent> AxisEventPtr;

class SIRIKATA_OGRE_EXPORT TextInputEvent: public InputEvent {
public:
    std::string mText; 

    TextInputEvent(const InputDevicePtr &dev, char *text)
        : InputEvent(dev),
                                 mText(text) {
    }
};
typedef std::tr1::shared_ptr<TextInputEvent> TextInputEventPtr;

class SIRIKATA_OGRE_EXPORT MouseEvent: public InputEvent {
public:
    float mX; 
    float mY; 
    int mCursorType; 

    MouseEvent(const PointerDevicePtr &dev,
               float x, float y, int cursorType)
        : InputEvent(dev) {
        mX = x;
        mY = y;
        mCursorType = cursorType;
    }

    PointerDevicePtr getDevice() const {
        return std::tr1::static_pointer_cast<PointerDevice>(
            InputEvent::getDevice());
    }
};
typedef std::tr1::shared_ptr<MouseEvent> MouseEventPtr;

class SIRIKATA_OGRE_EXPORT MouseHoverEvent: public MouseEvent {
public:
    MouseHoverEvent(const PointerDevicePtr &dev,
               float x, float y, int cursorType)
        : MouseEvent(dev, x, y, cursorType) {
    }
};
typedef std::tr1::shared_ptr<MouseHoverEvent> MouseHoverEventPtr;

class SIRIKATA_OGRE_EXPORT MouseDownEvent: public MouseEvent {
public:
    MouseButton mButton; 
    float mXStart; 
    float mYStart; 
    float mLastX;
    float mLastY;
    int mPressure; 
    int mPressureMax;
    int mPressureMin;

    float deltaX() const {
        return (mX - mXStart)/2.0f;
    }

    float deltaY() const {
        return (mY - mYStart)/2.0f;
    }

    float deltaLastY() const {
        return (mY - mLastY)/2.0f;
    }

    float deltaLastX() const {
        return (mX - mLastX)/2.0f;
    }

    MouseDownEvent(const PointerDevicePtr &dev,
                    float xstart, float ystart, float xend, float yend,
                    float lastx, float lasty,
                    int cursorType, int button,
                    int pressure, int pressureMin, int pressureMax)
        : MouseEvent(dev, xend, yend, cursorType) {
        mButton = button;
        mXStart = xstart;
        mYStart = ystart;
        mLastX = lastx;
        mLastY = lasty;
        mPressure = pressure;
        mPressureMin = pressureMin;
        mPressureMax = pressureMax;
    }
};
typedef std::tr1::shared_ptr<MouseDownEvent> MouseDownEventPtr;

class SIRIKATA_OGRE_EXPORT MouseClickEvent: public MouseDownEvent {
public:
    MouseClickEvent(const PointerDevicePtr &dev,
                    float x, float y,
                    int cursorType, int button)
        : MouseDownEvent(dev, x, y, x, y, x, y,
                         cursorType, button, 0, 0, 0) {
    }
};
typedef std::tr1::shared_ptr<MouseClickEvent> MouseClickEventPtr;

class SIRIKATA_OGRE_EXPORT MousePressedEvent: public MouseDownEvent {
public:
    MousePressedEvent(const PointerDevicePtr &dev,
                    float x, float y,
                    int cursorType, int button)
        : MouseDownEvent(dev, x, y, x, y, x, y,
                         cursorType, button, 0, 0, 0) {
    }
};
typedef std::tr1::shared_ptr<MousePressedEvent> MousePressedEventPtr;

class SIRIKATA_OGRE_EXPORT MouseReleasedEvent: public MouseDownEvent {
public:
    MouseReleasedEvent(const PointerDevicePtr &dev,
                    float x, float y,
                    int cursorType, int button)
        : MouseDownEvent(dev, x, y, x, y, x, y,
                         cursorType, button, 0, 0, 0) {
    }
};
typedef std::tr1::shared_ptr<MouseReleasedEvent> MouseReleasedEventPtr;

class SIRIKATA_OGRE_EXPORT MouseDragEvent: public MouseDownEvent {
public:
    MouseDragType mType;
    MouseDragEvent(const PointerDevicePtr &dev,
                   MouseDragType type,
                   float xstart, float ystart, float xend, float yend,
                   float lastx, float lasty,
                   int cursorType, int button,
                   int pressure, int pressureMin, int pressureMax)
        : MouseDownEvent(dev, xstart, ystart,
                         xend, yend, lastx, lasty, cursorType, button,
                         pressure, pressureMin, pressureMax) {
        mType = type;
    }
};
typedef std::tr1::shared_ptr<MouseDragEvent> MouseDragEventPtr;

class SIRIKATA_OGRE_EXPORT WindowEvent {
public:
    enum WindowEventName {
        WindowShown,
        WindowExposed,
        WindowHidden,
        WindowMoved,
        WindowResized,
        WindowMinimized,
        WindowMaximized,
        WindowRestored,
        WindowMouseEnter,
        WindowMouseLeave,
        WindowFocused,
        WindowUnfocused,
        WindowQuit,
        Unknown
    };

    WindowEventName mName;
    int mData1;
    int mData2;

    WindowEvent(WindowEventName name, int data1, int data2)
        : mName(name), mData1(data1), mData2(data2)
    {
    }

    WindowEventName name() const { return mName; }

    int getX() const {
        return mData1;
    }
    int getY() const {
        return mData2;
    }

};
typedef std::tr1::shared_ptr<WindowEvent> WindowEventPtr;

class SIRIKATA_OGRE_EXPORT DragAndDropEvent {
public:
    int mXCoord;
    int mYCoord;
    std::vector<std::string> mFilenames;
    DragAndDropEvent(const std::vector<std::string>&files, int x=0, int y=0)
        : mXCoord(x), mYCoord(y), mFilenames(files) {
    }
};
typedef std::tr1::shared_ptr<DragAndDropEvent> DragAndDropEventPtr;


class SIRIKATA_OGRE_EXPORT WebViewEvent : public InputEvent {
public:
    Graphics::WebView* wv;
    String webview;
    String name;
    std::vector<String> args; // The pointer here is annoying, but necessary to avoid having to include the defintion here, which in turn causes circular includes

    WebViewEvent(const String &wvName, const String& name, const std::vector<String>& args);
    WebViewEvent(const String &wvName, const std::vector<DataReference<const char*> >& args);
    virtual ~WebViewEvent();
};
typedef std::tr1::shared_ptr<WebViewEvent> WebViewEventPtr;


}
}

#endif