OgreEventDispatcher.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 Public 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 Public License for more details.

You should have received a copy of the GNU Lesser General Public 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.
-----------------------------------------------------------------------------
*/

/***************************************************************************
OgreEventDispatcher.h  -  
    Handles the Dispatching of events to a EventTarget (mainly a PositionTarget for 
    mouse moving). The EventTargets are managed by a target manager.

    A EventDispatcher is needed for each TargetManager. ie 1 dispatcher for the OverlayManager,
    for managing the 2D GUI components, and another EventDispatcher for a SceneManager 
    managing the 3D objects.(NOTE currently the SceneManager isn't a TargetManager.. this is a TODO).

-------------------
begin                : Nov 19 2002
copyright            : (C) 2002 by Kenny Sabir
email                : kenny@sparksuit.com
***************************************************************************/



#ifndef __EventDispatcher_H__
#define __EventDispatcher_H__

#include "OgrePrerequisites.h"

namespace Ogre {

    class _OgreExport EventDispatcher
    {
    protected:
        TargetManager* mTargetManager;      

        PositionTarget* mFocus; // isn't implemented yet

        PositionTarget* mMouseDragSource;

        PositionTarget* mKeyCursorOn;   

            PositionTarget* mTargetLastEntered;

        Real mMouseX;
        Real mMouseY;

        bool mDragging;       // i.e. mouse grab

        bool mDragDropOn;

        bool mDragDropActive;

        int mEventMask;

        //-------------------
        // protected methods    

        bool processKeyEvent(KeyEvent* e) ;

        bool processMouseEvent(MouseEvent* e) ;

        void retargetMouseEvent(PositionTarget* target, MouseEvent* e) ;

        void retargetMouseEvent(PositionTarget* target, int id, MouseEvent* e, bool consume = false) ;

        void retargetKeyEvent(PositionTarget* target, int id, MouseEvent* e) ;

        /*
        * Generates enter/exit events as mouse moves over lw PositionTargets
        * @param targetOver Target mouse is over (including native container)
        * @param e          Mouse event in native container
        */

        void trackMouseEnterExit(PositionTarget* targetOver, MouseEvent* e) ;

        /*
        * Generates FocusIn/FocusOut events as the keyboard focus changes.
        * @param targetOver Target mouse is over (including native container)
        * @param e           Mouse event in native container
        */
        void trackKeyEnterExit(PositionTarget* targetOver, MouseEvent* e);

    public:
        EventDispatcher(TargetManager* pTargetManager);
        virtual ~EventDispatcher();       

        bool dispatchEvent(InputEvent* e);

        void setDragDrop(bool dragDropOn);

        inline Real getMouseX() const { return mMouseX; }
        inline Real getMouseY() const { return mMouseY; }
    };

}


#endif 

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:40 2006