class_gltfcamera.rst 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the GLTFCamera.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_GLTFCamera:
  6. GLTFCamera
  7. ==========
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Description
  10. -----------
  11. **Note:** This class is only compiled in editor builds. Run-time glTF loading and saving is *not* available in exported projects. References to ``GLTFCamera`` within a script will cause an error in an exported project.
  12. Properties
  13. ----------
  14. +---------------------------+-----------------------------------------------------------+------------+
  15. | :ref:`float<class_float>` | :ref:`fov_size<class_GLTFCamera_property_fov_size>` | ``75.0`` |
  16. +---------------------------+-----------------------------------------------------------+------------+
  17. | :ref:`bool<class_bool>` | :ref:`perspective<class_GLTFCamera_property_perspective>` | ``true`` |
  18. +---------------------------+-----------------------------------------------------------+------------+
  19. | :ref:`float<class_float>` | :ref:`zfar<class_GLTFCamera_property_zfar>` | ``4000.0`` |
  20. +---------------------------+-----------------------------------------------------------+------------+
  21. | :ref:`float<class_float>` | :ref:`znear<class_GLTFCamera_property_znear>` | ``0.05`` |
  22. +---------------------------+-----------------------------------------------------------+------------+
  23. Property Descriptions
  24. ---------------------
  25. .. _class_GLTFCamera_property_fov_size:
  26. - :ref:`float<class_float>` **fov_size**
  27. +-----------+---------------------+
  28. | *Default* | ``75.0`` |
  29. +-----------+---------------------+
  30. | *Setter* | set_fov_size(value) |
  31. +-----------+---------------------+
  32. | *Getter* | get_fov_size() |
  33. +-----------+---------------------+
  34. ----
  35. .. _class_GLTFCamera_property_perspective:
  36. - :ref:`bool<class_bool>` **perspective**
  37. +-----------+------------------------+
  38. | *Default* | ``true`` |
  39. +-----------+------------------------+
  40. | *Setter* | set_perspective(value) |
  41. +-----------+------------------------+
  42. | *Getter* | get_perspective() |
  43. +-----------+------------------------+
  44. ----
  45. .. _class_GLTFCamera_property_zfar:
  46. - :ref:`float<class_float>` **zfar**
  47. +-----------+-----------------+
  48. | *Default* | ``4000.0`` |
  49. +-----------+-----------------+
  50. | *Setter* | set_zfar(value) |
  51. +-----------+-----------------+
  52. | *Getter* | get_zfar() |
  53. +-----------+-----------------+
  54. ----
  55. .. _class_GLTFCamera_property_znear:
  56. - :ref:`float<class_float>` **znear**
  57. +-----------+------------------+
  58. | *Default* | ``0.05`` |
  59. +-----------+------------------+
  60. | *Setter* | set_znear(value) |
  61. +-----------+------------------+
  62. | *Getter* | get_znear() |
  63. +-----------+------------------+
  64. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  65. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  66. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`