2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* canvas_layer.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2021-01-01 20:13:46 +01:00
|
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
2014-02-10 02:10:30 +01: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. */
|
|
|
|
/*************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#ifndef CANVAS_LAYER_H
|
|
|
|
#define CANVAS_LAYER_H
|
|
|
|
|
|
|
|
#include "scene/main/node.h"
|
|
|
|
#include "scene/resources/world_2d.h"
|
|
|
|
|
|
|
|
class Viewport;
|
|
|
|
class CanvasLayer : public Node {
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(CanvasLayer, Node);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-02-09 18:24:36 +01:00
|
|
|
bool locrotscale_dirty = false;
|
2014-02-10 02:10:30 +01:00
|
|
|
Vector2 ofs;
|
2021-02-09 18:24:36 +01:00
|
|
|
Size2 scale = Vector2(1, 1);
|
|
|
|
real_t rot = 0.0;
|
|
|
|
int layer = 1;
|
2017-01-11 04:52:51 +01:00
|
|
|
Transform2D transform;
|
2018-04-08 00:42:11 +02:00
|
|
|
RID canvas;
|
2016-09-14 20:55:14 +02:00
|
|
|
|
|
|
|
ObjectID custom_viewport_id; // to check validity
|
2021-02-09 18:24:36 +01:00
|
|
|
Viewport *custom_viewport = nullptr;
|
2016-09-14 20:55:14 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
RID viewport;
|
2021-02-09 18:24:36 +01:00
|
|
|
Viewport *vp = nullptr;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-02-09 18:24:36 +01:00
|
|
|
int sort_index = 0;
|
2016-10-03 21:33:42 +02:00
|
|
|
|
2021-02-09 18:24:36 +01:00
|
|
|
bool follow_viewport = false;
|
|
|
|
float follow_viewport_scale = 1.0;
|
2019-04-05 15:24:54 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
void _update_xform();
|
|
|
|
void _update_locrotscale();
|
2019-04-05 15:24:54 +02:00
|
|
|
void _update_follow_viewport(bool p_force_exit = false);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
protected:
|
|
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2014-02-10 02:10:30 +01:00
|
|
|
void set_layer(int p_xform);
|
|
|
|
int get_layer() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_transform(const Transform2D &p_xform);
|
2017-01-11 04:52:51 +01:00
|
|
|
Transform2D get_transform() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_offset(const Vector2 &p_offset);
|
2014-02-10 02:10:30 +01:00
|
|
|
Vector2 get_offset() const;
|
|
|
|
|
2016-05-06 23:38:08 +02:00
|
|
|
void set_rotation(real_t p_radians);
|
2014-02-10 02:10:30 +01:00
|
|
|
real_t get_rotation() const;
|
|
|
|
|
2017-11-10 11:07:52 +01:00
|
|
|
void set_rotation_degrees(real_t p_degrees);
|
|
|
|
real_t get_rotation_degrees() const;
|
2016-05-06 23:38:08 +02:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_scale(const Size2 &p_scale);
|
2016-09-20 06:36:24 +02:00
|
|
|
Size2 get_scale() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
Size2 get_viewport_size() const;
|
|
|
|
|
|
|
|
RID get_viewport() const;
|
|
|
|
|
2016-09-14 20:55:14 +02:00
|
|
|
void set_custom_viewport(Node *p_viewport);
|
2017-03-05 16:44:50 +01:00
|
|
|
Node *get_custom_viewport() const;
|
2016-09-14 20:55:14 +02:00
|
|
|
|
2016-10-03 21:33:42 +02:00
|
|
|
void reset_sort_index();
|
|
|
|
int get_sort_index();
|
|
|
|
|
2019-04-05 15:24:54 +02:00
|
|
|
void set_follow_viewport(bool p_enable);
|
|
|
|
bool is_following_viewport() const;
|
|
|
|
|
|
|
|
void set_follow_viewport_scale(float p_ratio);
|
|
|
|
float get_follow_viewport_scale() const;
|
|
|
|
|
2018-04-08 00:42:11 +02:00
|
|
|
RID get_canvas() const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
CanvasLayer();
|
2018-04-08 00:42:11 +02:00
|
|
|
~CanvasLayer();
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // CANVAS_LAYER_H
|