parallax_background.h
1 /*************************************************************************/
2 /* parallax_background.h */
3 /*************************************************************************/
4 /* This file is part of: */
5 /* GODOT ENGINE */
6 /* http://www.godotengine.org */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2016 Juan Linietsky, Ariel Manzur. */
9 /* */
10 /* Permission is hereby granted, free of charge, to any person obtaining */
11 /* a copy of this software and associated documentation files (the */
12 /* "Software"), to deal in the Software without restriction, including */
13 /* without limitation the rights to use, copy, modify, merge, publish, */
14 /* distribute, sublicense, and/or sell copies of the Software, and to */
15 /* permit persons to whom the Software is furnished to do so, subject to */
16 /* the following conditions: */
17 /* */
18 /* The above copyright notice and this permission notice shall be */
19 /* included in all copies or substantial portions of the Software. */
20 /* */
21 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
22 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
23 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
24 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
25 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
26 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
27 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
28 /*************************************************************************/
29 #ifndef PARALLAX_BACKGROUND_H
30 #define PARALLAX_BACKGROUND_H
31 
32 #include "scene/main/canvas_layer.h"
33 #include "scene/2d/node_2d.h"
34 #include "scene/2d/camera_2d.h"
35 
37 
38  OBJ_TYPE( ParallaxBackground, CanvasLayer );
39 
40  Point2 offset;
41  float scale;
42  Point2 base_offset;
43  Point2 base_scale;
44  String group_name;
45  Point2 limit_begin;
46  Point2 limit_end;
47  bool ignore_camera_zoom;
48 
49  void _update_scroll();
50 protected:
51 
52  void _camera_moved(const Matrix32& p_transform);
53 
54  void _notification(int p_what);
55  static void _bind_methods();
56 public:
57 
58  void set_scroll_offset(const Point2& p_ofs);
59  Point2 get_scroll_offset() const;
60 
61  void set_scroll_scale(float p_ofs);
62  float get_scroll_scale() const;
63 
64  void set_scroll_base_offset(const Point2& p_ofs);
65  Point2 get_scroll_base_offset() const;
66 
67  void set_scroll_base_scale(const Point2& p_ofs);
68  Point2 get_scroll_base_scale() const;
69 
70  void set_limit_begin(const Point2& p_ofs);
71  Point2 get_limit_begin() const;
72 
73  void set_limit_end(const Point2& p_ofs);
74  Point2 get_limit_end() const;
75 
76  void set_ignore_camera_zoom(bool ignore);
77  bool is_ignore_camera_zoom();
78 
80 };
81 
82 #endif // PARALLAX_BACKGROUND_H
Definition: canvas_layer.h:37
Definition: math_2d.h:65
Definition: math_2d.h:554
Definition: ustring.h:64
Definition: parallax_background.h:36