6f51eca1e3
* Previous "virtual" classes (which can't be instantiated) are not corretly named "abstract". * Added a new "virtual" category for classes, they can't be instantiated from the editor, but can be inherited from script and extensions. * Converted a large amount of classes from "abstract" to "virtual" where it makes sense. Most classes that make sense have been converted. Missing: * Physics servers * VideoStream * Script* classes. which will go in a separate PR due to the complexity involved.
264 lines
8.4 KiB
C++
264 lines
8.4 KiB
C++
/*************************************************************************/
|
|
/* style_box.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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 STYLE_BOX_H
|
|
#define STYLE_BOX_H
|
|
|
|
#include "core/io/resource.h"
|
|
#include "scene/resources/texture.h"
|
|
#include "servers/rendering_server.h"
|
|
|
|
class CanvasItem;
|
|
|
|
class StyleBox : public Resource {
|
|
GDCLASS(StyleBox, Resource);
|
|
RES_BASE_EXTENSION("stylebox");
|
|
OBJ_SAVE_TYPE(StyleBox);
|
|
float margin[4];
|
|
|
|
protected:
|
|
virtual float get_style_margin(Side p_side) const;
|
|
static void _bind_methods();
|
|
|
|
GDVIRTUAL1RC(float, _get_style_margin, Side)
|
|
GDVIRTUAL2RC(bool, _test_mask, Point2, Rect2)
|
|
GDVIRTUAL0RC(Size2, _get_center_size)
|
|
GDVIRTUAL1RC(Rect2, _get_draw_rect, Rect2)
|
|
GDVIRTUAL2C(_draw, RID, Rect2)
|
|
|
|
public:
|
|
virtual bool test_mask(const Point2 &p_point, const Rect2 &p_rect) const;
|
|
|
|
void set_default_margin(Side p_side, float p_value);
|
|
float get_default_margin(Side p_side) const;
|
|
float get_margin(Side p_side) const;
|
|
virtual Size2 get_center_size() const;
|
|
|
|
virtual Rect2 get_draw_rect(const Rect2 &p_rect) const;
|
|
virtual void draw(RID p_canvas_item, const Rect2 &p_rect) const;
|
|
|
|
CanvasItem *get_current_item_drawn() const;
|
|
|
|
Size2 get_minimum_size() const;
|
|
Point2 get_offset() const;
|
|
|
|
StyleBox();
|
|
};
|
|
|
|
class StyleBoxEmpty : public StyleBox {
|
|
GDCLASS(StyleBoxEmpty, StyleBox);
|
|
virtual float get_style_margin(Side p_side) const override { return 0; }
|
|
|
|
public:
|
|
virtual void draw(RID p_canvas_item, const Rect2 &p_rect) const override {}
|
|
StyleBoxEmpty() {}
|
|
};
|
|
|
|
class StyleBoxTexture : public StyleBox {
|
|
GDCLASS(StyleBoxTexture, StyleBox);
|
|
|
|
public:
|
|
enum AxisStretchMode {
|
|
AXIS_STRETCH_MODE_STRETCH,
|
|
AXIS_STRETCH_MODE_TILE,
|
|
AXIS_STRETCH_MODE_TILE_FIT,
|
|
};
|
|
|
|
private:
|
|
float expand_margin[4] = {};
|
|
float margin[4] = {};
|
|
Rect2 region_rect;
|
|
Ref<Texture2D> texture;
|
|
bool draw_center = true;
|
|
Color modulate = Color(1, 1, 1, 1);
|
|
AxisStretchMode axis_h = AXIS_STRETCH_MODE_STRETCH;
|
|
AxisStretchMode axis_v = AXIS_STRETCH_MODE_STRETCH;
|
|
|
|
protected:
|
|
virtual float get_style_margin(Side p_side) const override;
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
void set_expand_margin_size(Side p_expand_side, float p_size);
|
|
void set_expand_margin_size_all(float p_expand_margin_size);
|
|
void set_expand_margin_size_individual(float p_left, float p_top, float p_right, float p_bottom);
|
|
float get_expand_margin_size(Side p_expand_side) const;
|
|
|
|
void set_margin_size(Side p_side, float p_size);
|
|
float get_margin_size(Side p_side) const;
|
|
|
|
void set_region_rect(const Rect2 &p_region_rect);
|
|
Rect2 get_region_rect() const;
|
|
|
|
void set_texture(Ref<Texture2D> p_texture);
|
|
Ref<Texture2D> get_texture() const;
|
|
|
|
void set_draw_center(bool p_enabled);
|
|
bool is_draw_center_enabled() const;
|
|
virtual Size2 get_center_size() const override;
|
|
|
|
void set_h_axis_stretch_mode(AxisStretchMode p_mode);
|
|
AxisStretchMode get_h_axis_stretch_mode() const;
|
|
|
|
void set_v_axis_stretch_mode(AxisStretchMode p_mode);
|
|
AxisStretchMode get_v_axis_stretch_mode() const;
|
|
|
|
void set_modulate(const Color &p_modulate);
|
|
Color get_modulate() const;
|
|
|
|
virtual Rect2 get_draw_rect(const Rect2 &p_rect) const override;
|
|
virtual void draw(RID p_canvas_item, const Rect2 &p_rect) const override;
|
|
|
|
StyleBoxTexture();
|
|
~StyleBoxTexture();
|
|
};
|
|
|
|
VARIANT_ENUM_CAST(StyleBoxTexture::AxisStretchMode)
|
|
|
|
class StyleBoxFlat : public StyleBox {
|
|
GDCLASS(StyleBoxFlat, StyleBox);
|
|
|
|
Color bg_color = Color(0.6, 0.6, 0.6);
|
|
Color shadow_color = Color(0, 0, 0, 0.6);
|
|
Color border_color = Color(0.8, 0.8, 0.8);
|
|
|
|
real_t border_width[4] = {};
|
|
real_t expand_margin[4] = {};
|
|
real_t corner_radius[4] = {};
|
|
|
|
bool draw_center = true;
|
|
bool blend_border = false;
|
|
bool anti_aliased = true;
|
|
|
|
int corner_detail = 8;
|
|
int shadow_size = 0;
|
|
Point2 shadow_offset;
|
|
real_t aa_size = 0.625;
|
|
|
|
protected:
|
|
virtual float get_style_margin(Side p_side) const override;
|
|
static void _bind_methods();
|
|
void _validate_property(PropertyInfo &property) const override;
|
|
|
|
public:
|
|
void set_bg_color(const Color &p_color);
|
|
Color get_bg_color() const;
|
|
|
|
void set_border_color(const Color &p_color);
|
|
Color get_border_color() const;
|
|
|
|
void set_border_width_all(int p_size);
|
|
int get_border_width_min() const;
|
|
|
|
void set_border_width(Side p_side, int p_width);
|
|
int get_border_width(Side p_side) const;
|
|
|
|
void set_border_blend(bool p_blend);
|
|
bool get_border_blend() const;
|
|
|
|
void set_corner_radius_all(int radius);
|
|
void set_corner_radius_individual(const int radius_top_left, const int radius_top_right, const int radius_bottom_right, const int radius_bottom_left);
|
|
|
|
void set_corner_radius(Corner p_corner, const int radius);
|
|
int get_corner_radius(Corner p_corner) const;
|
|
|
|
void set_corner_detail(const int &p_corner_detail);
|
|
int get_corner_detail() const;
|
|
|
|
void set_expand_margin_size(Side p_expand_side, float p_size);
|
|
void set_expand_margin_size_all(float p_expand_margin_size);
|
|
void set_expand_margin_size_individual(float p_left, float p_top, float p_right, float p_bottom);
|
|
float get_expand_margin_size(Side p_expand_side) const;
|
|
|
|
void set_draw_center(bool p_enabled);
|
|
bool is_draw_center_enabled() const;
|
|
|
|
void set_shadow_color(const Color &p_color);
|
|
Color get_shadow_color() const;
|
|
|
|
void set_shadow_size(const int &p_size);
|
|
int get_shadow_size() const;
|
|
|
|
void set_shadow_offset(const Point2 &p_offset);
|
|
Point2 get_shadow_offset() const;
|
|
|
|
void set_anti_aliased(const bool &p_anti_aliased);
|
|
bool is_anti_aliased() const;
|
|
void set_aa_size(const real_t p_aa_size);
|
|
real_t get_aa_size() const;
|
|
|
|
virtual Size2 get_center_size() const override;
|
|
|
|
virtual Rect2 get_draw_rect(const Rect2 &p_rect) const override;
|
|
virtual void draw(RID p_canvas_item, const Rect2 &p_rect) const override;
|
|
|
|
StyleBoxFlat();
|
|
~StyleBoxFlat();
|
|
};
|
|
|
|
// Just used to draw lines.
|
|
class StyleBoxLine : public StyleBox {
|
|
GDCLASS(StyleBoxLine, StyleBox);
|
|
Color color;
|
|
int thickness = 1;
|
|
bool vertical = false;
|
|
float grow_begin = 1.0;
|
|
float grow_end = 1.0;
|
|
|
|
protected:
|
|
virtual float get_style_margin(Side p_side) const override;
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
void set_color(const Color &p_color);
|
|
Color get_color() const;
|
|
|
|
void set_thickness(int p_thickness);
|
|
int get_thickness() const;
|
|
|
|
void set_vertical(bool p_vertical);
|
|
bool is_vertical() const;
|
|
|
|
void set_grow_begin(float p_grow);
|
|
float get_grow_begin() const;
|
|
|
|
void set_grow_end(float p_grow);
|
|
float get_grow_end() const;
|
|
|
|
virtual Size2 get_center_size() const override;
|
|
|
|
virtual void draw(RID p_canvas_item, const Rect2 &p_rect) const override;
|
|
|
|
StyleBoxLine();
|
|
~StyleBoxLine();
|
|
};
|
|
|
|
#endif
|