godot/scene/2d/sprite.cpp

602 lines
15 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* sprite.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* http://www.godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2017 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. */
/*************************************************************************/
#include "sprite.h"
#include "core/core_string_names.h"
#include "os/os.h"
#include "scene/main/viewport.h"
#include "scene/scene_string_names.h"
void Sprite::edit_set_pivot(const Point2 &p_pivot) {
2014-02-10 01:10:30 +00:00
set_offset(p_pivot);
}
Point2 Sprite::edit_get_pivot() const {
return get_offset();
}
bool Sprite::edit_has_pivot() const {
return true;
}
void Sprite::_notification(int p_what) {
switch (p_what) {
2014-02-10 01:10:30 +00:00
case NOTIFICATION_DRAW: {
if (texture.is_null())
return;
RID ci = get_canvas_item();
/*
texture->draw(ci,Point2());
break;
*/
Size2 s;
Rect2 src_rect;
bool filter_clip = false;
2014-02-10 01:10:30 +00:00
if (region) {
s = region_rect.size;
src_rect = region_rect;
filter_clip = region_filter_clip;
2014-02-10 01:10:30 +00:00
} else {
s = Size2(texture->get_size());
s = s / Size2(hframes, vframes);
2014-02-10 01:10:30 +00:00
src_rect.size = s;
src_rect.position.x += float(frame % hframes) * s.x;
src_rect.position.y += float(frame / hframes) * s.y;
2014-02-10 01:10:30 +00:00
}
Point2 ofs = offset;
2014-02-10 01:10:30 +00:00
if (centered)
ofs -= s / 2;
if (Engine::get_singleton()->get_use_pixel_snap()) {
ofs = ofs.floor();
}
2014-02-10 01:10:30 +00:00
Rect2 dst_rect(ofs, s);
2014-02-10 01:10:30 +00:00
if (hflip)
dst_rect.size.x = -dst_rect.size.x;
2014-02-10 01:10:30 +00:00
if (vflip)
dst_rect.size.y = -dst_rect.size.y;
2014-02-10 01:10:30 +00:00
texture->draw_rect_region(ci, dst_rect, src_rect, Color(1, 1, 1), false, normal_map, filter_clip);
2014-02-10 01:10:30 +00:00
} break;
}
}
void Sprite::set_texture(const Ref<Texture> &p_texture) {
2014-02-10 01:10:30 +00:00
if (p_texture == texture)
2014-02-10 01:10:30 +00:00
return;
#ifdef DEBUG_ENABLED
2014-02-10 01:10:30 +00:00
if (texture.is_valid()) {
texture->disconnect(CoreStringNames::get_singleton()->changed, this, SceneStringNames::get_singleton()->update);
2014-02-10 01:10:30 +00:00
}
#endif
texture = p_texture;
/* this should no longer be needed in 3.0
#ifdef DEBUG_ENABLED
2014-02-10 01:10:30 +00:00
if (texture.is_valid()) {
texture->set_flags(texture->get_flags()); //remove repeat from texture, it looks bad in sprites
texture->connect(CoreStringNames::get_singleton()->changed, this, SceneStringNames::get_singleton()->update);
2014-02-10 01:10:30 +00:00
}
#endif
*/
2014-02-10 01:10:30 +00:00
update();
2016-06-20 01:16:41 +00:00
emit_signal("texture_changed");
2014-02-10 01:10:30 +00:00
item_rect_changed();
}
void Sprite::set_normal_map(const Ref<Texture> &p_texture) {
normal_map = p_texture;
update();
}
Ref<Texture> Sprite::get_normal_map() const {
return normal_map;
}
2014-02-10 01:10:30 +00:00
Ref<Texture> Sprite::get_texture() const {
return texture;
}
void Sprite::set_centered(bool p_center) {
centered = p_center;
2014-02-10 01:10:30 +00:00
update();
item_rect_changed();
}
bool Sprite::is_centered() const {
return centered;
}
void Sprite::set_offset(const Point2 &p_offset) {
2014-02-10 01:10:30 +00:00
offset = p_offset;
2014-02-10 01:10:30 +00:00
update();
item_rect_changed();
_change_notify("offset");
2014-02-10 01:10:30 +00:00
}
Point2 Sprite::get_offset() const {
return offset;
}
void Sprite::set_flip_h(bool p_flip) {
hflip = p_flip;
2014-02-10 01:10:30 +00:00
update();
}
bool Sprite::is_flipped_h() const {
return hflip;
}
void Sprite::set_flip_v(bool p_flip) {
vflip = p_flip;
2014-02-10 01:10:30 +00:00
update();
}
bool Sprite::is_flipped_v() const {
return vflip;
}
void Sprite::set_region(bool p_region) {
if (p_region == region)
2014-02-10 01:10:30 +00:00
return;
region = p_region;
2014-02-10 01:10:30 +00:00
update();
}
bool Sprite::is_region() const {
2014-02-10 01:10:30 +00:00
return region;
}
void Sprite::set_region_rect(const Rect2 &p_region_rect) {
2014-02-10 01:10:30 +00:00
if (region_rect == p_region_rect)
return;
region_rect = p_region_rect;
if (region)
2014-02-10 01:10:30 +00:00
item_rect_changed();
_change_notify("region_rect");
2014-02-10 01:10:30 +00:00
}
Rect2 Sprite::get_region_rect() const {
return region_rect;
}
void Sprite::set_region_filter_clip(bool p_enable) {
region_filter_clip = p_enable;
update();
}
bool Sprite::is_region_filter_clip_enabled() const {
return region_filter_clip;
}
2014-02-10 01:10:30 +00:00
void Sprite::set_frame(int p_frame) {
ERR_FAIL_INDEX(p_frame, vframes * hframes);
2014-02-10 01:10:30 +00:00
if (frame != p_frame)
item_rect_changed();
frame = p_frame;
_change_notify("frame");
emit_signal(SceneStringNames::get_singleton()->frame_changed);
2014-02-10 01:10:30 +00:00
}
int Sprite::get_frame() const {
return frame;
}
void Sprite::set_vframes(int p_amount) {
ERR_FAIL_COND(p_amount < 1);
vframes = p_amount;
2014-02-10 01:10:30 +00:00
update();
item_rect_changed();
_change_notify("frame");
}
int Sprite::get_vframes() const {
return vframes;
}
void Sprite::set_hframes(int p_amount) {
ERR_FAIL_COND(p_amount < 1);
hframes = p_amount;
2014-02-10 01:10:30 +00:00
update();
item_rect_changed();
_change_notify("frame");
}
int Sprite::get_hframes() const {
return hframes;
}
Rect2 Sprite::get_item_rect() const {
if (texture.is_null())
return Rect2(0, 0, 1, 1);
/*
if (texture.is_null())
return CanvasItem::get_item_rect();
*/
2014-02-10 01:10:30 +00:00
Size2i s;
if (region) {
s = region_rect.size;
2014-02-10 01:10:30 +00:00
} else {
s = texture->get_size();
s = s / Point2(hframes, vframes);
2014-02-10 01:10:30 +00:00
}
Point2 ofs = offset;
2014-02-10 01:10:30 +00:00
if (centered)
ofs -= s / 2;
2014-02-10 01:10:30 +00:00
if (s == Size2(0, 0))
s = Size2(1, 1);
2014-02-10 01:10:30 +00:00
return Rect2(ofs, s);
2014-02-10 01:10:30 +00:00
}
void Sprite::_validate_property(PropertyInfo &property) const {
2014-02-10 01:10:30 +00:00
if (property.name == "frame") {
property.hint = PROPERTY_HINT_SPRITE_FRAME;
property.hint_string = "0," + itos(vframes * hframes - 1) + ",1";
}
}
2014-02-10 01:10:30 +00:00
void Sprite::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_texture", "texture:Texture"), &Sprite::set_texture);
ClassDB::bind_method(D_METHOD("get_texture:Texture"), &Sprite::get_texture);
2014-02-10 01:10:30 +00:00
ClassDB::bind_method(D_METHOD("set_normal_map", "normal_map:Texture"), &Sprite::set_normal_map);
ClassDB::bind_method(D_METHOD("get_normal_map:Texture"), &Sprite::get_normal_map);
ClassDB::bind_method(D_METHOD("set_centered", "centered"), &Sprite::set_centered);
ClassDB::bind_method(D_METHOD("is_centered"), &Sprite::is_centered);
2014-02-10 01:10:30 +00:00
ClassDB::bind_method(D_METHOD("set_offset", "offset"), &Sprite::set_offset);
ClassDB::bind_method(D_METHOD("get_offset"), &Sprite::get_offset);
2014-02-10 01:10:30 +00:00
ClassDB::bind_method(D_METHOD("set_flip_h", "flip_h"), &Sprite::set_flip_h);
ClassDB::bind_method(D_METHOD("is_flipped_h"), &Sprite::is_flipped_h);
2014-02-10 01:10:30 +00:00
ClassDB::bind_method(D_METHOD("set_flip_v", "flip_v"), &Sprite::set_flip_v);
ClassDB::bind_method(D_METHOD("is_flipped_v"), &Sprite::is_flipped_v);
2014-02-10 01:10:30 +00:00
ClassDB::bind_method(D_METHOD("set_region", "enabled"), &Sprite::set_region);
ClassDB::bind_method(D_METHOD("is_region"), &Sprite::is_region);
2014-02-10 01:10:30 +00:00
ClassDB::bind_method(D_METHOD("set_region_rect", "rect"), &Sprite::set_region_rect);
ClassDB::bind_method(D_METHOD("get_region_rect"), &Sprite::get_region_rect);
2014-02-10 01:10:30 +00:00
ClassDB::bind_method(D_METHOD("set_region_filter_clip", "enabled"), &Sprite::set_region_filter_clip);
ClassDB::bind_method(D_METHOD("is_region_filter_clip_enabled"), &Sprite::is_region_filter_clip_enabled);
ClassDB::bind_method(D_METHOD("set_frame", "frame"), &Sprite::set_frame);
ClassDB::bind_method(D_METHOD("get_frame"), &Sprite::get_frame);
2014-02-10 01:10:30 +00:00
ClassDB::bind_method(D_METHOD("set_vframes", "vframes"), &Sprite::set_vframes);
ClassDB::bind_method(D_METHOD("get_vframes"), &Sprite::get_vframes);
2014-02-10 01:10:30 +00:00
ClassDB::bind_method(D_METHOD("set_hframes", "hframes"), &Sprite::set_hframes);
ClassDB::bind_method(D_METHOD("get_hframes"), &Sprite::get_hframes);
2014-02-10 01:10:30 +00:00
ADD_SIGNAL(MethodInfo("frame_changed"));
2016-06-20 01:16:41 +00:00
ADD_SIGNAL(MethodInfo("texture_changed"));
ADD_PROPERTYNZ(PropertyInfo(Variant::OBJECT, "texture", PROPERTY_HINT_RESOURCE_TYPE, "Texture"), "set_texture", "get_texture");
ADD_PROPERTYNZ(PropertyInfo(Variant::OBJECT, "normal_map", PROPERTY_HINT_RESOURCE_TYPE, "Texture"), "set_normal_map", "get_normal_map");
ADD_PROPERTYNO(PropertyInfo(Variant::BOOL, "centered"), "set_centered", "is_centered");
ADD_PROPERTYNZ(PropertyInfo(Variant::VECTOR2, "offset"), "set_offset", "get_offset");
ADD_PROPERTYNZ(PropertyInfo(Variant::BOOL, "flip_h"), "set_flip_h", "is_flipped_h");
ADD_PROPERTYNZ(PropertyInfo(Variant::BOOL, "flip_v"), "set_flip_v", "is_flipped_v");
ADD_PROPERTYNO(PropertyInfo(Variant::INT, "vframes", PROPERTY_HINT_RANGE, "1,16384,1"), "set_vframes", "get_vframes");
ADD_PROPERTYNO(PropertyInfo(Variant::INT, "hframes", PROPERTY_HINT_RANGE, "1,16384,1"), "set_hframes", "get_hframes");
ADD_PROPERTYNZ(PropertyInfo(Variant::INT, "frame", PROPERTY_HINT_SPRITE_FRAME), "set_frame", "get_frame");
ADD_GROUP("Region", "region_");
ADD_PROPERTYNZ(PropertyInfo(Variant::BOOL, "region_enabled"), "set_region", "is_region");
ADD_PROPERTYNZ(PropertyInfo(Variant::RECT2, "region_rect"), "set_region_rect", "get_region_rect");
ADD_PROPERTYNZ(PropertyInfo(Variant::BOOL, "region_filter_clip"), "set_region_filter_clip", "is_region_filter_clip_enabled");
2014-02-10 01:10:30 +00:00
}
Sprite::Sprite() {
centered = true;
hflip = false;
vflip = false;
region = false;
region_filter_clip = false;
2014-02-10 01:10:30 +00:00
frame = 0;
2014-02-10 01:10:30 +00:00
vframes = 1;
hframes = 1;
2014-02-10 01:10:30 +00:00
}
//////////////////////////// VPSPRITE
///
///
///
#if 0
void ViewportSprite::edit_set_pivot(const Point2& p_pivot) {
set_offset(p_pivot);
}
Point2 ViewportSprite::edit_get_pivot() const {
return get_offset();
}
bool ViewportSprite::edit_has_pivot() const {
return true;
}
void ViewportSprite::_notification(int p_what) {
switch(p_what) {
case NOTIFICATION_ENTER_TREE: {
if (!viewport_path.is_empty()) {
Node *n = get_node(viewport_path);
ERR_FAIL_COND(!n);
Viewport *vp=n->cast_to<Viewport>();
ERR_FAIL_COND(!vp);
Ref<RenderTargetTexture> rtt = vp->get_render_target_texture();
texture=rtt;
texture->connect("changed",this,"update");
item_rect_changed();
}
} break;
case NOTIFICATION_EXIT_TREE: {
if (texture.is_valid()) {
texture->disconnect("changed",this,"update");
texture=Ref<Texture>();
}
} break;
case NOTIFICATION_DRAW: {
if (texture.is_null())
return;
RID ci = get_canvas_item();
/*
texture->draw(ci,Point2());
break;
*/
Size2i s;
Rect2i src_rect;
s = texture->get_size();
src_rect.size=s;
Point2 ofs=offset;
if (centered)
ofs-=s/2;
if (OS::get_singleton()->get_use_pixel_snap()) {
ofs=ofs.floor();
}
Rect2 dst_rect(ofs,s);
texture->draw_rect_region(ci,dst_rect,src_rect,modulate);
} break;
}
}
void ViewportSprite::set_viewport_path(const NodePath& p_viewport) {
viewport_path=p_viewport;
update();
if (!is_inside_tree())
return;
if (texture.is_valid()) {
texture->disconnect("changed",this,"update");
texture=Ref<Texture>();
}
if (viewport_path.is_empty())
return;
Node *n = get_node(viewport_path);
ERR_FAIL_COND(!n);
Viewport *vp=n->cast_to<Viewport>();
ERR_FAIL_COND(!vp);
Ref<RenderTargetTexture> rtt = vp->get_render_target_texture();
texture=rtt;
if (texture.is_valid()) {
texture->connect("changed",this,"update");
}
item_rect_changed();
}
NodePath ViewportSprite::get_viewport_path() const {
return viewport_path;
}
void ViewportSprite::set_centered(bool p_center) {
centered=p_center;
update();
item_rect_changed();
}
bool ViewportSprite::is_centered() const {
return centered;
}
void ViewportSprite::set_offset(const Point2& p_offset) {
offset=p_offset;
update();
item_rect_changed();
}
Point2 ViewportSprite::get_offset() const {
return offset;
}
void ViewportSprite::set_modulate(const Color& p_color) {
modulate=p_color;
update();
}
Color ViewportSprite::get_modulate() const{
return modulate;
}
Rect2 ViewportSprite::get_item_rect() const {
if (texture.is_null())
return Rect2(0,0,1,1);
/*
if (texture.is_null())
return CanvasItem::get_item_rect();
*/
Size2i s;
s = texture->get_size();
Point2 ofs=offset;
if (centered)
ofs-=s/2;
if (s==Size2(0,0))
s=Size2(1,1);
return Rect2(ofs,s);
}
String ViewportSprite::get_configuration_warning() const {
if (!has_node(viewport_path) || !get_node(viewport_path) || !get_node(viewport_path)->cast_to<Viewport>()) {
return TTR("Path property must point to a valid Viewport node to work. Such Viewport must be set to 'render target' mode.");
} else {
Node *n = get_node(viewport_path);
if (n) {
Viewport *vp = n->cast_to<Viewport>();
if (!vp->is_set_as_render_target()) {
return TTR("The Viewport set in the path property must be set as 'render target' in order for this sprite to work.");
}
}
}
return String();
}
void ViewportSprite::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_viewport_path","path"),&ViewportSprite::set_viewport_path);
ClassDB::bind_method(D_METHOD("get_viewport_path"),&ViewportSprite::get_viewport_path);
ClassDB::bind_method(D_METHOD("set_centered","centered"),&ViewportSprite::set_centered);
ClassDB::bind_method(D_METHOD("is_centered"),&ViewportSprite::is_centered);
ClassDB::bind_method(D_METHOD("set_offset","offset"),&ViewportSprite::set_offset);
ClassDB::bind_method(D_METHOD("get_offset"),&ViewportSprite::get_offset);
ClassDB::bind_method(D_METHOD("set_modulate","modulate"),&ViewportSprite::set_modulate);
ClassDB::bind_method(D_METHOD("get_modulate"),&ViewportSprite::get_modulate);
ADD_PROPERTYNZ( PropertyInfo( Variant::NODE_PATH, "viewport"), "set_viewport_path","get_viewport_path");
ADD_PROPERTYNO( PropertyInfo( Variant::BOOL, "centered"), "set_centered","is_centered");
ADD_PROPERTYNZ( PropertyInfo( Variant::VECTOR2, "offset"), "set_offset","get_offset");
ADD_PROPERTYNO( PropertyInfo( Variant::COLOR, "modulate"), "set_modulate","get_modulate");
}
ViewportSprite::ViewportSprite() {
centered=true;
modulate=Color(1,1,1,1);
}
#endif