2014-02-10 09:10:30 +08:00
|
|
|
/*************************************************************************/
|
|
|
|
/* camera.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
|
|
|
/* http://www.godotengine.org */
|
|
|
|
/*************************************************************************/
|
2017-01-02 05:01:57 +08:00
|
|
|
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
|
2014-02-10 09:10:30 +08:00
|
|
|
/* */
|
|
|
|
/* 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_H
|
|
|
|
#define CAMERA_H
|
|
|
|
|
|
|
|
#include "scene/3d/spatial.h"
|
|
|
|
#include "scene/main/viewport.h"
|
|
|
|
#include "scene/resources/environment.h"
|
|
|
|
/**
|
|
|
|
@author Juan Linietsky <reduzio@gmail.com>
|
|
|
|
*/
|
|
|
|
class Camera : public Spatial {
|
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
GDCLASS(Camera, Spatial);
|
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
public:
|
|
|
|
enum Projection {
|
2016-03-09 07:00:52 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
PROJECTION_PERSPECTIVE,
|
|
|
|
PROJECTION_ORTHOGONAL
|
|
|
|
};
|
|
|
|
|
2014-09-16 07:06:37 +08:00
|
|
|
enum KeepAspect {
|
|
|
|
KEEP_WIDTH,
|
|
|
|
KEEP_HEIGHT
|
|
|
|
};
|
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
private:
|
|
|
|
bool force_change;
|
|
|
|
bool current;
|
|
|
|
|
|
|
|
Projection mode;
|
2016-03-09 07:00:52 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
float fov;
|
|
|
|
float size;
|
2017-03-05 23:44:50 +08:00
|
|
|
float near, far;
|
2015-01-03 22:06:53 +08:00
|
|
|
float v_offset;
|
|
|
|
float h_offset;
|
2014-09-16 07:06:37 +08:00
|
|
|
KeepAspect keep_aspect;
|
2016-03-09 07:00:52 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
RID camera;
|
|
|
|
RID scenario_id;
|
|
|
|
|
2016-01-03 04:18:45 +08:00
|
|
|
//String camera_group;
|
2014-10-12 13:13:22 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
uint32_t layers;
|
|
|
|
|
|
|
|
Ref<Environment> environment;
|
|
|
|
|
|
|
|
virtual bool _can_gizmo_scale() const;
|
2016-10-04 03:33:42 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
//void _camera_make_current(Node *p_camera);
|
2017-03-05 23:44:50 +08:00
|
|
|
friend class Viewport;
|
2014-02-10 09:10:30 +08:00
|
|
|
void _update_audio_listener_state();
|
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
protected:
|
2014-02-10 09:10:30 +08:00
|
|
|
void _update_camera();
|
|
|
|
virtual void _request_camera_update();
|
|
|
|
void _update_camera_mode();
|
2016-03-09 07:00:52 +08:00
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
bool _set(const StringName &p_name, const Variant &p_value);
|
|
|
|
bool _get(const StringName &p_name, Variant &r_ret) const;
|
|
|
|
void _get_property_list(List<PropertyInfo> *p_list) const;
|
2014-02-10 09:10:30 +08:00
|
|
|
void _notification(int p_what);
|
2016-03-09 07:00:52 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
static void _bind_methods();
|
2016-03-09 07:00:52 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
public:
|
|
|
|
enum {
|
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
NOTIFICATION_BECAME_CURRENT = 50,
|
|
|
|
NOTIFICATION_LOST_CURRENT = 51
|
2014-02-10 09:10:30 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
void set_perspective(float p_fovy_degrees, float p_z_near, float p_z_far);
|
|
|
|
void set_orthogonal(float p_size, float p_z_near, float p_z_far);
|
2016-03-09 07:00:52 +08:00
|
|
|
|
2014-02-10 09:10:30 +08:00
|
|
|
void make_current();
|
|
|
|
void clear_current();
|
|
|
|
bool is_current() const;
|
|
|
|
|
|
|
|
RID get_camera() const;
|
|
|
|
|
|
|
|
float get_fov() const;
|
|
|
|
float get_size() const;
|
|
|
|
float get_zfar() const;
|
|
|
|
float get_znear() const;
|
|
|
|
Projection get_projection() const;
|
|
|
|
|
|
|
|
virtual Transform get_camera_transform() const;
|
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
Vector3 project_ray_normal(const Point2 &p_point) const;
|
|
|
|
Vector3 project_ray_origin(const Point2 &p_point) const;
|
|
|
|
Vector3 project_local_ray_normal(const Point2 &p_point) const;
|
|
|
|
Point2 unproject_position(const Vector3 &p_pos) const;
|
|
|
|
bool is_position_behind(const Vector3 &p_pos) const;
|
|
|
|
Vector3 project_position(const Point2 &p_point) const;
|
2014-02-10 09:10:30 +08:00
|
|
|
|
2016-10-04 03:33:42 +08:00
|
|
|
void set_cull_mask(uint32_t p_layers);
|
|
|
|
uint32_t get_cull_mask() const;
|
2014-02-10 09:10:30 +08:00
|
|
|
|
|
|
|
Vector<Plane> get_frustum() const;
|
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
void set_environment(const Ref<Environment> &p_environment);
|
2014-02-10 09:10:30 +08:00
|
|
|
Ref<Environment> get_environment() const;
|
|
|
|
|
2014-09-16 07:06:37 +08:00
|
|
|
void set_keep_aspect_mode(KeepAspect p_aspect);
|
|
|
|
KeepAspect get_keep_aspect_mode() const;
|
2014-02-10 09:10:30 +08:00
|
|
|
|
2015-01-03 22:06:53 +08:00
|
|
|
void set_v_offset(float p_offset);
|
|
|
|
float get_v_offset() const;
|
|
|
|
|
|
|
|
void set_h_offset(float p_offset);
|
|
|
|
float get_h_offset() const;
|
|
|
|
|
2016-03-09 07:00:52 +08:00
|
|
|
Camera();
|
2014-02-10 09:10:30 +08:00
|
|
|
~Camera();
|
|
|
|
};
|
|
|
|
|
2017-03-05 23:44:50 +08:00
|
|
|
VARIANT_ENUM_CAST(Camera::Projection);
|
|
|
|
VARIANT_ENUM_CAST(Camera::KeepAspect);
|
2014-02-10 09:10:30 +08:00
|
|
|
|
|
|
|
#endif
|