Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 75b51ec2f4
Branches Tags
godot-docs
/
classes
/
class_gltfdocument.rst

class_gltfdocument.rst 7.8 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102 
  1. :github_url: hide
    2. 

  2. 

  3. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
    4. 

  4. .. DO NOT EDIT THIS FILE, but the GLTFDocument.xml source instead.
    5. 

  5. .. The source is found in doc/classes or modules/<name>/doc_classes.
    6. 

  6. 

  7. .. _class_GLTFDocument:
    8. 

  8. 

  9. GLTFDocument
    10. 

  10. ============
    11. 

  11. 

  12. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    13. 

  13. 

  14. 

  15. 

  16. Description
    17. 

  17. -----------
    18. 

  18. 

  19. Append a glTF2 3d format from a file, buffer or scene and then write to the filesystem, buffer or scene.
    20. 

  20. 

  21. Properties
    22. 

  22. ----------
    23. 

  23. 

  24. +-------------------------------------------------------------+-----------------------------------------------------------+--------+
    25. 

  25. | :ref:`GLTFDocumentExtension[]<class_GLTFDocumentExtension>` | :ref:`extensions<class_GLTFDocument_property_extensions>` | ``[]`` |
    26. 

  26. +-------------------------------------------------------------+-----------------------------------------------------------+--------+
    27. 

  27. 

  28. Methods
    29. 

  29. -------
    30. 

  30. 

  31. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`append_from_buffer<class_GLTFDocument_method_append_from_buffer>` **(** :ref:`PackedByteArray<class_PackedByteArray>` bytes, :ref:`String<class_String>` base_path, :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30 **)** |
    33. 

  33. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`append_from_file<class_GLTFDocument_method_append_from_file>` **(** :ref:`String<class_String>` path, :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30 **)**                                                               |
    35. 

  35. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`append_from_scene<class_GLTFDocument_method_append_from_scene>` **(** :ref:`Node<class_Node>` node, :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30 **)**                                                                 |
    37. 

  37. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`generate_buffer<class_GLTFDocument_method_generate_buffer>` **(** :ref:`GLTFState<class_GLTFState>` state **)**                                                                                                                                                                     |
    39. 

  39. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`Node<class_Node>`                       | :ref:`generate_scene<class_GLTFDocument_method_generate_scene>` **(** :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` bake_fps=30 **)**                                                                                                                                    |
    41. 

  41. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`Error<enum_@GlobalScope_Error>`         | :ref:`write_to_filesystem<class_GLTFDocument_method_write_to_filesystem>` **(** :ref:`GLTFState<class_GLTFState>` state, :ref:`String<class_String>` path **)**                                                                                                                           |
    43. 

  43. +-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. 

  45. Property Descriptions
    46. 

  46. ---------------------
    47. 

  47. 

  48. .. _class_GLTFDocument_property_extensions:
    49. 

  49. 

  50. - :ref:`GLTFDocumentExtension[]<class_GLTFDocumentExtension>` **extensions**
    51. 

  51. 

  52. +-----------+-----------------------+
    53. 

  53. | *Default* | ``[]``                |
    54. 

  54. +-----------+-----------------------+
    55. 

  55. | *Setter*  | set_extensions(value) |
    56. 

  56. +-----------+-----------------------+
    57. 

  57. | *Getter*  | get_extensions()      |
    58. 

  58. +-----------+-----------------------+
    59. 

  59. 

  60. Method Descriptions
    61. 

  61. -------------------
    62. 

  62. 

  63. .. _class_GLTFDocument_method_append_from_buffer:
    64. 

  64. 

  65. - :ref:`Error<enum_@GlobalScope_Error>` **append_from_buffer** **(** :ref:`PackedByteArray<class_PackedByteArray>` bytes, :ref:`String<class_String>` base_path, :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30 **)**
    66. 

  66. 

  67. ----
    68. 

  68. 

  69. .. _class_GLTFDocument_method_append_from_file:
    70. 

  70. 

  71. - :ref:`Error<enum_@GlobalScope_Error>` **append_from_file** **(** :ref:`String<class_String>` path, :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30 **)**
    72. 

  72. 

  73. ----
    74. 

  74. 

  75. .. _class_GLTFDocument_method_append_from_scene:
    76. 

  76. 

  77. - :ref:`Error<enum_@GlobalScope_Error>` **append_from_scene** **(** :ref:`Node<class_Node>` node, :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30 **)**
    78. 

  78. 

  79. ----
    80. 

  80. 

  81. .. _class_GLTFDocument_method_generate_buffer:
    82. 

  82. 

  83. - :ref:`PackedByteArray<class_PackedByteArray>` **generate_buffer** **(** :ref:`GLTFState<class_GLTFState>` state **)**
    84. 

  84. 

  85. ----
    86. 

  86. 

  87. .. _class_GLTFDocument_method_generate_scene:
    88. 

  88. 

  89. - :ref:`Node<class_Node>` **generate_scene** **(** :ref:`GLTFState<class_GLTFState>` state, :ref:`int<class_int>` bake_fps=30 **)**
    90. 

  90. 

  91. ----
    92. 

  92. 

  93. .. _class_GLTFDocument_method_write_to_filesystem:
    94. 

  94. 

  95. - :ref:`Error<enum_@GlobalScope_Error>` **write_to_filesystem** **(** :ref:`GLTFState<class_GLTFState>` state, :ref:`String<class_String>` path **)**
    96. 

  96. 

  97. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    98. 

  98. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    99. 

  99. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    100. 

  100. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    101. 

  101. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    102. 

  102. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    103.