1 /*************************************************************************/
2 /*  listener.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 LISTENER_H
32 #define LISTENER_H
33 
34 #include "scene/3d/spatial.h"
35 #include "scene/main/viewport.h"
36 
37 class Listener : public Spatial {
38 
39 	GDCLASS(Listener, Spatial);
40 
41 private:
42 	bool force_change;
43 	bool current;
44 
45 	RID scenario_id;
46 
47 	virtual bool _can_gizmo_scale() const;
48 	virtual RES _get_gizmo_geometry() const;
49 
50 	friend class Viewport;
51 	void _update_audio_listener_state();
52 
53 protected:
54 	void _update_listener();
55 	virtual void _request_listener_update();
56 
57 	bool _set(const StringName &p_name, const Variant &p_value);
58 	bool _get(const StringName &p_name, Variant &r_ret) const;
59 	void _get_property_list(List<PropertyInfo> *p_list) const;
60 	void _notification(int p_what);
61 
62 	static void _bind_methods();
63 
64 public:
65 	void make_current();
66 	void clear_current();
67 	bool is_current() const;
68 
69 	virtual Transform get_listener_transform() const;
70 
71 	void set_visible_layers(uint32_t p_layers);
72 	uint32_t get_visible_layers() const;
73 
74 	Listener();
75 	~Listener();
76 };
77 
78 #endif
79