ICursorControl.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_CURSOR_CONTROL_H_INCLUDED__
#define __I_CURSOR_CONTROL_H_INCLUDED__

#include "IReferenceCounted.h"
#include "position2d.h"
#include "rect.h"

namespace irr
{
namespace gui
{

        class IGUISpriteBank;

        enum ECURSOR_ICON
        {
                // Following cursors might be system specific, or might use an Irrlicht icon-set. No guarantees so far.
                ECI_NORMAL,     // arrow
                ECI_CROSS,      // Crosshair
                ECI_HAND,       // Hand
                ECI_HELP,       // Arrow and question mark
                ECI_IBEAM,      // typical text-selection cursor
                ECI_NO,         // should not click icon
                ECI_WAIT,       // hourclass
                ECI_SIZEALL,    // arrow in all directions
                ECI_SIZENESW,   // resizes in direction north-east or south-west
                ECI_SIZENWSE,   // resizes in direction north-west or south-east
                ECI_SIZENS,     // resizes in direction north or south
                ECI_SIZEWE,     // resizes in direction west or east
                ECI_UP,         // up-arrow

                // Implementer note: Should we add system specific cursors, which use guaranteed the system icons,
                // then I would recommend using a naming scheme like ECI_W32_CROSS, ECI_X11_CROSSHAIR and adding those
                // additionally.

                ECI_COUNT               // maximal of defined cursors. Note that higher values can be created at runtime
        };

        const c8* const GUICursorIconNames[ECI_COUNT+1] =
        {
                "normal",
                "cross",
                "hand",
                "help",
                "ibeam",
                "no",
                "wait",
                "sizeall",
                "sizenesw",
                "sizenwse",
                "sizens",
                "sizewe",
                "sizeup",
                0
        };

        struct SCursorSprite
        {
                SCursorSprite()
                : SpriteBank(0), SpriteId(-1)
                {
                }

                SCursorSprite( gui::IGUISpriteBank * spriteBank, s32 spriteId, const core::position2d<s32> &hotspot=(core::position2d<s32>(0,0)) )
                : SpriteBank(spriteBank), SpriteId(spriteId), HotSpot(hotspot)
                {
                }

                IGUISpriteBank * SpriteBank;
                s32 SpriteId;
                core::position2d<s32> HotSpot;
        };

        enum ECURSOR_PLATFORM_BEHAVIOR
        {
                ECPB_NONE = 0,


                ECPB_X11_CACHE_UPDATES = 1
        };

        class ICursorControl : public virtual IReferenceCounted
        {
        public:


                virtual void setVisible(bool visible) = 0;


                virtual bool isVisible() const = 0;


                virtual void setPosition(const core::position2d<f32> &pos) = 0;


                virtual void setPosition(f32 x, f32 y) = 0;


                virtual void setPosition(const core::position2d<s32> &pos) = 0;


                virtual void setPosition(s32 x, s32 y) = 0;


                virtual const core::position2d<s32>& getPosition(bool updateCursor=true) = 0;


                virtual core::position2d<f32> getRelativePosition(bool updateCursor=true) = 0;


                virtual void setReferenceRect(core::rect<s32>* rect=0) = 0;



                virtual void setActiveIcon(ECURSOR_ICON iconId) {}

                virtual ECURSOR_ICON getActiveIcon() const { return gui::ECI_NORMAL; }


                virtual ECURSOR_ICON addIcon(const gui::SCursorSprite& icon) { return gui::ECI_NORMAL; }


                virtual void changeIcon(ECURSOR_ICON iconId, const gui::SCursorSprite& sprite) {}

                virtual core::dimension2di getSupportedIconSize() const { return core::dimension2di(0,0); }

                virtual void setPlatformBehavior(ECURSOR_PLATFORM_BEHAVIOR behavior) {}


                virtual ECURSOR_PLATFORM_BEHAVIOR getPlatformBehavior() const { return ECPB_NONE; }
        };


} // end namespace gui
} // end namespace irr

#endif