1/**************************************************************************/
2/* canvas_modulate.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef CANVAS_MODULATE_H
32#define CANVAS_MODULATE_H
33
34#include "scene/2d/node_2d.h"
35
36class CanvasModulate : public Node2D {
37 GDCLASS(CanvasModulate, Node2D);
38
39 Color color = Color(1, 1, 1, 1);
40
41 // CanvasModulate is in canvas-specific modulate group when both in canvas and visible in tree.
42 // Exactly one CanvasModulate in each such non-empty group is active.
43 bool is_in_canvas = false;
44 bool was_visible_in_tree = false; // Relevant only when in canvas.
45 bool is_active = false;
46
47 void _on_in_canvas_visibility_changed(bool p_new_visibility);
48
49protected:
50 void _notification(int p_what);
51 static void _bind_methods();
52
53public:
54 void set_color(const Color &p_color);
55 Color get_color() const;
56
57 PackedStringArray get_configuration_warnings() const override;
58
59 CanvasModulate();
60 ~CanvasModulate();
61};
62
63#endif // CANVAS_MODULATE_H
64