d95794ec8a
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".
190 lines
6.2 KiB
C++
190 lines
6.2 KiB
C++
/**************************************************************************/
|
|
/* camera_3d.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_3D_H
|
|
#define CAMERA_3D_H
|
|
|
|
#include "scene/3d/node_3d.h"
|
|
#include "scene/3d/velocity_tracker_3d.h"
|
|
#include "scene/resources/camera_attributes.h"
|
|
#include "scene/resources/environment.h"
|
|
|
|
class Camera3D : public Node3D {
|
|
GDCLASS(Camera3D, Node3D);
|
|
|
|
public:
|
|
enum ProjectionType {
|
|
PROJECTION_PERSPECTIVE,
|
|
PROJECTION_ORTHOGONAL,
|
|
PROJECTION_FRUSTUM
|
|
};
|
|
|
|
enum KeepAspect {
|
|
KEEP_WIDTH,
|
|
KEEP_HEIGHT
|
|
};
|
|
|
|
enum DopplerTracking {
|
|
DOPPLER_TRACKING_DISABLED,
|
|
DOPPLER_TRACKING_IDLE_STEP,
|
|
DOPPLER_TRACKING_PHYSICS_STEP
|
|
};
|
|
|
|
private:
|
|
bool force_change = false;
|
|
bool current = false;
|
|
Viewport *viewport = nullptr;
|
|
|
|
ProjectionType mode = PROJECTION_PERSPECTIVE;
|
|
|
|
real_t fov = 75.0;
|
|
real_t size = 1.0;
|
|
Vector2 frustum_offset;
|
|
real_t near = 0.05;
|
|
real_t far = 4000.0;
|
|
real_t v_offset = 0.0;
|
|
real_t h_offset = 0.0;
|
|
KeepAspect keep_aspect = KEEP_HEIGHT;
|
|
|
|
RID camera;
|
|
RID scenario_id;
|
|
|
|
// String camera_group;
|
|
|
|
uint32_t layers = 0xfffff;
|
|
|
|
Ref<Environment> environment;
|
|
Ref<CameraAttributes> attributes;
|
|
void _attributes_changed();
|
|
|
|
// void _camera_make_current(Node *p_camera);
|
|
friend class Viewport;
|
|
void _update_audio_listener_state();
|
|
TypedArray<Plane> _get_frustum() const;
|
|
|
|
DopplerTracking doppler_tracking = DOPPLER_TRACKING_DISABLED;
|
|
Ref<VelocityTracker3D> velocity_tracker;
|
|
|
|
RID pyramid_shape;
|
|
Vector<Vector3> pyramid_shape_points;
|
|
|
|
protected:
|
|
void _update_camera();
|
|
virtual void _request_camera_update();
|
|
void _update_camera_mode();
|
|
|
|
void _notification(int p_what);
|
|
void _validate_property(PropertyInfo &p_property) const;
|
|
|
|
static void _bind_methods();
|
|
|
|
public:
|
|
enum {
|
|
NOTIFICATION_BECAME_CURRENT = 50,
|
|
NOTIFICATION_LOST_CURRENT = 51
|
|
};
|
|
|
|
void set_perspective(real_t p_fovy_degrees, real_t p_z_near, real_t p_z_far);
|
|
void set_orthogonal(real_t p_size, real_t p_z_near, real_t p_z_far);
|
|
void set_frustum(real_t p_size, Vector2 p_offset, real_t p_z_near, real_t p_z_far);
|
|
void set_projection(Camera3D::ProjectionType p_mode);
|
|
|
|
void make_current();
|
|
void clear_current(bool p_enable_next = true);
|
|
void set_current(bool p_enabled);
|
|
bool is_current() const;
|
|
|
|
RID get_camera() const;
|
|
|
|
real_t get_fov() const;
|
|
real_t get_size() const;
|
|
real_t get_far() const;
|
|
real_t get_near() const;
|
|
Vector2 get_frustum_offset() const;
|
|
|
|
ProjectionType get_projection() const;
|
|
|
|
void set_fov(real_t p_fov);
|
|
void set_size(real_t p_size);
|
|
void set_far(real_t p_far);
|
|
void set_near(real_t p_near);
|
|
void set_frustum_offset(Vector2 p_offset);
|
|
|
|
virtual Transform3D get_camera_transform() const;
|
|
|
|
virtual Vector3 project_ray_normal(const Point2 &p_pos) const;
|
|
virtual Vector3 project_ray_origin(const Point2 &p_pos) const;
|
|
virtual Vector3 project_local_ray_normal(const Point2 &p_pos) const;
|
|
virtual Point2 unproject_position(const Vector3 &p_pos) const;
|
|
bool is_position_behind(const Vector3 &p_pos) const;
|
|
virtual Vector3 project_position(const Point2 &p_point, real_t p_z_depth) const;
|
|
|
|
Vector<Vector3> get_near_plane_points() const;
|
|
|
|
void set_cull_mask(uint32_t p_layers);
|
|
uint32_t get_cull_mask() const;
|
|
|
|
void set_cull_mask_value(int p_layer_number, bool p_enable);
|
|
bool get_cull_mask_value(int p_layer_number) const;
|
|
|
|
virtual Vector<Plane> get_frustum() const;
|
|
bool is_position_in_frustum(const Vector3 &p_position) const;
|
|
|
|
void set_environment(const Ref<Environment> &p_environment);
|
|
Ref<Environment> get_environment() const;
|
|
|
|
void set_attributes(const Ref<CameraAttributes> &p_effects);
|
|
Ref<CameraAttributes> get_attributes() const;
|
|
|
|
void set_keep_aspect_mode(KeepAspect p_aspect);
|
|
KeepAspect get_keep_aspect_mode() const;
|
|
|
|
void set_v_offset(real_t p_offset);
|
|
real_t get_v_offset() const;
|
|
|
|
void set_h_offset(real_t p_offset);
|
|
real_t get_h_offset() const;
|
|
|
|
void set_doppler_tracking(DopplerTracking p_tracking);
|
|
DopplerTracking get_doppler_tracking() const;
|
|
|
|
Vector3 get_doppler_tracked_velocity() const;
|
|
|
|
RID get_pyramid_shape_rid();
|
|
|
|
Camera3D();
|
|
~Camera3D();
|
|
};
|
|
|
|
VARIANT_ENUM_CAST(Camera3D::ProjectionType);
|
|
VARIANT_ENUM_CAST(Camera3D::KeepAspect);
|
|
VARIANT_ENUM_CAST(Camera3D::DopplerTracking);
|
|
|
|
#endif // CAMERA_3D_H
|