godot/scene/2d/sprite_2d.h

129 lines
4.4 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* sprite_2d.h */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
2014-02-10 01:10:30 +00: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. */
/*************************************************************************/
#ifndef SPRITE_2D_H
#define SPRITE_2D_H
2014-02-10 01:10:30 +00:00
#include "scene/2d/node_2d.h"
#include "scene/resources/texture.h"
class Sprite2D : public Node2D {
GDCLASS(Sprite2D, Node2D);
2014-02-10 01:10:30 +00:00
Ref<Texture2D> texture;
Color specular_color;
2021-01-30 04:10:32 +00:00
real_t shininess = 0.0;
2014-02-10 01:10:30 +00:00
bool centered = true;
2014-02-10 01:10:30 +00:00
Point2 offset;
bool hflip = false;
bool vflip = false;
bool region_enabled = false;
2014-02-10 01:10:30 +00:00
Rect2 region_rect;
bool region_filter_clip_enabled = false;
2014-02-10 01:10:30 +00:00
int frame = 0;
2014-02-10 01:10:30 +00:00
int vframes = 1;
int hframes = 1;
2014-02-10 01:10:30 +00:00
void _get_rects(Rect2 &r_src_rect, Rect2 &r_dst_rect, bool &r_filter_clip_enabled) const;
2017-12-27 08:28:02 +00:00
void _texture_changed();
2014-02-10 01:10:30 +00:00
protected:
void _notification(int p_what);
2017-01-14 17:03:38 +00:00
static void _bind_methods();
2014-02-10 01:10:30 +00:00
2020-07-10 10:34:39 +00:00
virtual void _validate_property(PropertyInfo &property) const override;
2014-02-10 01:10:30 +00:00
public:
#ifdef TOOLS_ENABLED
2020-07-10 10:34:39 +00:00
virtual Dictionary _edit_get_state() const override;
virtual void _edit_set_state(const Dictionary &p_state) override;
2020-07-10 10:34:39 +00:00
virtual void _edit_set_pivot(const Point2 &p_pivot) override;
virtual Point2 _edit_get_pivot() const override;
virtual bool _edit_use_pivot() const override;
virtual bool _edit_is_selected_on_click(const Point2 &p_point, double p_tolerance) const override;
2020-07-10 10:34:39 +00:00
virtual Rect2 _edit_get_rect() const override;
virtual bool _edit_use_rect() const override;
#endif
bool is_pixel_opaque(const Point2 &p_point) const;
2014-02-10 01:10:30 +00:00
void set_texture(const Ref<Texture2D> &p_texture);
Ref<Texture2D> get_texture() const;
2014-02-10 01:10:30 +00:00
void set_centered(bool p_center);
bool is_centered() const;
void set_offset(const Point2 &p_offset);
2014-02-10 01:10:30 +00: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_enabled(bool p_enabled);
bool is_region_enabled() const;
2014-02-10 01:10:30 +00:00
void set_region_filter_clip_enabled(bool p_enabled);
bool is_region_filter_clip_enabled() const;
void set_region_rect(const Rect2 &p_region_rect);
2014-02-10 01:10:30 +00:00
Rect2 get_region_rect() const;
void set_frame(int p_frame);
int get_frame() const;
2021-05-23 16:46:39 +00:00
void set_frame_coords(const Vector2i &p_coord);
Vector2i get_frame_coords() const;
2014-02-10 01:10:30 +00:00
void set_vframes(int p_amount);
int get_vframes() const;
void set_hframes(int p_amount);
int get_hframes() const;
Rect2 get_rect() const;
2020-07-10 10:34:39 +00:00
virtual Rect2 get_anchorable_rect() const override;
Sprite2D();
~Sprite2D();
2014-02-10 01:10:30 +00:00
};
#endif // SPRITE_H