MouseCursor.h

/***********************************************************************
        created:        21/2/2004
        author:         Paul D Turner
        
        purpose:        Defines interface for the MouseCursor class
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2012 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIMouseCursor_h_
#define _CEGUIMouseCursor_h_

#include "CEGUI/Base.h"
#include "CEGUI/String.h"
#include "CEGUI/Vector.h"
#include "CEGUI/Rect.h"
#include "CEGUI/EventSet.h"
#include "CEGUI/InputEvent.h"
#include "CEGUI/UDim.h"


#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4275)
#       pragma warning(disable : 4251)
#endif

// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT MouseCursor :
    public EventSet,
    public AllocatedObject<MouseCursor>
{
public:
        static const String EventNamespace;

        static const String EventImageChanged;

        static const String EventDefaultImageChanged;

        MouseCursor(void);


        ~MouseCursor(void);


        void    setImage(const String& name);


        void    setImage(const Image* image);


        const Image*    getImage(void) const    {return d_cursorImage;}

    void setDefaultImage(const Image* image);

    void setDefaultImage(const String& name);

    const Image* getDefaultImage() const;


        void    draw(void) const;


        void    setPosition(const Vector2f& position);


        void    offsetPosition(const Vector2f& offset);


        void    setConstraintArea(const Rectf* area);


        void    setUnifiedConstraintArea(const URect* area);


        void    hide(void)              {d_visible = false;}


        void    show(void)              {d_visible = true;}


    void    setVisible(bool visible)    {d_visible = visible;}


        bool    isVisible(void) const   {return d_visible;}


        Vector2f getPosition(void) const
    { return d_position; }


        Rectf getConstraintArea(void) const;


        const URect& getUnifiedConstraintArea(void) const;


        Vector2f getDisplayIndependantPosition(void) const;

    void notifyDisplaySizeChanged(const Sizef& new_size);

    void setExplicitRenderSize(const Sizef& size);

    const Sizef& getExplicitRenderSize() const;

    static void setInitialMousePosition(const Vector2f& position);

    void invalidate();

protected:
        /*************************************************************************
                New event handlers
        *************************************************************************/
    virtual void onImageChanged(MouseCursorEventArgs& e);
    virtual void onDefaultImageChanged(MouseCursorEventArgs& e);


private:
        /*************************************************************************
                Implementation Methods
        *************************************************************************/
        void    constrainPosition(void);

    void cacheGeometry() const;

    void calculateCustomOffset() const;

        /*************************************************************************
                Implementation Data
        *************************************************************************/
        const Image* d_cursorImage;
        const Image* d_defaultCursorImage;
        Vector2f d_position;                                    
        bool    d_visible;                                      
        URect   d_constraints;                          
    GeometryBuffer* d_geometry;
    Sizef d_customSize;
    mutable Vector2f d_customOffset;
    static bool s_initialPositionSet;
    static Vector2f s_initialPosition;
    mutable bool d_cachedGeometryValid;
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUIMouseCursor_h_