mirror of
https://github.com/godotengine/godot.git
synced 2024-11-25 05:33:11 +00:00
1426cd3b3a
As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see". Backported from #70885.
266 lines
8.1 KiB
C++
266 lines
8.1 KiB
C++
/**************************************************************************/
|
|
/* style_box.h */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* 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/resource.h"
|
|
#include "scene/resources/texture.h"
|
|
#include "servers/visual_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(Margin p_margin) const = 0;
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
virtual bool test_mask(const Point2 &p_point, const Rect2 &p_rect) const;
|
|
|
|
void set_default_margin(Margin p_margin, float p_value);
|
|
float get_default_margin(Margin p_margin) const;
|
|
float get_margin(Margin p_margin) 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 = 0;
|
|
|
|
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(Margin p_margin) const { return 0; }
|
|
|
|
public:
|
|
virtual void draw(RID p_canvas_item, const Rect2 &p_rect) const {}
|
|
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<Texture> texture;
|
|
Ref<Texture> normal_map;
|
|
bool draw_center;
|
|
Color modulate;
|
|
AxisStretchMode axis_h;
|
|
AxisStretchMode axis_v;
|
|
|
|
protected:
|
|
virtual float get_style_margin(Margin p_margin) const;
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
void set_expand_margin_size(Margin p_expand_margin, 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(Margin p_expand_margin) const;
|
|
|
|
void set_margin_size(Margin p_margin, float p_size);
|
|
float get_margin_size(Margin p_margin) const;
|
|
|
|
void set_region_rect(const Rect2 &p_region_rect);
|
|
Rect2 get_region_rect() const;
|
|
|
|
void set_texture(Ref<Texture> p_texture);
|
|
Ref<Texture> get_texture() const;
|
|
|
|
void set_normal_map(Ref<Texture> p_normal_map);
|
|
Ref<Texture> get_normal_map() const;
|
|
|
|
void set_draw_center(bool p_enabled);
|
|
bool is_draw_center_enabled() const;
|
|
virtual Size2 get_center_size() const;
|
|
|
|
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;
|
|
virtual void draw(RID p_canvas_item, const Rect2 &p_rect) const;
|
|
|
|
StyleBoxTexture();
|
|
~StyleBoxTexture();
|
|
};
|
|
|
|
VARIANT_ENUM_CAST(StyleBoxTexture::AxisStretchMode)
|
|
|
|
class StyleBoxFlat : public StyleBox {
|
|
GDCLASS(StyleBoxFlat, StyleBox);
|
|
|
|
Color bg_color;
|
|
Color shadow_color;
|
|
Color border_color;
|
|
|
|
real_t border_width[4] = {};
|
|
real_t expand_margin[4] = {};
|
|
real_t corner_radius[4] = {};
|
|
|
|
bool draw_center;
|
|
bool blend_border;
|
|
Vector2 skew;
|
|
bool anti_aliased;
|
|
|
|
int corner_detail;
|
|
int shadow_size;
|
|
Point2 shadow_offset;
|
|
real_t aa_size;
|
|
|
|
protected:
|
|
virtual float get_style_margin(Margin p_margin) const;
|
|
static void _bind_methods();
|
|
|
|
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(Margin p_margin, int p_width);
|
|
int get_border_width(Margin p_margin) 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);
|
|
int get_corner_radius_min() const;
|
|
|
|
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(Margin p_expand_margin, 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(Margin p_expand_margin) const;
|
|
|
|
void set_draw_center(bool p_enabled);
|
|
bool is_draw_center_enabled() const;
|
|
|
|
void set_skew(Vector2 p_skew);
|
|
Vector2 get_skew() 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 float &p_aa_size);
|
|
float get_aa_size() 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;
|
|
|
|
StyleBoxFlat();
|
|
~StyleBoxFlat();
|
|
};
|
|
|
|
// Just used to draw lines.
|
|
class StyleBoxLine : public StyleBox {
|
|
GDCLASS(StyleBoxLine, StyleBox);
|
|
Color color;
|
|
int thickness;
|
|
bool vertical;
|
|
float grow_begin;
|
|
float grow_end;
|
|
|
|
protected:
|
|
virtual float get_style_margin(Margin p_margin) const;
|
|
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;
|
|
|
|
virtual void draw(RID p_canvas_item, const Rect2 &p_rect) const;
|
|
|
|
StyleBoxLine();
|
|
~StyleBoxLine();
|
|
};
|
|
|
|
#endif // STYLE_BOX_H
|