Merge pull request #7716 from GodotExplorer/pr-resizable-texturebutton

[2.1] Enhance TextureButton and TextureFrame with resize

scene/gui/texture_button.cpp

@@ -28,40 +28,36 @@
 /*************************************************************************/
 #include "texture_button.h"
 
-
 Size2 TextureButton::get_minimum_size() const {
 
-	Size2 rscale;
-	if (normal.is_null()) {
-		if (pressed.is_null()) {
-			if (hover.is_null())
-				if (click_mask.is_null())
-					rscale= Size2();
+	Size2 size = Control::get_minimum_size();
+	if(resize_mode == RESIZE_SCALE) {
+		if (normal.is_null()) {
+			if (pressed.is_null()) {
+				if (hover.is_null())
+					if (click_mask.is_null())
+						size=Size2();
+					else
+						size=click_mask->get_size();
 				else
-					rscale= click_mask->get_size();
-			else
-				rscale= hover->get_size();
+					size=hover->get_size();
+			} else
+				size=pressed->get_size();
 		} else
-			rscale=pressed->get_size();
-
-	} else
-		rscale= normal->get_size();
-
-	return rscale*scale.abs();
+			size=normal->get_size();
+		size=size*scale.abs();
+	}
+	return size;
 }
 
-
 bool TextureButton::has_point(const Point2& p_point) const {
-
-	if (scale[0] == 0 || scale[1] == 0) {
+	if ( resize_mode == RESIZE_SCALE &&  (scale[0] == 0 || scale[1] == 0)) {
 		return false;
 	}
-
-	Point2 ppos = p_point/scale.abs();
-
+	Point2 ppos = (resize_mode == RESIZE_SCALE) ? (p_point/scale.abs()) : p_point;
 	if (click_mask.is_valid()) {
 
-		Point2i p =ppos;
+		Point2i p = ppos;
 		if (p.x<0 || p.x>=click_mask->get_size().width || p.y<0 || p.y>=click_mask->get_size().height)
 			return false;
 
@@ -71,6 +67,7 @@ bool TextureButton::has_point(const Point2& p_point) const {
 	return Control::has_point(p_point);
 }
 
+
 void TextureButton::_notification(int p_what) {
 
 	switch( p_what ) {
@@ -119,17 +116,70 @@ void TextureButton::_notification(int p_what) {
 			}
 
 			if (texdraw.is_valid()) {
-				Rect2 drect(Point2(),texdraw->get_size()*scale);
-				draw_texture_rect(texdraw,drect,false,modulate);
-
+				Point2 ofs;
+				Size2 size = texdraw->get_size();
+				Rect2 tex_regin = Rect2(Point2(), texdraw->get_size());
+				bool tile = false;
+				if(resize_mode == RESIZE_STRETCH) {
+					switch (stretch_mode) {
+						case STRETCH_KEEP:
+							size = texdraw->get_size();
+							break;
+						case STRETCH_SCALE_ON_EXPAND:
+						case STRETCH_SCALE:
+							size = get_size();
+							break;
+						case STRETCH_TILE:
+							size = get_size();
+							tile = true;
+							break;
+						case STRETCH_KEEP_CENTERED:
+							ofs = (get_size() - texdraw->get_size())/2;
+							size = texdraw->get_size();
+							break;
+						case STRETCH_KEEP_ASPECT_CENTERED:
+						case STRETCH_KEEP_ASPECT: {
+							Size2 _size=get_size();
+							float tex_width = texdraw->get_width() * _size.height / texdraw->get_height();
+							float tex_height = _size.height;
+
+							if (tex_width > _size.width) {
+								tex_width = _size.width;
+								tex_height = texdraw->get_height() * tex_width / texdraw->get_width();
+							}
+
+							if (stretch_mode==STRETCH_KEEP_ASPECT_CENTERED) {
+								ofs.x = (_size.width - tex_width)/2;
+								ofs.y = (_size.height - tex_height)/2;
+							}
+							size.width = tex_width;
+							size.height = tex_height;
+						} break;
+						case STRETCH_KEEP_ASPECT_COVERED:{
+							size = get_size();
+							Size2 tex_size = texdraw->get_size();
+							Size2 scaleSize(size.width/tex_size.width, size.height/tex_size.height);
+							float scale = scaleSize.width > scaleSize.height? scaleSize.width : scaleSize.height;
+							Size2 scaledTexSize = tex_size * scale;
+							Point2 ofs = ((scaledTexSize - size) / scale).abs() / 2.0f;
+							tex_regin = Rect2(ofs, size/scale);
+						} break;
+					}
+				}
+				else {
+					size = texdraw->get_size()*scale;
+				}
+				if (tile)
+					draw_texture_rect(texdraw,Rect2(ofs,size),tile,modulate);
+				else
+					draw_texture_rect_region(texdraw, Rect2(ofs, size), tex_regin, modulate);
 			}
 			if (has_focus() && focused.is_valid()) {
 
-				Rect2 drect(Point2(),focused->get_size()*scale);
+				Rect2 drect(Point2(), get_size());
 				draw_texture_rect(focused,drect,false,modulate);
 
 			};
-
 		} break;
 	}
 }
@@ -144,6 +194,8 @@ void TextureButton::_bind_methods() {
 	ObjectTypeDB::bind_method(_MD("set_click_mask","mask:BitMap"),&TextureButton::set_click_mask);
 	ObjectTypeDB::bind_method(_MD("set_texture_scale","scale"),&TextureButton::set_texture_scale);
 	ObjectTypeDB::bind_method(_MD("set_modulate","color"),&TextureButton::set_modulate);
+	ObjectTypeDB::bind_method(_MD("set_resize_mode","p_mode"), &TextureButton::set_resize_mode);
+	ObjectTypeDB::bind_method(_MD("set_stretch_mode","p_mode"), & TextureButton::set_stretch_mode );
 
 	ObjectTypeDB::bind_method(_MD("get_normal_texture:Texture"),&TextureButton::get_normal_texture);
 	ObjectTypeDB::bind_method(_MD("get_pressed_texture:Texture"),&TextureButton::get_pressed_texture);
@@ -153,6 +205,8 @@ void TextureButton::_bind_methods() {
 	ObjectTypeDB::bind_method(_MD("get_click_mask:BitMap"),&TextureButton::get_click_mask);
 	ObjectTypeDB::bind_method(_MD("get_texture_scale"),&TextureButton::get_texture_scale);
 	ObjectTypeDB::bind_method(_MD("get_modulate"),&TextureButton::get_modulate);
+	ObjectTypeDB::bind_method(_MD("get_resize_mode"), & TextureButton::get_resize_mode);
+	ObjectTypeDB::bind_method(_MD("get_stretch_mode"), &TextureButton::get_stretch_mode);
 
 	ADD_PROPERTYNZ(PropertyInfo(Variant::OBJECT,"textures/normal",PROPERTY_HINT_RESOURCE_TYPE,"Texture"), _SCS("set_normal_texture"), _SCS("get_normal_texture"));
 	ADD_PROPERTYNZ(PropertyInfo(Variant::OBJECT,"textures/pressed",PROPERTY_HINT_RESOURCE_TYPE,"Texture"), _SCS("set_pressed_texture"), _SCS("get_pressed_texture"));
@@ -160,9 +214,19 @@ void TextureButton::_bind_methods() {
 	ADD_PROPERTYNZ(PropertyInfo(Variant::OBJECT,"textures/disabled",PROPERTY_HINT_RESOURCE_TYPE,"Texture"), _SCS("set_disabled_texture"), _SCS("get_disabled_texture"));
 	ADD_PROPERTYNZ(PropertyInfo(Variant::OBJECT,"textures/focused",PROPERTY_HINT_RESOURCE_TYPE,"Texture"), _SCS("set_focused_texture"), _SCS("get_focused_texture"));
 	ADD_PROPERTYNZ(PropertyInfo(Variant::OBJECT,"textures/click_mask",PROPERTY_HINT_RESOURCE_TYPE,"BitMap"), _SCS("set_click_mask"), _SCS("get_click_mask")) ;
+	ADD_PROPERTY(PropertyInfo(Variant::INT, "params/resize_mode",PROPERTY_HINT_ENUM,"Scale (Compat),Stretch"), _SCS("set_resize_mode"), _SCS("get_resize_mode"));
 	ADD_PROPERTYNO(PropertyInfo(Variant::VECTOR2,"params/scale",PROPERTY_HINT_RANGE,"0.01,1024,0.01"), _SCS("set_texture_scale"), _SCS("get_texture_scale"));
+	ADD_PROPERTY(PropertyInfo(Variant::INT, "params/stretch_mode",PROPERTY_HINT_ENUM,"Scale On Expand (Compat),Scale,Tile,Keep,Keep Centered,Keep Aspect,Keep Aspect Centered,Keep Aspect Covered"), _SCS("set_stretch_mode"),_SCS("get_stretch_mode"));
 	ADD_PROPERTYNO(PropertyInfo(Variant::COLOR,"params/modulate"), _SCS("set_modulate"), _SCS("get_modulate"));
 
+	BIND_CONSTANT(STRETCH_SCALE_ON_EXPAND);
+	BIND_CONSTANT(STRETCH_SCALE);
+	BIND_CONSTANT(STRETCH_TILE);
+	BIND_CONSTANT(STRETCH_KEEP);
+	BIND_CONSTANT(STRETCH_KEEP_CENTERED);
+	BIND_CONSTANT(STRETCH_KEEP_ASPECT);
+	BIND_CONSTANT(STRETCH_KEEP_ASPECT_CENTERED);
+	BIND_CONSTANT(STRETCH_KEEP_ASPECT_COVERED);
 }
 
 
@@ -229,29 +293,48 @@ void TextureButton::set_focused_texture(const Ref<Texture>& p_focused) {
 	focused = p_focused;
 };
 
-void TextureButton::set_texture_scale(Size2 p_scale) {
+void TextureButton::set_modulate(const Color& p_modulate) {
+	modulate=p_modulate;
+	update();
+}
 
-	scale=p_scale;
+Color TextureButton::get_modulate() const {
+	return modulate;
+}
+
+TextureButton::ResizeMode TextureButton::get_resize_mode() const {
+	return resize_mode;
+}
+
+void TextureButton::set_resize_mode(TextureButton::ResizeMode p_mode) {
+	resize_mode = p_mode;
 	minimum_size_changed();
 	update();
 }
 
-Size2 TextureButton::get_texture_scale() const{
+void TextureButton::set_texture_scale(Size2 p_scale) {
+	scale = p_scale;
+	minimum_size_changed();
+	update();
+}
 
+Size2 TextureButton::get_texture_scale() const {
 	return scale;
 }
 
-void TextureButton::set_modulate(const Color& p_modulate) {
-	modulate=p_modulate;
+void TextureButton::set_stretch_mode(TextureButton::StretchMode p_mode) {
+	stretch_mode = p_mode;
 	update();
 }
 
-Color TextureButton::get_modulate() const {
-	return modulate;
+TextureButton::StretchMode TextureButton::get_stretch_mode() const {
+	return stretch_mode;
 }
 
 
 TextureButton::TextureButton() {
-	scale=Size2(1.0, 1.0);
 	modulate=Color(1,1,1);
+	resize_mode=RESIZE_SCALE;
+	scale=Size2(1.0, 1.0);
+	stretch_mode=STRETCH_SCALE_ON_EXPAND;
 }

scene/gui/texture_button.h

@@ -31,19 +31,38 @@
 
 #include "scene/gui/base_button.h"
 #include "scene/resources/bit_mask.h"
+
 class TextureButton : public BaseButton {
 
 	OBJ_TYPE( TextureButton, BaseButton );
+public:
+	enum ResizeMode {
+		RESIZE_SCALE, // for backwards compatibility
+		RESIZE_STRETCH,
+	};
+
+	enum StretchMode {
+		STRETCH_SCALE_ON_EXPAND, //default, for backwards compatibility
+		STRETCH_SCALE,
+		STRETCH_TILE,
+		STRETCH_KEEP,
+		STRETCH_KEEP_CENTERED,
+		STRETCH_KEEP_ASPECT,
+		STRETCH_KEEP_ASPECT_CENTERED,
+		STRETCH_KEEP_ASPECT_COVERED,
+	};
 
+private:
 	Ref<Texture> normal;
 	Ref<Texture> pressed;
 	Ref<Texture> hover;
 	Ref<Texture> disabled;
 	Ref<Texture> focused;
 	Ref<BitMap> click_mask;
-	Size2 scale;
 	Color modulate;
-
+	ResizeMode resize_mode;
+	Size2 scale;
+	StretchMode stretch_mode;
 
 protected:
 
@@ -68,13 +87,21 @@ public:
 	Ref<Texture> get_focused_texture() const;
 	Ref<BitMap> get_click_mask() const;
 
+	void set_modulate(const Color& p_modulate);
+	Color get_modulate() const;
+
+	ResizeMode get_resize_mode() const;
+	void set_resize_mode(ResizeMode p_mode);
+
 	void set_texture_scale(Size2 p_scale);
 	Size2 get_texture_scale() const;
 
-	void set_modulate(const Color& p_modulate);
-	Color get_modulate() const;
+	void set_stretch_mode(StretchMode stretch_mode);
+	StretchMode get_stretch_mode() const;
 
 	TextureButton();
 };
 
+VARIANT_ENUM_CAST( TextureButton::ResizeMode );
+VARIANT_ENUM_CAST( TextureButton::StretchMode );
 #endif // TEXTURE_BUTTON_H

scene/gui/texture_frame.cpp

@@ -77,9 +77,19 @@ void TextureFrame::_notification(int p_what) {
 					ofs_y+=(size.height - tex_height)/2;
 				}
 
-				draw_texture_rect(texture,Rect2(ofs_x,ofs_y,tex_width,tex_height));
+				draw_texture_rect(texture,Rect2(ofs_x,ofs_y,tex_width,tex_height),false,modulate);
 			} break;
+			case STRETCH_KEEP_ASPECT_COVERED: {
 
+				Size2 size = get_size();
+				Size2 tex_size = texture->get_size();
+				Size2 scaleSize(size.width/tex_size.width, size.height/tex_size.height);
+				float scale = scaleSize.width > scaleSize.height? scaleSize.width : scaleSize.height;
+				Size2 scaledTexSize = tex_size * scale;
+				Point2 ofs = ((scaledTexSize - size) / scale).abs() / 2.0f;
+
+				draw_texture_rect_region(texture, Rect2(Point2(), size), Rect2(ofs, size/scale), modulate);
+			} break;
 		}
 
 	}
@@ -107,7 +117,7 @@ void TextureFrame::_bind_methods() {
 	ADD_PROPERTYNZ( PropertyInfo( Variant::OBJECT, "texture", PROPERTY_HINT_RESOURCE_TYPE, "Texture"), _SCS("set_texture"),_SCS("get_texture") );
 	ADD_PROPERTYNO( PropertyInfo( Variant::COLOR, "modulate"), _SCS("set_modulate"),_SCS("get_modulate") );
 	ADD_PROPERTYNZ( PropertyInfo( Variant::BOOL, "expand" ), _SCS("set_expand"),_SCS("has_expand") );
-	ADD_PROPERTYNO( PropertyInfo( Variant::INT, "stretch_mode",PROPERTY_HINT_ENUM,"Scale On Expand (Compat),Scale,Tile,Keep,Keep Centered,Keep Aspect,Keep Aspect Centered"), _SCS("set_stretch_mode"),_SCS("get_stretch_mode") );
+	ADD_PROPERTYNO( PropertyInfo( Variant::INT, "stretch_mode",PROPERTY_HINT_ENUM,"Scale On Expand (Compat),Scale,Tile,Keep,Keep Centered,Keep Aspect,Keep Aspect Centered,Keep Aspect Covered"), _SCS("set_stretch_mode"),_SCS("get_stretch_mode") );
 
 	BIND_CONSTANT( STRETCH_SCALE_ON_EXPAND );
 	BIND_CONSTANT( STRETCH_SCALE );
@@ -116,7 +126,7 @@ void TextureFrame::_bind_methods() {
 	BIND_CONSTANT( STRETCH_KEEP_CENTERED );
 	BIND_CONSTANT( STRETCH_KEEP_ASPECT );
 	BIND_CONSTANT( STRETCH_KEEP_ASPECT_CENTERED );
-
+	BIND_CONSTANT( STRETCH_KEEP_ASPECT_COVERED );
 }
 
 
@@ -181,5 +191,3 @@ TextureFrame::TextureFrame() {
 TextureFrame::~TextureFrame()
 {
 }
-
-

scene/gui/texture_frame.h

@@ -45,7 +45,7 @@ public:
 		STRETCH_KEEP_CENTERED,
 		STRETCH_KEEP_ASPECT,
 		STRETCH_KEEP_ASPECT_CENTERED,
-
+		STRETCH_KEEP_ASPECT_COVERED,
 	};
 private:
 	bool expand;