camera_3d.cpp 29 KB

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