godot/scene/2d/line_2d.h
Rémi Verschelde d95794ec8a
One Copyright Update to rule them all
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".
2023-01-05 13:25:55 +01:00

142 lines
4.6 KiB
C++

/**************************************************************************/
/* line_2d.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 LINE_2D_H
#define LINE_2D_H
#include "node_2d.h"
class Line2D : public Node2D {
GDCLASS(Line2D, Node2D);
public:
enum LineJointMode {
LINE_JOINT_SHARP = 0,
LINE_JOINT_BEVEL,
LINE_JOINT_ROUND
};
enum LineCapMode {
LINE_CAP_NONE = 0,
LINE_CAP_BOX,
LINE_CAP_ROUND
};
enum LineTextureMode {
LINE_TEXTURE_NONE = 0,
LINE_TEXTURE_TILE,
LINE_TEXTURE_STRETCH
};
#ifdef TOOLS_ENABLED
virtual Rect2 _edit_get_rect() const override;
virtual bool _edit_use_rect() const override;
virtual bool _edit_is_selected_on_click(const Point2 &p_point, double p_tolerance) const override;
#endif
Line2D();
void set_points(const Vector<Vector2> &p_points);
Vector<Vector2> get_points() const;
void set_point_position(int i, Vector2 pos);
Vector2 get_point_position(int i) const;
int get_point_count() const;
void clear_points();
void add_point(Vector2 pos, int atpos = -1);
void remove_point(int i);
void set_width(float width);
float get_width() const;
void set_curve(const Ref<Curve> &curve);
Ref<Curve> get_curve() const;
void set_default_color(Color color);
Color get_default_color() const;
void set_gradient(const Ref<Gradient> &gradient);
Ref<Gradient> get_gradient() const;
void set_texture(const Ref<Texture2D> &texture);
Ref<Texture2D> get_texture() const;
void set_texture_mode(const LineTextureMode mode);
LineTextureMode get_texture_mode() const;
void set_joint_mode(LineJointMode mode);
LineJointMode get_joint_mode() const;
void set_begin_cap_mode(LineCapMode mode);
LineCapMode get_begin_cap_mode() const;
void set_end_cap_mode(LineCapMode mode);
LineCapMode get_end_cap_mode() const;
void set_sharp_limit(float limit);
float get_sharp_limit() const;
void set_round_precision(int precision);
int get_round_precision() const;
void set_antialiased(bool p_antialiased);
bool get_antialiased() const;
protected:
void _notification(int p_what);
void _draw();
static void _bind_methods();
private:
void _gradient_changed();
void _curve_changed();
private:
Vector<Vector2> _points;
LineJointMode _joint_mode = LINE_JOINT_SHARP;
LineCapMode _begin_cap_mode = LINE_CAP_NONE;
LineCapMode _end_cap_mode = LINE_CAP_NONE;
float _width = 10.0;
Ref<Curve> _curve;
Color _default_color = Color(1, 1, 1);
Ref<Gradient> _gradient;
Ref<Texture2D> _texture;
LineTextureMode _texture_mode = LINE_TEXTURE_NONE;
float _sharp_limit = 2.f;
int _round_precision = 8;
bool _antialiased = false;
};
#endif // LINE_2D_H