class_gltfdocument.rst 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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 GLTFDocument.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_GLTFDocument:
  6. GLTFDocument
  7. ============
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +-------------------------------------------------------------+-----------------------------------------------------------+--------+
  12. | :ref:`GLTFDocumentExtension[]<class_GLTFDocumentExtension>` | :ref:`extensions<class_GLTFDocument_property_extensions>` | ``[]`` |
  13. +-------------------------------------------------------------+-----------------------------------------------------------+--------+
  14. Methods
  15. -------
  16. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`Node<class_Node>` | :ref:`import_scene<class_GLTFDocument_method_import_scene>` **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30, :ref:`GLTFState<class_GLTFState>` state=null **)** |
  18. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`save_scene<class_GLTFDocument_method_save_scene>` **(** :ref:`Node<class_Node>` node, :ref:`String<class_String>` path, :ref:`String<class_String>` src_path, :ref:`int<class_int>` flags=0, :ref:`float<class_float>` bake_fps=30, :ref:`GLTFState<class_GLTFState>` state=null **)** |
  20. +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. Property Descriptions
  22. ---------------------
  23. .. _class_GLTFDocument_property_extensions:
  24. - :ref:`GLTFDocumentExtension[]<class_GLTFDocumentExtension>` **extensions**
  25. +-----------+-----------------------+
  26. | *Default* | ``[]`` |
  27. +-----------+-----------------------+
  28. | *Setter* | set_extensions(value) |
  29. +-----------+-----------------------+
  30. | *Getter* | get_extensions() |
  31. +-----------+-----------------------+
  32. Method Descriptions
  33. -------------------
  34. .. _class_GLTFDocument_method_import_scene:
  35. - :ref:`Node<class_Node>` **import_scene** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags=0, :ref:`int<class_int>` bake_fps=30, :ref:`GLTFState<class_GLTFState>` state=null **)**
  36. Import a scene from glTF2 ".gltf" or ".glb" file.
  37. ----
  38. .. _class_GLTFDocument_method_save_scene:
  39. - :ref:`Error<enum_@GlobalScope_Error>` **save_scene** **(** :ref:`Node<class_Node>` node, :ref:`String<class_String>` path, :ref:`String<class_String>` src_path, :ref:`int<class_int>` flags=0, :ref:`float<class_float>` bake_fps=30, :ref:`GLTFState<class_GLTFState>` state=null **)**
  40. Save a scene as a glTF2 ".glb" or ".gltf" file.
  41. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  42. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  43. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  44. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  45. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  46. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`