sprite.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib 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 ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Kenneth Gangstoe
**    Mark Page
*/


#pragma once

#include "../api_display.h"
#include "../../Core/Text/string_types.h"
#include "../../Core/System/sharedptr.h"
#include "../../Core/Math/origin.h"
#include "../../Core/Signals/signal_v0.h"
#include "../../Core/IOData/virtual_directory.h"
#include "../../Core/Resources/resource_data_session.h"
#include "../Render/graphic_context.h"
#include "../Render/blend_mode.h"

#include "color.h"

class CL_ResourceManager;
class CL_SpriteDescription;
class CL_Sprite_Impl;

class CL_API_DISPLAY CL_Sprite
{
public:
        enum ShowOnFinish
        {
                show_blank, show_last_frame, show_first_frame
        };

public:
        CL_Sprite();

        CL_Sprite(CL_GraphicContext &gc);

        CL_Sprite(CL_GraphicContext &gc, const CL_StringRef &fullname);

        CL_Sprite(CL_GraphicContext &gc, const CL_StringRef &filename, CL_VirtualDirectory &dir);

        CL_Sprite(CL_GraphicContext &gc, const CL_StringRef &resource_id, CL_ResourceManager *resources);

        CL_Sprite(CL_GraphicContext &gc, CL_IODevice &file, const CL_String &image_type);

        CL_Sprite(CL_GraphicContext &gc, const CL_SpriteDescription &description);

        CL_Sprite(const CL_Sprite &copy);
        virtual ~CL_Sprite();

public:
        bool is_null() const;

        CL_Angle get_angle() const;

        CL_Angle get_base_angle() const;


        void get_scale(float &x, float &y) const;


        float get_alpha() const;


        CL_Colorf get_color() const;

        bool get_linear_filter() const;

        void get_alignment(CL_Origin &origin, int &x, int &y) const;

        void get_rotation_hotspot(CL_Origin &origin, int &x, int &y) const;

        int get_current_frame() const;

        int get_frame_count() const;

        int get_frame_delay(int frame) const;

        CL_Point get_frame_offset(int frame) const;

        CL_Size get_frame_size(int frame) const;

        int get_width() const;

        int get_height() const;

        CL_Size get_size() const;

        int get_id() const;

        bool is_play_loop() const;

        bool is_play_backward() const;

        bool is_play_pingpong() const;


        ShowOnFinish get_show_on_finish() const;


        bool is_finished() const;

        bool is_looping() const;


public:
        bool operator==(const CL_Sprite &other) const
        {
                return impl==other.impl;
        }

        bool operator!=(const CL_Sprite &other) const
        {
                return impl!=other.impl;
        }

        bool operator<(const CL_Sprite &other) const
        {
                return impl < other.impl;
        }
        
public:
        CL_Sprite &operator =(const CL_Sprite &copy);


        void set_image_data(const CL_Sprite &image_source);


        void clone(const CL_Sprite &source);

        void draw(
                CL_GraphicContext &gc,
                float x,
                float y);

        void draw(
                CL_GraphicContext &gc,
                int x,
                int y);

        void draw(
                CL_GraphicContext &gc,
                const CL_Rectf &src,
                const CL_Rectf &dest);

        void draw(
                CL_GraphicContext &gc,
                const CL_Rectf &dest);

        int update(int time_elapsed_ms = -1);

        void set_angle(CL_Angle angle);

        void set_angle_pitch(CL_Angle angle);

        void set_angle_yaw(CL_Angle angle);

        void rotate(CL_Angle angle);

        void rotate_pitch(CL_Angle angle);

        void rotate_yaw(CL_Angle angle);

        void set_base_angle(CL_Angle angle);


        void set_scale(float x, float y);


        void set_alpha(float alpha);


        void set_color(const CL_Colorf &color);

        void set_color(const CL_Color& c) {CL_Colorf color; color.r = c.get_red() / 255.0f; color.g = c.get_green() / 255.0f; color.b = c.get_blue() / 255.0f; color.a = c.get_alpha() / 255.0f; set_color(color);}

        void set_linear_filter(bool linear_filter = true);

        void set_alignment(CL_Origin origin, int x = 0, int y = 0);

        void set_rotation_hotspot(CL_Origin origin, int x = 0, int y = 0);

        void set_frame(unsigned int frame);

        void set_delay(int delay_ms);

        void set_frame_delay(int frame, int delay_ms);

        void set_frame_offset(int frame, CL_Point offset);

        void set_id(int id);


        void finish();

        void restart();

        void set_play_loop(bool loop = true);

        void set_play_pingpong(bool pingpong = true);

        void set_play_backward(bool backward = true);

        void set_show_on_finish(CL_Sprite::ShowOnFinish show_on_finish);

public:

        CL_Signal_v0 &sig_animation_finished();

private:
        CL_SharedPtr<CL_Sprite_Impl> impl;
        CL_ResourceDataSession resource_data_session;
};

---