include/cinder/app/MouseEvent.h

Go to the documentation of this file.

/*
 Copyright (c) 2012, The Cinder Project, All rights reserved.

 This code is intended for use with the Cinder C++ library: http://libcinder.org

 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.

 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 HOLDER 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.
*/

#pragma once

#include "cinder/Cinder.h"
#include "cinder/app/Event.h"
#include "cinder/Vector.h"


namespace cinder { namespace app {

class MouseEvent : public Event {
  public:
    MouseEvent() : Event() {}
    MouseEvent( WindowRef win, int aInitiator, int aX, int aY, unsigned int aModifiers, float aWheelIncrement, uint32_t aNativeModifiers )
        : Event( win ), mInitiator( aInitiator ), mX( aX ), mY( aY ), mModifiers( aModifiers ), mWheelIncrement( aWheelIncrement ), mNativeModifiers( aNativeModifiers )
    {}
    
    int         getX() const { return mX; }
    int         getY() const { return mY; }
    Vec2i       getPos() const { return Vec2i( mX, mY ); }
    bool        isLeft() const { return ( mInitiator & LEFT_DOWN ) ? true : false; }
    bool        isRight() const { return ( mInitiator & RIGHT_DOWN ) ? true : false; }
    bool        isMiddle() const { return ( mInitiator & MIDDLE_DOWN ) ? true : false; }
    bool        isLeftDown() const { return (mModifiers & LEFT_DOWN) ? true : false; }
    bool        isRightDown() const { return (mModifiers & RIGHT_DOWN) ? true : false; }
    bool        isMiddleDown() const { return (mModifiers & MIDDLE_DOWN) ? true : false; }
    bool        isShiftDown() const { return (mModifiers & SHIFT_DOWN) ? true : false; }
    bool        isAltDown() const { return (mModifiers & ALT_DOWN) ? true : false; }
    bool        isControlDown() const { return (mModifiers & CTRL_DOWN) ? true : false; }
    bool        isMetaDown() const { return (mModifiers & META_DOWN) ? true : false; }
    bool        isAccelDown() const { return (mModifiers & ACCEL_DOWN) ? true : false; }    
    float       getWheelIncrement() const { return mWheelIncrement; }
    
    uint32_t    getNativeModifiers() const { return mNativeModifiers; } 

    enum {  LEFT_DOWN   = 0x0001,
            RIGHT_DOWN  = 0x0002,
            MIDDLE_DOWN = 0x0004,
            SHIFT_DOWN  = 0x0008,
            ALT_DOWN    = 0x0010,
            CTRL_DOWN   = 0x0020,
            META_DOWN   = 0x0040,
#if defined( CINDER_MSW )
            ACCEL_DOWN  = CTRL_DOWN
#else
            ACCEL_DOWN  = META_DOWN
#endif
            };  
            
  private:
    int             mInitiator;
    int             mX, mY;
    unsigned int    mModifiers;
    float           mWheelIncrement;
    uint32_t        mNativeModifiers;
};

} } // namespace cinder::app