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


/***************************************************************************
OgreCursor.h  -  
    The Cursor is an non-visual object that contains a the XYZ values that 
    are modified by a InputReader.
    An InputReader creates and contains a Cursor object that it uses when it 
    is set to buffered input (using the EventQueue).

    To get a graphical representation of the cursor, a CursorGuiElement is
    used, which is a MouseMotionListener to the Cursor.

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

#ifndef __Cursor_H__
#define __Cursor_H__

#include "OgrePrerequisites.h"
#include "OgreMouseMotionTarget.h"
#include "OgreMouseTarget.h"

namespace Ogre {
    class _OgreExport Cursor : public MouseMotionTarget, public MouseTarget
    {
    protected:
        Real mMouseX, mMouseY, mMouseZ;

        Real mRelX, mRelY, mRelZ;

        Real mXLowLimit, mXHighLimit, mYLowLimit, mYHighLimit, mZLowLimit, mZHighLimit;

        Real mScale;

        inline Real limit(Real val, Real low, Real high)
        {   return (val < low) ? low: ((val > high) ? high : val); }
    public :
        Cursor();
        virtual ~Cursor();

        void addToX(Real val);

        void addToY(Real val);

        void addToZ(Real val);

        void processEvent(InputEvent* e);


        Real getX() const;

        Real getY() const;

        Real getZ() const;

        Real getRelX() const {return mRelX;}

        Real getRelY() const {return mRelY;}

        Real getRelZ() const {return mRelZ;}



    // PositionTarget methods
        Real getLeft(void) const ;

        Real getTop(void) const ;

        PositionTarget* getPositionTargetParent() const;

        inline virtual bool isKeyEnabled() const
        { return false; }

        Real getScale(void) const { return mScale; }
        void setScale(Real scale) { mScale = scale; }
        

    };

}


#endif  // __Cursor_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:43 2006