33 #include "../../Core/Math/origin.h"
34 #include "../../Core/Signals/signal.h"
35 #include "../../Core/IOData/file_system.h"
36 #include "../../Core/Resources/resource.h"
37 #include "../Render/graphic_context.h"
38 #include "../Image/image_import_description.h"
47 class CollisionOutline;
49 class ResourceManager;
52 class XMLResourceDocument;
212 return impl==other.impl;
218 return impl!=other.impl;
224 return impl < other.impl;
406 int width,
int height,
407 int xarray = 1,
int yarray = 1,
408 int array_skipframes = 0,
409 int xspacing = 0,
int yspacing = 0);
423 int xpos = 0,
int ypos = 0,
424 float trans_limit = 0.05f);
437 int xpos = 0,
int ypos = 0,
438 float trans_limit = 0.05f);
454 std::shared_ptr<Sprite_Impl> impl;
bool is_play_backward() const
Returns true if animation is played in from right to left (starts at end).
void set_rotation_hotspot(Origin origin, int x=0, int y=0)
Sets rotation hotspot.
bool is_finished() const
Returns true if animation is finished.
void restart()
Restart animation.
void add_frame(Canvas &canvas, IODevice &file, const std::string &image_type, const ImageImportDescription &import_desc=ImageImportDescription())
Add frame.
2D (x,y) point structure - Integer
Definition: point.h:63
void set_show_on_finish(Sprite::ShowOnFinish show_on_finish)
Set what is shown when the animation is finished.
int get_id() const
Returns the attached id (if exists).
void set_angle(Angle angle)
Set absolute rotation angle.
@ show_last_frame
Definition: sprite.h:62
Sprite(Canvas &canvas, const std::string &filename, const FileSystem &file_system, const ImageImportDescription &import_desc=ImageImportDescription())
Constructs a Sprite.
Sprite & operator=(const Sprite ©)
Copy assignment operator.
Resource manager.
Definition: resource_manager.h:45
void add_frame(const Texture2D &texture, const Rect &frame)
Add frame.
bool operator!=(const Sprite &other) const
Inequality operator.
Definition: sprite.h:216
Signal< void()> & sig_animation_finished()
Sig animation finished.
2D (left,top,right,bottom) rectangle structure - Integer
Definition: rect.h:471
void set_color(const Colorf &color)
Sets the color.
int get_height() const
Return the height of the current frame, shortcut for 'get_frame_size(get_current_frame())....
bool operator==(const Sprite &other) const
Equality operator.
Definition: sprite.h:210
Image Import Description Class.
Definition: image_import_description.h:49
bool is_null() const
Returns true if this object is invalid.
Definition: sprite.h:118
void get_scale(float &x, float &y) const
Returns scale for x and y.
Size get_size() const
Return the size of the current frame, shortcut for 'get_frame_size(get_current_frame())'.
void set_alpha(float alpha)
Sets transparency.
Sprite()
Constructs a null instance.
static Resource< Sprite > resource(Canvas &canvas, const std::string &id, const ResourceManager &resources)
Retrieves a Sprite resource from the resource manager.
Size get_frame_size(int frame) const
Returns the size of a frame. 0 is first frame.
I/O Device interface.
Definition: iodevice.h:51
bool is_play_loop() const
Returns true if animation is played in loop (more than once).
2D (left,top,right,bottom) rectangle structure - Float
Definition: rect.h:485
Sprite(Canvas &canvas, IODevice &file, const std::string &image_type, const ImageImportDescription &import_desc=ImageImportDescription())
Constructs a Sprite.
Floating point color description class (for float).
Definition: color.h:661
void set_delay(int delay_ms)
Sets the delay for all frames.
void set_color(const Color &c)
Set color.
Definition: sprite.h:307
Origin
Alignment origins.
Definition: origin.h:41
2D texture object class.
Definition: texture_2d.h:42
void add_frame(const Texture2D &texture)
Add frame.
void set_angle_pitch(Angle angle)
Set absolute rotation pitch angle.
ShowOnFinish get_show_on_finish() const
Returns an enum for what is shown when the animation is finished.
Subtexture get_frame_texture(int frame) const
Return the texture of a frame. 0 is first frame.
2D Graphics Canvas
Definition: canvas.h:73
void add_gridclipped_frames(Canvas &canvas, const Texture2D &texture, int xpos, int ypos, int width, int height, int xarray=1, int yarray=1, int array_skipframes=0, int xspacing=0, int yspacing=0)
Adds images formed in a grid.
Color description class.
Definition: color.h:47
void draw(Canvas &canvas, const Rectf &src, const Rectf &dest)
@ show_blank
Definition: sprite.h:62
Angle class.
Definition: angle.h:63
void get_rotation_hotspot(Origin &origin, int &x, int &y) const
Returns rotation hot-spot.
Sprite clone() const
Copies all information from this sprite to another, excluding the graphics that remain shared.
Sprite(Canvas &canvas)
Constructs an empty Sprite.
void set_play_loop(bool loop=true)
Set to true if animation should loop, false otherwise.
void add_frame(Canvas &canvas, const std::string &filename, const FileSystem &file_system, const ImageImportDescription &import_desc=ImageImportDescription())
Add frame.
void set_play_pingpong(bool pingpong=true)
Set to true if animation should loop, false otherwise.
void update(int time_elapsed_ms)
Call this function to update the animation.
void set_image_data(const Sprite &image_source)
Sets the image data from another sprite, sharing animation state.
Point get_frame_offset(int frame) const
Returns the translation offset of a frame. 0 is first frame.
int get_frame_count() const
Returns number of frames in animation.
void rotate_pitch(Angle angle)
Add angle in degrees to current pitch angle.
Angle get_angle() const
Returns current angle in degrees.
void set_frame_offset(int frame, Point offset)
Sets the translate offset of a specific frame. 0 is first frame.
int get_width() const
Return the width of the current frame, shortcut for 'get_frame_size(get_current_frame())....
bool get_linear_filter() const
Returns true if the sprite uses a linear filter for scaling up and down, false if a nearest-point fil...
void set_id(int id)
Sets an attached id.
void rotate_yaw(Angle angle)
Add angle in degrees to current yaw angle.
void set_alignment(Origin origin, int x=0, int y=0)
Sets translation hotspot.
float get_alpha() const
Returns current alpha.
Sprite class.
Definition: sprite.h:56
void set_base_angle(Angle angle)
Sets the base angle in degrees - angle added to any rotation set with set_rotate() or rotate().
void finish()
Finish animation.
void get_alignment(Origin &origin, int &x, int &y) const
Returns translation hot-spot.
void set_linear_filter(bool linear_filter=true)
Set to true if a linear filter should be used for scaling up and down, false if a nearest-point filte...
static Sprite load(Canvas &canvas, const std::string &id, const XMLResourceDocument &doc)
Loads a Sprite from a XML resource definition.
int get_current_frame() const
Returns current frame in animation. 0 is first frame.
Sprite(Canvas &canvas, const std::string &fullname, const ImageImportDescription &import_desc=ImageImportDescription())
Constructs a Sprite.
Virtual File System (VFS).
Definition: file_system.h:48
XML Resource Document.
Definition: xml_resource_document.h:49
void rotate(Angle angle)
Add angle in degrees to current angle.
void add_frame(Canvas &canvas, const std::string &fullname, const ImageImportDescription &import_desc=ImageImportDescription())
Add frame.
Angle get_base_angle() const
Returns the base angle in degrees - angle added to any rotation set with set_rotate() or rotate().
void throw_if_null() const
Throw an exception if this object is invalid.
int get_frame_delay(int frame) const
Returns the delay of a frame.
void set_scale(float x, float y)
Set scale for x and y directions individually.
bool is_looping() const
Returns true if animation has looped in the last update cycle.
ShowOnFinish
Definition: sprite.h:61
bool is_play_pingpong() const
Returns true if animation is played in ping-pong mode.
Resource proxy of a specific type.
Definition: resource.h:59
bool operator<(const Sprite &other) const
Less than operator.
Definition: sprite.h:222
Sub-texture description.
Definition: subtexture.h:46
2D (width,height) size structure - Integer
Definition: size.h:157
void set_frame_delay(int frame, int delay_ms)
Sets the delay of a specific frame.
void add_alphaclipped_frames(Canvas &canvas, const Texture2D &texture, int xpos=0, int ypos=0, float trans_limit=0.05f)
Adds images separated with pure alpha (within trans_limit).
friend class FontFamily_Impl
Definition: sprite.h:456
@ show_first_frame
Definition: sprite.h:62
void set_angle_yaw(Angle angle)
Set absolute rotation yaw angle.
Colorf get_color() const
Returns current color.
void add_alphaclipped_frames_free(Canvas &canvas, const Texture2D &texture, int xpos=0, int ypos=0, float trans_limit=0.05f)
Adds images separated with pure alpha (within trans_limit).
void set_frame(unsigned int frame)
Sets current animation frame. 0 is first frame.
void set_play_backward(bool backward=true)
Set to true if animation should go backward (start at end).
void add_frames(const Texture2D &texture, Rect *frames, int num_frames)
Add frames.
void draw(Canvas &canvas, int x, int y)
void draw(Canvas &canvas, float x, float y)
Draw sprite on graphic context.
void draw(Canvas &canvas, const Rectf &dest)