OgreInputEvent.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program 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 License for more details.

You should have received a copy of the GNU Lesser General License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/

/***************************************************************************
OgreInputEvent.h  -  
     * The root event class for all GuiElement-level input events.
     *
     * Input events are delivered to listeners before they are
     * processed normally by the source where they originated.
     * This allows listeners and GuiElement subclasses to "consume"
     * the event so that the source will not process them in their
     * default manner.  For example, consuming mousePressed events
     * on a Button GuiElement will prevent the Button from being
     * activated.
-------------------
begin                : Nov 19 2002
copyright            : (C) 2002 by Kenny Sabir
email                : kenny@sparksuit.com
***************************************************************************/

#ifndef __InputEvent_H__
#define __InputEvent_H__

#include "OgrePrerequisites.h"

namespace Ogre {

    class _OgreExport InputEvent
    {
    protected:

        Real mWhen;
        int mModifiers;

        EventTarget* mSource;

        int mId;

        bool mConsumed;

    public:
    
        
        enum        // using the enum hack cause VC6 doesn't support static const in classes
        {
            SHIFT_MASK      = 1 << 0,
            
            CTRL_MASK       = 1 << 1,
            
             META_MASK      = 1 << 2,
            ALT_MASK            = 1 << 3,
            BUTTON0_MASK        = 1 << 4,
            BUTTON1_MASK        = 1 << 5,
            BUTTON2_MASK        = 1 << 6,
            BUTTON3_MASK        = 1 << 7,
            BUTTON_ANY_MASK     = 0xF << 4
        };



        InputEvent(EventTarget* source, int id, long when, int modifiers);

        void consume();

        int getModifiers() const;
        
        Real getWhen() const;

        bool isAltDown() const;

        bool isConsumed() const;

        bool isControlDown() const;

        bool isMetaDown() const;

        bool isShiftDown() const;

        bool isEventBetween(int start, int end) const;
        int getID() const;

        EventTarget* getSource() const;
    };
}


#endif  // __InputEvent_H__

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 12:59:46 2006