1 /*************************************************************************/
2 /*  parallax_background.h                                                */
3 /*************************************************************************/
4 /*                       This file is part of:                           */
5 /*                           GODOT ENGINE                                */
6 /*                      https://godotengine.org                          */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur.                 */
9 /* Copyright (c) 2014-2019 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 #ifndef PARALLAX_BACKGROUND_H
31 #define PARALLAX_BACKGROUND_H
32 
33 #include "scene/2d/camera_2d.h"
34 #include "scene/2d/node_2d.h"
35 #include "scene/main/canvas_layer.h"
36 
37 class ParallaxBackground : public CanvasLayer {
38 
39 	OBJ_TYPE(ParallaxBackground, CanvasLayer);
40 
41 	Point2 offset;
42 	float scale;
43 	Point2 base_offset;
44 	Point2 base_scale;
45 	String group_name;
46 	Point2 limit_begin;
47 	Point2 limit_end;
48 	Point2 final_offset;
49 	bool ignore_camera_zoom;
50 
51 	void _update_scroll();
52 
53 protected:
54 	void _camera_moved(const Matrix32 &p_transform);
55 
56 	void _notification(int p_what);
57 	static void _bind_methods();
58 
59 public:
60 	void set_scroll_offset(const Point2 &p_ofs);
61 	Point2 get_scroll_offset() const;
62 
63 	void set_scroll_scale(float p_ofs);
64 	float get_scroll_scale() const;
65 
66 	void set_scroll_base_offset(const Point2 &p_ofs);
67 	Point2 get_scroll_base_offset() const;
68 
69 	void set_scroll_base_scale(const Point2 &p_ofs);
70 	Point2 get_scroll_base_scale() const;
71 
72 	void set_limit_begin(const Point2 &p_ofs);
73 	Point2 get_limit_begin() const;
74 
75 	void set_limit_end(const Point2 &p_ofs);
76 	Point2 get_limit_end() const;
77 
78 	void set_ignore_camera_zoom(bool ignore);
79 	bool is_ignore_camera_zoom();
80 
81 	Vector2 get_final_offset() const;
82 
83 	ParallaxBackground();
84 };
85 
86 #endif // PARALLAX_BACKGROUND_H
87