CWE-ou-minkata/Sources/Plasma/PubUtilLib/plInputCore/plTelescopeInputInterface.h

/*==LICENSE==*

CyanWorlds.com Engine - MMOG client, server and tools
Copyright (C) 2011  Cyan Worlds, Inc.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Additional permissions under GNU GPL version 3 section 7

If you modify this Program, or any covered work, by linking or
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK,
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK
(or a modified version of those libraries),
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA,
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the
licensors of this Program grant you additional
permission to convey the resulting work. Corresponding Source for a
non-source form of such a combination shall include the source code for
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered
work.

You can contact Cyan Worlds, Inc. by email legal@cyan.com
 or by snail mail at:
      Cyan Worlds, Inc.
      14617 N Newport Hwy
      Mead, WA   99021

*==LICENSE==*/
//////////////////////////////////////////////////////////////////////////////
//                                                                          //
//  plTelescopeInputInterface                                                   //
//                                                                          //
//////////////////////////////////////////////////////////////////////////////

#ifndef _plTelescopeInputInterface_h
#define _plTelescopeInputInterface_h

#include "plInputInterface.h"
#include "pnKeyedObject/plKey.h"

//// Class Definition ////////////////////////////////////////////////////////
        
class plTelescopeInputInterface : public plInputInterface
{
    protected:

        virtual bool IEval( double secs, float del, uint32_t dirty );

    public:

        plTelescopeInputInterface();
        virtual ~plTelescopeInputInterface();

        virtual void        RestoreDefaultKeyMappings( void );
        
        virtual bool    InterpretInputEvent( plInputEventMsg *pMsg );

        virtual bool    MsgReceive( plMessage *msg );

        virtual void    Init( plInputInterfaceMgr *manager );
        virtual void    Shutdown( void ) {;}

        // Returns the priority of this interface layer, based on the Priorities enum
        virtual uint32_t  GetPriorityLevel( void ) const { return kTelescopeInputPriority; }

        // Returns the currently active mouse cursor for this layer, as defined in pnMessage/plCursorChangeMsg.h
        virtual uint32_t      GetCurrentCursorID( void ) const { return kCursorUp; }

        // Returns the current opacity that this layer wants the cursor to be, from 0 (xparent) to 1 (opaque)
        virtual float    GetCurrentCursorOpacity( void ) const { return 1.f; }

        // Returns true if this layer is wanting to change the mouse, false if it isn't interested
        virtual bool        HasInterestingCursorID( void ) const { return false; }
};


#endif //_plTelescopeInputInterface_h