cursor_description.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Kenneth Gangstoe
*/

#pragma once

#include "UICore/Display/Render/graphic_context.h"
#include "UICore/Display/Render/texture_2d.h"
#include "../Image/pixel_buffer.h"
#include <vector>

namespace uicore
{
    class CursorDescription_Impl;

    class CursorDescriptionFrame
    {

    public:

        CursorDescriptionFrame(PixelBufferPtr pixelbuffer, Rect rect) : pixelbuffer(pixelbuffer), rect(rect), delay(1.0) { }

        PixelBufferPtr pixelbuffer;
        Rect rect;
        double delay;

    };

    class CursorDescription
    {
    public:
        CursorDescription();

        CursorDescription(const CursorDescription &copy);

        ~CursorDescription();

        const std::vector<CursorDescriptionFrame> &frames() const;

        Point hotspot() const;

        bool operator==(const CursorDescription &that) const { return impl == that.impl; }
        bool operator!=(const CursorDescription &that) const { return impl != that.impl; }
        bool operator<(const CursorDescription &that) const { return impl < that.impl; }
        bool operator>(const CursorDescription &that) const { return impl > that.impl; }
        bool operator<=(const CursorDescription &that) const { return impl <= that.impl; }
        bool operator>=(const CursorDescription &that) const { return impl >= that.impl; }

        CursorDescription &operator =(const CursorDescription &copy);

        void add_frame(const PixelBufferPtr &pixelbuffer);

        void add_frame(const std::string &filename, const ImageImportDescription &import_desc = ImageImportDescription());

        void add_frame(const IODevicePtr &file, const std::string &image_type, const ImageImportDescription &import_desc = ImageImportDescription());


        void add_gridclipped_frames(
            const PixelBufferPtr &pixelbuffer,
            int xpos, int ypos,
            int width, int height,
            int xarray = 1, int yarray = 1,
            int array_skipframes = 0,
            int xspacing = 0, int yspacing = 0);


        void add_alphaclipped_frames(
            const PixelBufferPtr &pixelbuffer,
            int xpos = 0, int ypos = 0,
            float trans_limit = 0.05f);


        void add_alphaclipped_frames_free(
            const PixelBufferPtr &pixelbuffer,
            int xpos = 0, int ypos = 0,
            float trans_limit = 0.05f);

        void set_frame_delay(int frame, double delay);

        void set_hotspot(const Point &hotspot);

    private:
        std::shared_ptr<CursorDescription_Impl> impl;
    };
}