godot/scene/2d/camera_2d.h
Rémi Verschelde 1426cd3b3a
One Copyright Update to rule them all
As many open source projects have started doing it, we're removing the
current year from the copyright notice, so that we don't need to bump
it every year.

It seems like only the first year of publication is technically
relevant for copyright notices, and even that seems to be something
that many companies stopped listing altogether (in a version controlled
codebase, the commits are a much better source of date of publication
than a hardcoded copyright statement).

We also now list Godot Engine contributors first as we're collectively
the current maintainers of the project, and we clarify that the
"exclusive" copyright of the co-founders covers the timespan before
opensourcing (their further contributions are included as part of Godot
Engine contributors).

Also fixed "cf." Frenchism - it's meant as "refer to / see".

Backported from .
2023-01-10 15:26:54 +01:00

175 lines
5.4 KiB
C++

/**************************************************************************/
/* camera_2d.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
#ifndef CAMERA_2D_H
#define CAMERA_2D_H
#include "scene/2d/node_2d.h"
#include "scene/main/viewport.h"
class Camera2D : public Node2D {
GDCLASS(Camera2D, Node2D);
public:
enum AnchorMode {
ANCHOR_MODE_FIXED_TOP_LEFT,
ANCHOR_MODE_DRAG_CENTER
};
enum Camera2DProcessMode {
CAMERA2D_PROCESS_PHYSICS,
CAMERA2D_PROCESS_IDLE
};
protected:
Point2 camera_pos;
Point2 smoothed_camera_pos;
bool first;
ObjectID custom_viewport_id; // to check validity
Viewport *custom_viewport;
Viewport *viewport;
StringName group_name;
StringName canvas_group_name;
RID canvas;
Vector2 offset;
Vector2 zoom;
AnchorMode anchor_mode;
bool rotating;
bool current;
float smoothing;
bool smoothing_enabled;
bool smoothing_active; // smoothing can be enabled but not active in the editor
int limit[4];
bool limit_smoothing_enabled;
float drag_margin[4];
bool h_drag_enabled;
bool v_drag_enabled;
float h_ofs;
float v_ofs;
bool h_offset_changed;
bool v_offset_changed;
Point2 camera_screen_center;
void _update_process_mode();
void _update_scroll();
void _setup_viewport();
void _make_current(Object *p_which);
void _set_current(bool p_current);
bool screen_drawing_enabled;
bool limit_drawing_enabled;
bool margin_drawing_enabled;
Camera2DProcessMode process_mode;
protected:
virtual Transform2D get_camera_transform();
void _notification(int p_what);
static void _bind_methods();
public:
void set_offset(const Vector2 &p_offset);
Vector2 get_offset() const;
void set_anchor_mode(AnchorMode p_anchor_mode);
AnchorMode get_anchor_mode() const;
void set_rotating(bool p_rotating);
bool is_rotating() const;
void set_limit(Margin p_margin, int p_limit);
int get_limit(Margin p_margin) const;
void set_limit_smoothing_enabled(bool enable);
bool is_limit_smoothing_enabled() const;
void set_h_drag_enabled(bool p_enabled);
bool is_h_drag_enabled() const;
void set_v_drag_enabled(bool p_enabled);
bool is_v_drag_enabled() const;
void set_drag_margin(Margin p_margin, float p_drag_margin);
float get_drag_margin(Margin p_margin) const;
void set_v_offset(float p_offset);
float get_v_offset() const;
void set_h_offset(float p_offset);
float get_h_offset() const;
void set_enable_follow_smoothing(bool p_enabled);
bool is_follow_smoothing_enabled() const;
void set_follow_smoothing(float p_speed);
float get_follow_smoothing() const;
void set_process_mode(Camera2DProcessMode p_mode);
Camera2DProcessMode get_process_mode() const;
void make_current();
void clear_current();
bool is_current() const;
void set_zoom(const Vector2 &p_zoom);
Vector2 get_zoom() const;
Point2 get_camera_screen_center() const;
void set_custom_viewport(Node *p_viewport);
Node *get_custom_viewport() const;
Vector2 get_camera_position() const;
void force_update_scroll();
void reset_smoothing();
void align();
void set_screen_drawing_enabled(bool enable);
bool is_screen_drawing_enabled() const;
void set_limit_drawing_enabled(bool enable);
bool is_limit_drawing_enabled() const;
void set_margin_drawing_enabled(bool enable);
bool is_margin_drawing_enabled() const;
Camera2D();
};
VARIANT_ENUM_CAST(Camera2D::AnchorMode);
VARIANT_ENUM_CAST(Camera2D::Camera2DProcessMode);
#endif // CAMERA_2D_H