camera_3d.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901
  1. /**************************************************************************/
  2. /* camera_3d.cpp */
  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. #include "camera_3d.h"
  31. #include "core/math/projection.h"
  32. #include "core/math/transform_interpolator.h"
  33. #include "scene/main/viewport.h"
  34. void Camera3D::_update_audio_listener_state() {
  35. }
  36. void Camera3D::_request_camera_update() {
  37. _update_camera();
  38. }
  39. void Camera3D::_update_camera_mode() {
  40. force_change = true;
  41. switch (mode) {
  42. case PROJECTION_PERSPECTIVE: {
  43. set_perspective(fov, _near, _far);
  44. } break;
  45. case PROJECTION_ORTHOGONAL: {
  46. set_orthogonal(size, _near, _far);
  47. } break;
  48. case PROJECTION_FRUSTUM: {
  49. set_frustum(size, frustum_offset, _near, _far);
  50. } break;
  51. }
  52. }
  53. void Camera3D::_validate_property(PropertyInfo &p_property) const {
  54. if (p_property.name == "fov") {
  55. if (mode != PROJECTION_PERSPECTIVE) {
  56. p_property.usage = PROPERTY_USAGE_NO_EDITOR;
  57. }
  58. } else if (p_property.name == "size") {
  59. if (mode != PROJECTION_ORTHOGONAL && mode != PROJECTION_FRUSTUM) {
  60. p_property.usage = PROPERTY_USAGE_NO_EDITOR;
  61. }
  62. } else if (p_property.name == "frustum_offset") {
  63. if (mode != PROJECTION_FRUSTUM) {
  64. p_property.usage = PROPERTY_USAGE_NO_EDITOR;
  65. }
  66. }
  67. if (attributes.is_valid()) {
  68. const CameraAttributesPhysical *physical_attributes = Object::cast_to<CameraAttributesPhysical>(attributes.ptr());
  69. if (physical_attributes) {
  70. if (p_property.name == "near" || p_property.name == "far" || p_property.name == "fov" || p_property.name == "keep_aspect") {
  71. p_property.usage = PROPERTY_USAGE_READ_ONLY | PROPERTY_USAGE_INTERNAL | PROPERTY_USAGE_EDITOR;
  72. }
  73. }
  74. }
  75. Node3D::_validate_property(p_property);
  76. }
  77. void Camera3D::_update_camera() {
  78. if (!is_inside_tree()) {
  79. return;
  80. }
  81. if (!is_physics_interpolated_and_enabled()) {
  82. RenderingServer::get_singleton()->camera_set_transform(camera, get_camera_transform());
  83. } else {
  84. // Ideally we shouldn't be moving a physics interpolated camera within a frame,
  85. // because it will break smooth interpolation, but it may occur on e.g. level load.
  86. if (!Engine::get_singleton()->is_in_physics_frame() && camera.is_valid()) {
  87. _physics_interpolation_ensure_transform_calculated(true);
  88. RenderingServer::get_singleton()->camera_set_transform(camera, _interpolation_data.camera_xform_interpolated);
  89. }
  90. }
  91. if (is_part_of_edited_scene() || !is_current()) {
  92. return;
  93. }
  94. get_viewport()->_camera_3d_transform_changed_notify();
  95. }
  96. void Camera3D::_physics_interpolated_changed() {
  97. _update_process_mode();
  98. }
  99. void Camera3D::_physics_interpolation_ensure_data_flipped() {
  100. // The curr -> previous update can either occur
  101. // on the INTERNAL_PHYSICS_PROCESS OR
  102. // on NOTIFICATION_TRANSFORM_CHANGED,
  103. // if NOTIFICATION_TRANSFORM_CHANGED takes place
  104. // earlier than INTERNAL_PHYSICS_PROCESS on a tick.
  105. // This is to ensure that the data keeps flowing, but the new data
  106. // doesn't overwrite before prev has been set.
  107. // Keep the data flowing.
  108. uint64_t tick = Engine::get_singleton()->get_physics_frames();
  109. if (_interpolation_data.last_update_physics_tick != tick) {
  110. _interpolation_data.xform_prev = _interpolation_data.xform_curr;
  111. _interpolation_data.last_update_physics_tick = tick;
  112. physics_interpolation_flip_data();
  113. }
  114. }
  115. void Camera3D::_physics_interpolation_ensure_transform_calculated(bool p_force) const {
  116. DEV_CHECK_ONCE(!Engine::get_singleton()->is_in_physics_frame());
  117. InterpolationData &id = _interpolation_data;
  118. uint64_t frame = Engine::get_singleton()->get_frames_drawn();
  119. if (id.last_update_frame != frame || p_force) {
  120. id.last_update_frame = frame;
  121. TransformInterpolator::interpolate_transform_3d(id.xform_prev, id.xform_curr, id.xform_interpolated, Engine::get_singleton()->get_physics_interpolation_fraction());
  122. Transform3D &tr = id.camera_xform_interpolated;
  123. tr = _get_adjusted_camera_transform(id.xform_interpolated);
  124. }
  125. }
  126. void Camera3D::set_desired_process_modes(bool p_process_internal, bool p_physics_process_internal) {
  127. _desired_process_internal = p_process_internal;
  128. _desired_physics_process_internal = p_physics_process_internal;
  129. _update_process_mode();
  130. }
  131. void Camera3D::_update_process_mode() {
  132. bool process = _desired_process_internal;
  133. bool physics_process = _desired_physics_process_internal;
  134. if (is_physics_interpolated_and_enabled()) {
  135. if (is_current()) {
  136. process = true;
  137. physics_process = true;
  138. }
  139. }
  140. set_process_internal(process);
  141. set_physics_process_internal(physics_process);
  142. }
  143. void Camera3D::_notification(int p_what) {
  144. switch (p_what) {
  145. case NOTIFICATION_ENTER_WORLD: {
  146. // Needs to track the Viewport because it's needed on NOTIFICATION_EXIT_WORLD
  147. // and Spatial will handle it first, including clearing its reference to the Viewport,
  148. // therefore making it impossible to subclasses to access it
  149. viewport = get_viewport();
  150. ERR_FAIL_NULL(viewport);
  151. bool first_camera = viewport->_camera_3d_add(this);
  152. if (current || first_camera) {
  153. viewport->_camera_3d_set(this);
  154. }
  155. #ifdef TOOLS_ENABLED
  156. if (Engine::get_singleton()->is_editor_hint()) {
  157. viewport->connect(SNAME("size_changed"), callable_mp((Node3D *)this, &Camera3D::update_gizmos));
  158. }
  159. #endif
  160. } break;
  161. case NOTIFICATION_INTERNAL_PROCESS: {
  162. if (is_physics_interpolated_and_enabled() && camera.is_valid()) {
  163. _physics_interpolation_ensure_transform_calculated();
  164. #ifdef RENDERING_SERVER_DEBUG_PHYSICS_INTERPOLATION
  165. print_line("\t\tinterpolated Camera3D: " + rtos(_interpolation_data.xform_interpolated.origin.x) + "\t( prev " + rtos(_interpolation_data.xform_prev.origin.x) + ", curr " + rtos(_interpolation_data.xform_curr.origin.x) + " ) on tick " + itos(Engine::get_singleton()->get_physics_frames()));
  166. #endif
  167. RenderingServer::get_singleton()->camera_set_transform(camera, _interpolation_data.camera_xform_interpolated);
  168. }
  169. } break;
  170. case NOTIFICATION_INTERNAL_PHYSICS_PROCESS: {
  171. if (is_physics_interpolated_and_enabled()) {
  172. _physics_interpolation_ensure_data_flipped();
  173. _interpolation_data.xform_curr = get_global_transform();
  174. }
  175. } break;
  176. case NOTIFICATION_TRANSFORM_CHANGED: {
  177. if (is_physics_interpolated_and_enabled()) {
  178. _physics_interpolation_ensure_data_flipped();
  179. _interpolation_data.xform_curr = get_global_transform();
  180. #if defined(DEBUG_ENABLED) && defined(TOOLS_ENABLED)
  181. if (!Engine::get_singleton()->is_in_physics_frame()) {
  182. PHYSICS_INTERPOLATION_NODE_WARNING(get_instance_id(), "Interpolated Camera3D triggered from outside physics process");
  183. }
  184. #endif
  185. }
  186. _request_camera_update();
  187. if (doppler_tracking != DOPPLER_TRACKING_DISABLED) {
  188. velocity_tracker->update_position(get_global_transform().origin);
  189. }
  190. // Allow auto-reset when first adding to the tree, as a convenience.
  191. if (_is_physics_interpolation_reset_requested() && is_inside_tree()) {
  192. _notification(NOTIFICATION_RESET_PHYSICS_INTERPOLATION);
  193. _set_physics_interpolation_reset_requested(false);
  194. }
  195. } break;
  196. case NOTIFICATION_RESET_PHYSICS_INTERPOLATION: {
  197. if (is_inside_tree()) {
  198. _interpolation_data.xform_curr = get_global_transform();
  199. _interpolation_data.xform_prev = _interpolation_data.xform_curr;
  200. }
  201. } break;
  202. case NOTIFICATION_SUSPENDED:
  203. case NOTIFICATION_PAUSED: {
  204. if (is_physics_interpolated_and_enabled() && is_inside_tree() && is_visible_in_tree()) {
  205. _physics_interpolation_ensure_transform_calculated(true);
  206. RenderingServer::get_singleton()->camera_set_transform(camera, _interpolation_data.camera_xform_interpolated);
  207. }
  208. } break;
  209. case NOTIFICATION_EXIT_WORLD: {
  210. if (!is_part_of_edited_scene()) {
  211. if (is_current()) {
  212. clear_current();
  213. current = true; //keep it true
  214. } else {
  215. current = false;
  216. }
  217. }
  218. if (viewport) {
  219. #ifdef TOOLS_ENABLED
  220. if (Engine::get_singleton()->is_editor_hint()) {
  221. viewport->disconnect(SNAME("size_changed"), callable_mp((Node3D *)this, &Camera3D::update_gizmos));
  222. }
  223. #endif
  224. viewport->_camera_3d_remove(this);
  225. viewport = nullptr;
  226. }
  227. } break;
  228. case NOTIFICATION_BECAME_CURRENT: {
  229. if (viewport) {
  230. viewport->find_world_3d()->_register_camera(this);
  231. }
  232. _update_process_mode();
  233. } break;
  234. case NOTIFICATION_LOST_CURRENT: {
  235. if (viewport) {
  236. viewport->find_world_3d()->_remove_camera(this);
  237. }
  238. _update_process_mode();
  239. } break;
  240. }
  241. }
  242. Transform3D Camera3D::_get_adjusted_camera_transform(const Transform3D &p_xform) const {
  243. Transform3D tr = p_xform.orthonormalized();
  244. tr.origin += tr.basis.get_column(1) * v_offset;
  245. tr.origin += tr.basis.get_column(0) * h_offset;
  246. return tr;
  247. }
  248. Transform3D Camera3D::get_camera_transform() const {
  249. if (is_physics_interpolated_and_enabled() && !Engine::get_singleton()->is_in_physics_frame()) {
  250. _physics_interpolation_ensure_transform_calculated();
  251. return _interpolation_data.camera_xform_interpolated;
  252. }
  253. return _get_adjusted_camera_transform(get_global_transform());
  254. }
  255. Projection Camera3D::_get_camera_projection(real_t p_near) const {
  256. Size2 viewport_size = get_viewport()->get_visible_rect().size;
  257. Projection cm;
  258. switch (mode) {
  259. case PROJECTION_PERSPECTIVE: {
  260. cm.set_perspective(fov, viewport_size.aspect(), p_near, _far, keep_aspect == KEEP_WIDTH);
  261. } break;
  262. case PROJECTION_ORTHOGONAL: {
  263. cm.set_orthogonal(size, viewport_size.aspect(), p_near, _far, keep_aspect == KEEP_WIDTH);
  264. } break;
  265. case PROJECTION_FRUSTUM: {
  266. cm.set_frustum(size, viewport_size.aspect(), frustum_offset, p_near, _far);
  267. } break;
  268. }
  269. return cm;
  270. }
  271. Projection Camera3D::get_camera_projection() const {
  272. ERR_FAIL_COND_V_MSG(!is_inside_tree(), Projection(), "Camera is not inside the scene tree.");
  273. return _get_camera_projection(_near);
  274. }
  275. void Camera3D::set_perspective(real_t p_fovy_degrees, real_t p_z_near, real_t p_z_far) {
  276. if (!force_change && fov == p_fovy_degrees && p_z_near == _near && p_z_far == _far && mode == PROJECTION_PERSPECTIVE) {
  277. return;
  278. }
  279. fov = p_fovy_degrees;
  280. _near = p_z_near;
  281. _far = p_z_far;
  282. mode = PROJECTION_PERSPECTIVE;
  283. RenderingServer::get_singleton()->camera_set_perspective(camera, fov, _near, _far);
  284. update_gizmos();
  285. force_change = false;
  286. }
  287. void Camera3D::set_orthogonal(real_t p_size, real_t p_z_near, real_t p_z_far) {
  288. if (!force_change && size == p_size && p_z_near == _near && p_z_far == _far && mode == PROJECTION_ORTHOGONAL) {
  289. return;
  290. }
  291. size = p_size;
  292. _near = p_z_near;
  293. _far = p_z_far;
  294. mode = PROJECTION_ORTHOGONAL;
  295. force_change = false;
  296. RenderingServer::get_singleton()->camera_set_orthogonal(camera, size, _near, _far);
  297. update_gizmos();
  298. }
  299. void Camera3D::set_frustum(real_t p_size, Vector2 p_offset, real_t p_z_near, real_t p_z_far) {
  300. if (!force_change && size == p_size && frustum_offset == p_offset && p_z_near == _near && p_z_far == _far && mode == PROJECTION_FRUSTUM) {
  301. return;
  302. }
  303. size = p_size;
  304. frustum_offset = p_offset;
  305. _near = p_z_near;
  306. _far = p_z_far;
  307. mode = PROJECTION_FRUSTUM;
  308. force_change = false;
  309. RenderingServer::get_singleton()->camera_set_frustum(camera, size, frustum_offset, _near, _far);
  310. update_gizmos();
  311. }
  312. void Camera3D::set_projection(ProjectionType p_mode) {
  313. if (p_mode == PROJECTION_PERSPECTIVE || p_mode == PROJECTION_ORTHOGONAL || p_mode == PROJECTION_FRUSTUM) {
  314. mode = p_mode;
  315. _update_camera_mode();
  316. notify_property_list_changed();
  317. }
  318. }
  319. RID Camera3D::get_camera() const {
  320. return camera;
  321. }
  322. void Camera3D::make_current() {
  323. current = true;
  324. if (!is_inside_tree()) {
  325. return;
  326. }
  327. get_viewport()->_camera_3d_set(this);
  328. }
  329. void Camera3D::clear_current(bool p_enable_next) {
  330. current = false;
  331. if (!is_inside_tree()) {
  332. return;
  333. }
  334. if (get_viewport()->get_camera_3d() == this) {
  335. get_viewport()->_camera_3d_set(nullptr);
  336. if (p_enable_next && !Engine::get_singleton()->is_editor_hint()) {
  337. get_viewport()->_camera_3d_make_next_current(this);
  338. }
  339. }
  340. }
  341. void Camera3D::set_current(bool p_enabled) {
  342. if (p_enabled) {
  343. make_current();
  344. } else {
  345. clear_current();
  346. }
  347. }
  348. bool Camera3D::is_current() const {
  349. if (is_inside_tree() && !is_part_of_edited_scene()) {
  350. return get_viewport()->get_camera_3d() == this;
  351. } else {
  352. return current;
  353. }
  354. }
  355. Vector3 Camera3D::project_ray_normal(const Point2 &p_pos) const {
  356. Vector3 ray = project_local_ray_normal(p_pos);
  357. return get_camera_transform().basis.xform(ray).normalized();
  358. }
  359. Vector3 Camera3D::project_local_ray_normal(const Point2 &p_pos) const {
  360. ERR_FAIL_COND_V_MSG(!is_inside_tree(), Vector3(), "Camera is not inside scene.");
  361. Size2 viewport_size = get_viewport()->get_camera_rect_size();
  362. Vector2 cpos = get_viewport()->get_camera_coords(p_pos);
  363. Vector3 ray;
  364. if (mode == PROJECTION_ORTHOGONAL) {
  365. ray = Vector3(0, 0, -1);
  366. } else {
  367. Projection cm = _get_camera_projection(_near);
  368. Vector2 screen_he = cm.get_viewport_half_extents();
  369. ray = Vector3(((cpos.x / viewport_size.width) * 2.0 - 1.0) * screen_he.x, ((1.0 - (cpos.y / viewport_size.height)) * 2.0 - 1.0) * screen_he.y, -_near).normalized();
  370. }
  371. return ray;
  372. }
  373. Vector3 Camera3D::project_ray_origin(const Point2 &p_pos) const {
  374. ERR_FAIL_COND_V_MSG(!is_inside_tree(), Vector3(), "Camera is not inside scene.");
  375. Size2 viewport_size = get_viewport()->get_camera_rect_size();
  376. Vector2 cpos = get_viewport()->get_camera_coords(p_pos);
  377. ERR_FAIL_COND_V(viewport_size.y == 0, Vector3());
  378. if (mode == PROJECTION_ORTHOGONAL) {
  379. Vector2 pos = cpos / viewport_size;
  380. real_t vsize, hsize;
  381. if (keep_aspect == KEEP_WIDTH) {
  382. vsize = size / viewport_size.aspect();
  383. hsize = size;
  384. } else {
  385. hsize = size * viewport_size.aspect();
  386. vsize = size;
  387. }
  388. Vector3 ray;
  389. ray.x = pos.x * (hsize)-hsize / 2;
  390. ray.y = (1.0 - pos.y) * (vsize)-vsize / 2;
  391. ray.z = -_near;
  392. ray = get_camera_transform().xform(ray);
  393. return ray;
  394. } else {
  395. return get_camera_transform().origin;
  396. };
  397. }
  398. bool Camera3D::is_position_behind(const Vector3 &p_pos) const {
  399. Transform3D t = get_global_transform();
  400. Vector3 eyedir = -t.basis.get_column(2).normalized();
  401. return eyedir.dot(p_pos - t.origin) < _near;
  402. }
  403. Vector<Vector3> Camera3D::get_near_plane_points() const {
  404. ERR_FAIL_COND_V_MSG(!is_inside_tree(), Vector<Vector3>(), "Camera is not inside scene.");
  405. Projection cm = _get_camera_projection(_near);
  406. Vector3 endpoints[8];
  407. cm.get_endpoints(Transform3D(), endpoints);
  408. Vector<Vector3> points = {
  409. Vector3(),
  410. endpoints[4],
  411. endpoints[5],
  412. endpoints[6],
  413. endpoints[7]
  414. };
  415. return points;
  416. }
  417. Point2 Camera3D::unproject_position(const Vector3 &p_pos) const {
  418. ERR_FAIL_COND_V_MSG(!is_inside_tree(), Vector2(), "Camera is not inside scene.");
  419. Size2 viewport_size = get_viewport()->get_visible_rect().size;
  420. Projection cm = _get_camera_projection(_near);
  421. Plane p(get_camera_transform().xform_inv(p_pos), 1.0);
  422. p = cm.xform4(p);
  423. // Prevent divide by zero.
  424. // TODO: Investigate, this was causing NaNs.
  425. ERR_FAIL_COND_V(p.d == 0, Point2());
  426. p.normal /= p.d;
  427. Point2 res;
  428. res.x = (p.normal.x * 0.5 + 0.5) * viewport_size.x;
  429. res.y = (-p.normal.y * 0.5 + 0.5) * viewport_size.y;
  430. return res;
  431. }
  432. Vector3 Camera3D::project_position(const Point2 &p_point, real_t p_z_depth) const {
  433. ERR_FAIL_COND_V_MSG(!is_inside_tree(), Vector3(), "Camera is not inside scene.");
  434. if (p_z_depth == 0 && mode != PROJECTION_ORTHOGONAL) {
  435. return get_global_transform().origin;
  436. }
  437. Size2 viewport_size = get_viewport()->get_visible_rect().size;
  438. Projection cm = _get_camera_projection(_near);
  439. Plane z_slice(Vector3(0, 0, 1), -p_z_depth);
  440. Vector3 res;
  441. z_slice.intersect_3(cm.get_projection_plane(Projection::Planes::PLANE_RIGHT), cm.get_projection_plane(Projection::Planes::PLANE_TOP), &res);
  442. Vector2 vp_he(res.x, res.y);
  443. Vector2 point;
  444. point.x = (p_point.x / viewport_size.x) * 2.0 - 1.0;
  445. point.y = (1.0 - (p_point.y / viewport_size.y)) * 2.0 - 1.0;
  446. point *= vp_he;
  447. Vector3 p(point.x, point.y, -p_z_depth);
  448. return get_camera_transform().xform(p);
  449. }
  450. void Camera3D::set_environment(const Ref<Environment> &p_environment) {
  451. environment = p_environment;
  452. if (environment.is_valid()) {
  453. RS::get_singleton()->camera_set_environment(camera, environment->get_rid());
  454. } else {
  455. RS::get_singleton()->camera_set_environment(camera, RID());
  456. }
  457. _update_camera_mode();
  458. }
  459. Ref<Environment> Camera3D::get_environment() const {
  460. return environment;
  461. }
  462. void Camera3D::set_attributes(const Ref<CameraAttributes> &p_attributes) {
  463. if (attributes.is_valid()) {
  464. CameraAttributesPhysical *physical_attributes = Object::cast_to<CameraAttributesPhysical>(attributes.ptr());
  465. if (physical_attributes) {
  466. attributes->disconnect_changed(callable_mp(this, &Camera3D::_attributes_changed));
  467. }
  468. }
  469. attributes = p_attributes;
  470. if (attributes.is_valid()) {
  471. CameraAttributesPhysical *physical_attributes = Object::cast_to<CameraAttributesPhysical>(attributes.ptr());
  472. if (physical_attributes) {
  473. attributes->connect_changed(callable_mp(this, &Camera3D::_attributes_changed));
  474. _attributes_changed();
  475. }
  476. RS::get_singleton()->camera_set_camera_attributes(camera, attributes->get_rid());
  477. } else {
  478. RS::get_singleton()->camera_set_camera_attributes(camera, RID());
  479. }
  480. notify_property_list_changed();
  481. }
  482. Ref<CameraAttributes> Camera3D::get_attributes() const {
  483. return attributes;
  484. }
  485. void Camera3D::_attributes_changed() {
  486. CameraAttributesPhysical *physical_attributes = Object::cast_to<CameraAttributesPhysical>(attributes.ptr());
  487. ERR_FAIL_NULL(physical_attributes);
  488. fov = physical_attributes->get_fov();
  489. _near = physical_attributes->get_near();
  490. _far = physical_attributes->get_far();
  491. keep_aspect = KEEP_HEIGHT;
  492. _update_camera_mode();
  493. }
  494. void Camera3D::set_compositor(const Ref<Compositor> &p_compositor) {
  495. compositor = p_compositor;
  496. if (compositor.is_valid()) {
  497. RS::get_singleton()->camera_set_compositor(camera, compositor->get_rid());
  498. } else {
  499. RS::get_singleton()->camera_set_compositor(camera, RID());
  500. }
  501. _update_camera_mode();
  502. }
  503. Ref<Compositor> Camera3D::get_compositor() const {
  504. return compositor;
  505. }
  506. void Camera3D::set_keep_aspect_mode(KeepAspect p_aspect) {
  507. keep_aspect = p_aspect;
  508. RenderingServer::get_singleton()->camera_set_use_vertical_aspect(camera, p_aspect == KEEP_WIDTH);
  509. _update_camera_mode();
  510. notify_property_list_changed();
  511. }
  512. Camera3D::KeepAspect Camera3D::get_keep_aspect_mode() const {
  513. return keep_aspect;
  514. }
  515. void Camera3D::set_doppler_tracking(DopplerTracking p_tracking) {
  516. if (doppler_tracking == p_tracking) {
  517. return;
  518. }
  519. doppler_tracking = p_tracking;
  520. if (p_tracking != DOPPLER_TRACKING_DISABLED) {
  521. velocity_tracker->set_track_physics_step(doppler_tracking == DOPPLER_TRACKING_PHYSICS_STEP);
  522. if (is_inside_tree()) {
  523. velocity_tracker->reset(get_global_transform().origin);
  524. }
  525. }
  526. _update_camera_mode();
  527. }
  528. Camera3D::DopplerTracking Camera3D::get_doppler_tracking() const {
  529. return doppler_tracking;
  530. }
  531. void Camera3D::_bind_methods() {
  532. ClassDB::bind_method(D_METHOD("project_ray_normal", "screen_point"), &Camera3D::project_ray_normal);
  533. ClassDB::bind_method(D_METHOD("project_local_ray_normal", "screen_point"), &Camera3D::project_local_ray_normal);
  534. ClassDB::bind_method(D_METHOD("project_ray_origin", "screen_point"), &Camera3D::project_ray_origin);
  535. ClassDB::bind_method(D_METHOD("unproject_position", "world_point"), &Camera3D::unproject_position);
  536. ClassDB::bind_method(D_METHOD("is_position_behind", "world_point"), &Camera3D::is_position_behind);
  537. ClassDB::bind_method(D_METHOD("project_position", "screen_point", "z_depth"), &Camera3D::project_position);
  538. ClassDB::bind_method(D_METHOD("set_perspective", "fov", "z_near", "z_far"), &Camera3D::set_perspective);
  539. ClassDB::bind_method(D_METHOD("set_orthogonal", "size", "z_near", "z_far"), &Camera3D::set_orthogonal);
  540. ClassDB::bind_method(D_METHOD("set_frustum", "size", "offset", "z_near", "z_far"), &Camera3D::set_frustum);
  541. ClassDB::bind_method(D_METHOD("make_current"), &Camera3D::make_current);
  542. ClassDB::bind_method(D_METHOD("clear_current", "enable_next"), &Camera3D::clear_current, DEFVAL(true));
  543. ClassDB::bind_method(D_METHOD("set_current", "enabled"), &Camera3D::set_current);
  544. ClassDB::bind_method(D_METHOD("is_current"), &Camera3D::is_current);
  545. ClassDB::bind_method(D_METHOD("get_camera_transform"), &Camera3D::get_camera_transform);
  546. ClassDB::bind_method(D_METHOD("get_camera_projection"), &Camera3D::get_camera_projection);
  547. ClassDB::bind_method(D_METHOD("get_fov"), &Camera3D::get_fov);
  548. ClassDB::bind_method(D_METHOD("get_frustum_offset"), &Camera3D::get_frustum_offset);
  549. ClassDB::bind_method(D_METHOD("get_size"), &Camera3D::get_size);
  550. ClassDB::bind_method(D_METHOD("get_far"), &Camera3D::get_far);
  551. ClassDB::bind_method(D_METHOD("get_near"), &Camera3D::get_near);
  552. ClassDB::bind_method(D_METHOD("set_fov", "fov"), &Camera3D::set_fov);
  553. ClassDB::bind_method(D_METHOD("set_frustum_offset", "offset"), &Camera3D::set_frustum_offset);
  554. ClassDB::bind_method(D_METHOD("set_size", "size"), &Camera3D::set_size);
  555. ClassDB::bind_method(D_METHOD("set_far", "far"), &Camera3D::set_far);
  556. ClassDB::bind_method(D_METHOD("set_near", "near"), &Camera3D::set_near);
  557. ClassDB::bind_method(D_METHOD("get_projection"), &Camera3D::get_projection);
  558. ClassDB::bind_method(D_METHOD("set_projection", "mode"), &Camera3D::set_projection);
  559. ClassDB::bind_method(D_METHOD("set_h_offset", "offset"), &Camera3D::set_h_offset);
  560. ClassDB::bind_method(D_METHOD("get_h_offset"), &Camera3D::get_h_offset);
  561. ClassDB::bind_method(D_METHOD("set_v_offset", "offset"), &Camera3D::set_v_offset);
  562. ClassDB::bind_method(D_METHOD("get_v_offset"), &Camera3D::get_v_offset);
  563. ClassDB::bind_method(D_METHOD("set_cull_mask", "mask"), &Camera3D::set_cull_mask);
  564. ClassDB::bind_method(D_METHOD("get_cull_mask"), &Camera3D::get_cull_mask);
  565. ClassDB::bind_method(D_METHOD("set_environment", "env"), &Camera3D::set_environment);
  566. ClassDB::bind_method(D_METHOD("get_environment"), &Camera3D::get_environment);
  567. ClassDB::bind_method(D_METHOD("set_attributes", "env"), &Camera3D::set_attributes);
  568. ClassDB::bind_method(D_METHOD("get_attributes"), &Camera3D::get_attributes);
  569. ClassDB::bind_method(D_METHOD("set_compositor", "compositor"), &Camera3D::set_compositor);
  570. ClassDB::bind_method(D_METHOD("get_compositor"), &Camera3D::get_compositor);
  571. ClassDB::bind_method(D_METHOD("set_keep_aspect_mode", "mode"), &Camera3D::set_keep_aspect_mode);
  572. ClassDB::bind_method(D_METHOD("get_keep_aspect_mode"), &Camera3D::get_keep_aspect_mode);
  573. ClassDB::bind_method(D_METHOD("set_doppler_tracking", "mode"), &Camera3D::set_doppler_tracking);
  574. ClassDB::bind_method(D_METHOD("get_doppler_tracking"), &Camera3D::get_doppler_tracking);
  575. ClassDB::bind_method(D_METHOD("get_frustum"), &Camera3D::_get_frustum);
  576. ClassDB::bind_method(D_METHOD("is_position_in_frustum", "world_point"), &Camera3D::is_position_in_frustum);
  577. ClassDB::bind_method(D_METHOD("get_camera_rid"), &Camera3D::get_camera);
  578. ClassDB::bind_method(D_METHOD("get_pyramid_shape_rid"), &Camera3D::get_pyramid_shape_rid);
  579. ClassDB::bind_method(D_METHOD("set_cull_mask_value", "layer_number", "value"), &Camera3D::set_cull_mask_value);
  580. ClassDB::bind_method(D_METHOD("get_cull_mask_value", "layer_number"), &Camera3D::get_cull_mask_value);
  581. //ClassDB::bind_method(D_METHOD("_camera_make_current"),&Camera::_camera_make_current );
  582. ADD_PROPERTY(PropertyInfo(Variant::INT, "keep_aspect", PROPERTY_HINT_ENUM, "Keep Width,Keep Height"), "set_keep_aspect_mode", "get_keep_aspect_mode");
  583. ADD_PROPERTY(PropertyInfo(Variant::INT, "cull_mask", PROPERTY_HINT_LAYERS_3D_RENDER), "set_cull_mask", "get_cull_mask");
  584. ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "environment", PROPERTY_HINT_RESOURCE_TYPE, "Environment"), "set_environment", "get_environment");
  585. ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "attributes", PROPERTY_HINT_RESOURCE_TYPE, "CameraAttributesPractical,CameraAttributesPhysical"), "set_attributes", "get_attributes");
  586. ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "compositor", PROPERTY_HINT_RESOURCE_TYPE, "Compositor"), "set_compositor", "get_compositor");
  587. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "h_offset", PROPERTY_HINT_NONE, "suffix:m"), "set_h_offset", "get_h_offset");
  588. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "v_offset", PROPERTY_HINT_NONE, "suffix:m"), "set_v_offset", "get_v_offset");
  589. ADD_PROPERTY(PropertyInfo(Variant::INT, "doppler_tracking", PROPERTY_HINT_ENUM, "Disabled,Idle,Physics"), "set_doppler_tracking", "get_doppler_tracking");
  590. ADD_PROPERTY(PropertyInfo(Variant::INT, "projection", PROPERTY_HINT_ENUM, "Perspective,Orthogonal,Frustum"), "set_projection", "get_projection");
  591. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "current"), "set_current", "is_current");
  592. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "fov", PROPERTY_HINT_RANGE, "1,179,0.1,degrees"), "set_fov", "get_fov");
  593. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "size", PROPERTY_HINT_RANGE, "0.001,100,0.001,or_greater,suffix:m"), "set_size", "get_size");
  594. ADD_PROPERTY(PropertyInfo(Variant::VECTOR2, "frustum_offset", PROPERTY_HINT_NONE, "suffix:m"), "set_frustum_offset", "get_frustum_offset");
  595. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "near", PROPERTY_HINT_RANGE, "0.001,10,0.001,or_greater,exp,suffix:m"), "set_near", "get_near");
  596. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "far", PROPERTY_HINT_RANGE, "0.01,4000,0.01,or_greater,exp,suffix:m"), "set_far", "get_far");
  597. BIND_ENUM_CONSTANT(PROJECTION_PERSPECTIVE);
  598. BIND_ENUM_CONSTANT(PROJECTION_ORTHOGONAL);
  599. BIND_ENUM_CONSTANT(PROJECTION_FRUSTUM);
  600. BIND_ENUM_CONSTANT(KEEP_WIDTH);
  601. BIND_ENUM_CONSTANT(KEEP_HEIGHT);
  602. BIND_ENUM_CONSTANT(DOPPLER_TRACKING_DISABLED);
  603. BIND_ENUM_CONSTANT(DOPPLER_TRACKING_IDLE_STEP);
  604. BIND_ENUM_CONSTANT(DOPPLER_TRACKING_PHYSICS_STEP);
  605. }
  606. real_t Camera3D::get_fov() const {
  607. return fov;
  608. }
  609. real_t Camera3D::get_size() const {
  610. return size;
  611. }
  612. real_t Camera3D::get_near() const {
  613. return _near;
  614. }
  615. Vector2 Camera3D::get_frustum_offset() const {
  616. return frustum_offset;
  617. }
  618. real_t Camera3D::get_far() const {
  619. return _far;
  620. }
  621. Camera3D::ProjectionType Camera3D::get_projection() const {
  622. return mode;
  623. }
  624. void Camera3D::set_fov(real_t p_fov) {
  625. ERR_FAIL_COND(p_fov < 1 || p_fov > 179);
  626. fov = p_fov;
  627. _update_camera_mode();
  628. }
  629. void Camera3D::set_size(real_t p_size) {
  630. ERR_FAIL_COND(p_size <= CMP_EPSILON);
  631. size = p_size;
  632. _update_camera_mode();
  633. }
  634. void Camera3D::set_near(real_t p_near) {
  635. _near = p_near;
  636. _update_camera_mode();
  637. }
  638. void Camera3D::set_frustum_offset(Vector2 p_offset) {
  639. frustum_offset = p_offset;
  640. _update_camera_mode();
  641. }
  642. void Camera3D::set_far(real_t p_far) {
  643. _far = p_far;
  644. _update_camera_mode();
  645. }
  646. void Camera3D::set_cull_mask(uint32_t p_layers) {
  647. layers = p_layers;
  648. RenderingServer::get_singleton()->camera_set_cull_mask(camera, layers);
  649. _update_camera_mode();
  650. }
  651. uint32_t Camera3D::get_cull_mask() const {
  652. return layers;
  653. }
  654. void Camera3D::set_cull_mask_value(int p_layer_number, bool p_value) {
  655. ERR_FAIL_COND_MSG(p_layer_number < 1, "Render layer number must be between 1 and 20 inclusive.");
  656. ERR_FAIL_COND_MSG(p_layer_number > 20, "Render layer number must be between 1 and 20 inclusive.");
  657. uint32_t mask = get_cull_mask();
  658. if (p_value) {
  659. mask |= 1 << (p_layer_number - 1);
  660. } else {
  661. mask &= ~(1 << (p_layer_number - 1));
  662. }
  663. set_cull_mask(mask);
  664. }
  665. bool Camera3D::get_cull_mask_value(int p_layer_number) const {
  666. ERR_FAIL_COND_V_MSG(p_layer_number < 1, false, "Render layer number must be between 1 and 20 inclusive.");
  667. ERR_FAIL_COND_V_MSG(p_layer_number > 20, false, "Render layer number must be between 1 and 20 inclusive.");
  668. return layers & (1 << (p_layer_number - 1));
  669. }
  670. Vector<Plane> Camera3D::get_frustum() const {
  671. ERR_FAIL_COND_V(!is_inside_world(), Vector<Plane>());
  672. Projection cm = _get_camera_projection(_near);
  673. return cm.get_projection_planes(get_camera_transform());
  674. }
  675. TypedArray<Plane> Camera3D::_get_frustum() const {
  676. Variant ret = get_frustum();
  677. return ret;
  678. }
  679. bool Camera3D::is_position_in_frustum(const Vector3 &p_position) const {
  680. Vector<Plane> frustum = get_frustum();
  681. for (int i = 0; i < frustum.size(); i++) {
  682. if (frustum[i].is_point_over(p_position)) {
  683. return false;
  684. }
  685. }
  686. return true;
  687. }
  688. void Camera3D::set_v_offset(real_t p_offset) {
  689. v_offset = p_offset;
  690. _update_camera();
  691. }
  692. real_t Camera3D::get_v_offset() const {
  693. return v_offset;
  694. }
  695. void Camera3D::set_h_offset(real_t p_offset) {
  696. h_offset = p_offset;
  697. _update_camera();
  698. }
  699. real_t Camera3D::get_h_offset() const {
  700. return h_offset;
  701. }
  702. Vector3 Camera3D::get_doppler_tracked_velocity() const {
  703. if (doppler_tracking != DOPPLER_TRACKING_DISABLED) {
  704. return velocity_tracker->get_tracked_linear_velocity();
  705. } else {
  706. return Vector3();
  707. }
  708. }
  709. RID Camera3D::get_pyramid_shape_rid() {
  710. ERR_FAIL_COND_V_MSG(!is_inside_tree(), RID(), "Camera is not inside scene.");
  711. if (pyramid_shape == RID()) {
  712. pyramid_shape_points = get_near_plane_points();
  713. pyramid_shape = PhysicsServer3D::get_singleton()->convex_polygon_shape_create();
  714. PhysicsServer3D::get_singleton()->shape_set_data(pyramid_shape, pyramid_shape_points);
  715. } else { //check if points changed
  716. Vector<Vector3> local_points = get_near_plane_points();
  717. bool all_equal = true;
  718. for (int i = 0; i < 5; i++) {
  719. if (local_points[i] != pyramid_shape_points[i]) {
  720. all_equal = false;
  721. break;
  722. }
  723. }
  724. if (!all_equal) {
  725. PhysicsServer3D::get_singleton()->shape_set_data(pyramid_shape, local_points);
  726. pyramid_shape_points = local_points;
  727. }
  728. }
  729. return pyramid_shape;
  730. }
  731. Camera3D::Camera3D() {
  732. camera = RenderingServer::get_singleton()->camera_create();
  733. set_perspective(75.0, 0.05, 4000.0);
  734. RenderingServer::get_singleton()->camera_set_cull_mask(camera, layers);
  735. //active=false;
  736. velocity_tracker.instantiate();
  737. set_notify_transform(true);
  738. set_disable_scale(true);
  739. }
  740. Camera3D::~Camera3D() {
  741. ERR_FAIL_NULL(RenderingServer::get_singleton());
  742. RenderingServer::get_singleton()->free(camera);
  743. if (pyramid_shape.is_valid()) {
  744. ERR_FAIL_NULL(PhysicsServer3D::get_singleton());
  745. PhysicsServer3D::get_singleton()->free(pyramid_shape);
  746. }
  747. }