class_gltfcamera.rst 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/3.5/modules/gltf/doc_classes/GLTFCamera.xml.
  6. .. _class_GLTFCamera:
  7. GLTFCamera
  8. ==========
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. **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.
  14. .. rst-class:: classref-reftable-group
  15. Properties
  16. ----------
  17. .. table::
  18. :widths: auto
  19. +---------------------------+-----------------------------------------------------------+------------+
  20. | :ref:`float<class_float>` | :ref:`fov_size<class_GLTFCamera_property_fov_size>` | ``75.0`` |
  21. +---------------------------+-----------------------------------------------------------+------------+
  22. | :ref:`bool<class_bool>` | :ref:`perspective<class_GLTFCamera_property_perspective>` | ``true`` |
  23. +---------------------------+-----------------------------------------------------------+------------+
  24. | :ref:`float<class_float>` | :ref:`zfar<class_GLTFCamera_property_zfar>` | ``4000.0`` |
  25. +---------------------------+-----------------------------------------------------------+------------+
  26. | :ref:`float<class_float>` | :ref:`znear<class_GLTFCamera_property_znear>` | ``0.05`` |
  27. +---------------------------+-----------------------------------------------------------+------------+
  28. .. rst-class:: classref-section-separator
  29. ----
  30. .. rst-class:: classref-descriptions-group
  31. Property Descriptions
  32. ---------------------
  33. .. _class_GLTFCamera_property_fov_size:
  34. .. rst-class:: classref-property
  35. :ref:`float<class_float>` **fov_size** = ``75.0``
  36. .. rst-class:: classref-property-setget
  37. - void **set_fov_size** **(** :ref:`float<class_float>` value **)**
  38. - :ref:`float<class_float>` **get_fov_size** **(** **)**
  39. .. container:: contribute
  40. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  41. .. rst-class:: classref-item-separator
  42. ----
  43. .. _class_GLTFCamera_property_perspective:
  44. .. rst-class:: classref-property
  45. :ref:`bool<class_bool>` **perspective** = ``true``
  46. .. rst-class:: classref-property-setget
  47. - void **set_perspective** **(** :ref:`bool<class_bool>` value **)**
  48. - :ref:`bool<class_bool>` **get_perspective** **(** **)**
  49. .. container:: contribute
  50. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  51. .. rst-class:: classref-item-separator
  52. ----
  53. .. _class_GLTFCamera_property_zfar:
  54. .. rst-class:: classref-property
  55. :ref:`float<class_float>` **zfar** = ``4000.0``
  56. .. rst-class:: classref-property-setget
  57. - void **set_zfar** **(** :ref:`float<class_float>` value **)**
  58. - :ref:`float<class_float>` **get_zfar** **(** **)**
  59. .. container:: contribute
  60. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  61. .. rst-class:: classref-item-separator
  62. ----
  63. .. _class_GLTFCamera_property_znear:
  64. .. rst-class:: classref-property
  65. :ref:`float<class_float>` **znear** = ``0.05``
  66. .. rst-class:: classref-property-setget
  67. - void **set_znear** **(** :ref:`float<class_float>` value **)**
  68. - :ref:`float<class_float>` **get_znear** **(** **)**
  69. .. container:: contribute
  70. There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  71. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  72. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  73. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  74. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`