1 /*************************************************************************/
2 /*  visibility_notifier.h                                                */
3 /*************************************************************************/
4 /*                       This file is part of:                           */
5 /*                           GODOT ENGINE                                */
6 /*                      https://godotengine.org                          */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur.                 */
9 /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md).   */
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 VISIBILITY_NOTIFIER_H
32 #define VISIBILITY_NOTIFIER_H
33 
34 #include "scene/3d/spatial.h"
35 
36 class Camera;
37 class VisibilityNotifier : public Spatial {
38 
39 	GDCLASS(VisibilityNotifier, Spatial);
40 
41 	Set<Camera *> cameras;
42 
43 	AABB aabb;
44 
45 protected:
_screen_enter()46 	virtual void _screen_enter() {}
_screen_exit()47 	virtual void _screen_exit() {}
48 
49 	void _notification(int p_what);
50 	static void _bind_methods();
51 	friend struct SpatialIndexer;
52 
53 	void _enter_camera(Camera *p_camera);
54 	void _exit_camera(Camera *p_camera);
55 
56 public:
57 	void set_aabb(const AABB &p_aabb);
58 	AABB get_aabb() const;
59 	bool is_on_screen() const;
60 
61 	VisibilityNotifier();
62 };
63 
64 class VisibilityEnabler : public VisibilityNotifier {
65 
66 	GDCLASS(VisibilityEnabler, VisibilityNotifier);
67 
68 public:
69 	enum Enabler {
70 		ENABLER_PAUSE_ANIMATIONS,
71 		ENABLER_FREEZE_BODIES,
72 		ENABLER_MAX
73 	};
74 
75 protected:
76 	virtual void _screen_enter();
77 	virtual void _screen_exit();
78 
79 	bool visible;
80 
81 	void _find_nodes(Node *p_node);
82 
83 	Map<Node *, Variant> nodes;
84 	void _node_removed(Node *p_node);
85 	bool enabler[ENABLER_MAX];
86 
87 	void _change_node_state(Node *p_node, bool p_enabled);
88 
89 	void _notification(int p_what);
90 	static void _bind_methods();
91 
92 public:
93 	void set_enabler(Enabler p_enabler, bool p_enable);
94 	bool is_enabler_enabled(Enabler p_enabler) const;
95 
96 	VisibilityEnabler();
97 };
98 
99 VARIANT_ENUM_CAST(VisibilityEnabler::Enabler);
100 
101 #endif // VISIBILITY_NOTIFIER_H
102