1/**************************************************************************/
2/* parallax_background.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 PARALLAX_BACKGROUND_H
32#define PARALLAX_BACKGROUND_H
33
34#include "scene/main/canvas_layer.h"
35
36class ParallaxBackground : public CanvasLayer {
37 GDCLASS(ParallaxBackground, CanvasLayer);
38
39 Point2 offset;
40 real_t scale = 1.0;
41 Point2 base_offset;
42 Point2 base_scale = Vector2(1, 1);
43 Point2 screen_offset;
44 String group_name;
45 Point2 limit_begin;
46 Point2 limit_end;
47 Point2 final_offset;
48 bool ignore_camera_zoom = false;
49
50 void _update_scroll();
51
52protected:
53 void _camera_moved(const Transform2D &p_transform, const Point2 &p_screen_offset);
54
55 void _notification(int p_what);
56 static void _bind_methods();
57
58public:
59 void set_scroll_offset(const Point2 &p_ofs);
60 Point2 get_scroll_offset() const;
61
62 void set_scroll_scale(real_t p_scale);
63 real_t get_scroll_scale() const;
64
65 void set_scroll_base_offset(const Point2 &p_ofs);
66 Point2 get_scroll_base_offset() const;
67
68 void set_scroll_base_scale(const Point2 &p_ofs);
69 Point2 get_scroll_base_scale() const;
70
71 void set_limit_begin(const Point2 &p_ofs);
72 Point2 get_limit_begin() const;
73
74 void set_limit_end(const Point2 &p_ofs);
75 Point2 get_limit_end() const;
76
77 void set_ignore_camera_zoom(bool ignore);
78 bool is_ignore_camera_zoom();
79
80 Vector2 get_final_offset() const;
81
82 ParallaxBackground();
83};
84
85#endif // PARALLAX_BACKGROUND_H
86