Cinder

  • Main Page
  • Related Pages
  • Namespaces
  • Classes
  • Files
  • File List
  • File Members

include/cinder/app/MouseEvent.h

Go to the documentation of this file.
00001 /*
00002  Copyright (c) 2010, The Barbarian Group
00003  All rights reserved.
00004 
00005  Redistribution and use in source and binary forms, with or without modification, are permitted provided that
00006  the following conditions are met:
00007 
00008     * Redistributions of source code must retain the above copyright notice, this list of conditions and
00009     the following disclaimer.
00010     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
00011     the following disclaimer in the documentation and/or other materials provided with the distribution.
00012 
00013  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
00014  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00015  PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
00016  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00017  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00018  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00019  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00020  POSSIBILITY OF SUCH DAMAGE.
00021 */
00022 
00023 #pragma once
00024 
00025 #include "cinder/Vector.h"
00026 
00027 namespace cinder { namespace app {
00028 
00030 class MouseEvent {
00031   public:
00032     MouseEvent() {}
00033     MouseEvent( int aInitiator, int aX, int aY, unsigned int aModifiers, float aWheelIncrement, uint32_t aNativeModifiers )
00034         : mInitiator( aInitiator ), mX( aX ), mY( aY ), mModifiers( aModifiers ), mWheelIncrement( aWheelIncrement ), mNativeModifiers( aNativeModifiers )
00035     {}
00036     
00038     int         getX() const { return mX; }
00040     int         getY() const { return mY; }
00042     Vec2i       getPos() const { return Vec2i( mX, mY ); }
00044     bool        isLeft() const { return ( mInitiator & LEFT_DOWN ) ? true : false; }
00046     bool        isRight() const { return ( mInitiator & RIGHT_DOWN ) ? true : false; }
00048     bool        isMiddle() const { return ( mInitiator & MIDDLE_DOWN ) ? true : false; }
00050     bool        isLeftDown() const { return (mModifiers & LEFT_DOWN) ? true : false; }
00052     bool        isRightDown() const { return (mModifiers & RIGHT_DOWN) ? true : false; }
00054     bool        isMiddleDown() const { return (mModifiers & MIDDLE_DOWN) ? true : false; }
00056     bool        isShiftDown() const { return (mModifiers & SHIFT_DOWN) ? true : false; }
00058     bool        isAltDown() const { return (mModifiers & ALT_DOWN) ? true : false; }
00060     bool        isControlDown() const { return (mModifiers & CTRL_DOWN) ? true : false; }
00062     bool        isMetaDown() const { return (mModifiers & META_DOWN) ? true : false; }
00064     bool        isAccelDown() const { return (mModifiers & ACCEL_DOWN) ? true : false; }    
00066     float       getWheelIncrement() const { return mWheelIncrement; }
00067     
00069     uint32_t    getNativeModifiers() const { return mNativeModifiers; } 
00070 
00071     enum {  LEFT_DOWN   = 0x0001,
00072             RIGHT_DOWN  = 0x0002,
00073             MIDDLE_DOWN = 0x0004,
00074             SHIFT_DOWN  = 0x0008,
00075             ALT_DOWN    = 0x0010,
00076             CTRL_DOWN   = 0x0020,
00077             META_DOWN   = 0x0040,
00078 #if defined( CINDER_MSW )
00079             ACCEL_DOWN  = CTRL_DOWN
00080 #else
00081             ACCEL_DOWN  = META_DOWN
00082 #endif
00083             };  
00084             
00085   private:
00086     int             mInitiator;
00087     int             mX, mY;
00088     unsigned int    mModifiers;
00089     float           mWheelIncrement;
00090     uint32_t        mNativeModifiers;
00091 };
00092 
00093 } } // namespace cinder::app