2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2020-03-26 22:49:16 +01:00
|
|
|
/* sprite_2d.h */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2020-01-01 11:16:22 +01:00
|
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
2014-02-10 02:10:30 +01:00
|
|
|
/* */
|
|
|
|
/* 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 OR COPYRIGHT HOLDERS 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. */
|
|
|
|
/*************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
#ifndef SPRITE_2D_H
|
|
|
|
#define SPRITE_2D_H
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
#include "scene/2d/node_2d.h"
|
|
|
|
#include "scene/resources/texture.h"
|
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
class Sprite2D : public Node2D {
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
GDCLASS(Sprite2D, Node2D);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2019-06-11 20:43:37 +02:00
|
|
|
Ref<Texture2D> texture;
|
|
|
|
Ref<Texture2D> normal_map;
|
2019-07-05 03:54:32 +02:00
|
|
|
Ref<Texture2D> specular;
|
|
|
|
Color specular_color;
|
|
|
|
float shininess;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
bool centered;
|
|
|
|
Point2 offset;
|
|
|
|
|
|
|
|
bool hflip;
|
|
|
|
bool vflip;
|
|
|
|
bool region;
|
|
|
|
Rect2 region_rect;
|
2017-06-19 03:55:02 +02:00
|
|
|
bool region_filter_clip;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
int frame;
|
|
|
|
|
|
|
|
int vframes;
|
|
|
|
int hframes;
|
|
|
|
|
2017-12-27 09:28:02 +01:00
|
|
|
void _get_rects(Rect2 &r_src_rect, Rect2 &r_dst_rect, bool &r_filter_clip) const;
|
|
|
|
|
2019-09-25 20:48:48 +02:00
|
|
|
void _texture_changed();
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
protected:
|
|
|
|
void _notification(int p_what);
|
|
|
|
|
2017-01-14 18:03:38 +01:00
|
|
|
static void _bind_methods();
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual void _validate_property(PropertyInfo &property) const;
|
2016-07-07 04:46:04 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
public:
|
2019-10-21 23:37:07 +02:00
|
|
|
#ifdef TOOLS_ENABLED
|
2017-11-07 08:58:35 +01:00
|
|
|
virtual Dictionary _edit_get_state() const;
|
|
|
|
virtual void _edit_set_state(const Dictionary &p_state);
|
|
|
|
|
2017-11-15 23:03:25 +01:00
|
|
|
virtual void _edit_set_pivot(const Point2 &p_pivot);
|
|
|
|
virtual Point2 _edit_get_pivot() const;
|
|
|
|
virtual bool _edit_use_pivot() const;
|
2017-12-27 09:28:02 +01:00
|
|
|
virtual bool _edit_is_selected_on_click(const Point2 &p_point, double p_tolerance) const;
|
2018-03-08 21:35:41 +01:00
|
|
|
|
|
|
|
virtual Rect2 _edit_get_rect() const;
|
|
|
|
virtual bool _edit_use_rect() const;
|
2019-10-21 23:37:07 +02:00
|
|
|
#endif
|
|
|
|
|
|
|
|
bool is_pixel_opaque(const Point2 &p_point) const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2019-06-11 20:43:37 +02:00
|
|
|
void set_texture(const Ref<Texture2D> &p_texture);
|
|
|
|
Ref<Texture2D> get_texture() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2019-06-11 20:43:37 +02:00
|
|
|
void set_normal_map(const Ref<Texture2D> &p_texture);
|
|
|
|
Ref<Texture2D> get_normal_map() const;
|
2017-06-18 04:26:49 +02:00
|
|
|
|
2019-07-05 03:54:32 +02:00
|
|
|
void set_specular_map(const Ref<Texture2D> &p_texture);
|
|
|
|
Ref<Texture2D> get_specular_map() const;
|
|
|
|
|
|
|
|
void set_specular_color(const Color &p_color);
|
|
|
|
Color get_specular_color() const;
|
|
|
|
|
|
|
|
void set_shininess(float p_shininess);
|
|
|
|
float get_shininess() const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
void set_centered(bool p_center);
|
|
|
|
bool is_centered() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_offset(const Point2 &p_offset);
|
2014-02-10 02:10:30 +01:00
|
|
|
Point2 get_offset() const;
|
|
|
|
|
|
|
|
void set_flip_h(bool p_flip);
|
|
|
|
bool is_flipped_h() const;
|
|
|
|
|
|
|
|
void set_flip_v(bool p_flip);
|
|
|
|
bool is_flipped_v() const;
|
|
|
|
|
|
|
|
void set_region(bool p_region);
|
|
|
|
bool is_region() const;
|
|
|
|
|
2017-06-19 03:55:02 +02:00
|
|
|
void set_region_filter_clip(bool p_enable);
|
|
|
|
bool is_region_filter_clip_enabled() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_region_rect(const Rect2 &p_region_rect);
|
2014-02-10 02:10:30 +01:00
|
|
|
Rect2 get_region_rect() const;
|
|
|
|
|
|
|
|
void set_frame(int p_frame);
|
|
|
|
int get_frame() const;
|
|
|
|
|
2019-08-07 12:54:30 +02:00
|
|
|
void set_frame_coords(const Vector2 &p_coord);
|
2019-01-25 19:21:23 +01:00
|
|
|
Vector2 get_frame_coords() const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
void set_vframes(int p_amount);
|
|
|
|
int get_vframes() const;
|
|
|
|
|
|
|
|
void set_hframes(int p_amount);
|
|
|
|
int get_hframes() const;
|
|
|
|
|
2018-02-16 18:58:27 +01:00
|
|
|
Rect2 get_rect() const;
|
2018-05-05 16:59:00 +02:00
|
|
|
virtual Rect2 get_anchorable_rect() const;
|
2018-02-16 18:58:27 +01:00
|
|
|
|
2020-03-26 22:49:16 +01:00
|
|
|
Sprite2D();
|
|
|
|
~Sprite2D();
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // SPRITE_H
|