class_editorsceneimporter.rst 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  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/doc/classes/EditorSceneImporter.xml.
  6. .. _class_EditorSceneImporter:
  7. EditorSceneImporter
  8. ===================
  9. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`EditorSceneImporterFBX<class_EditorSceneImporterFBX>`, :ref:`EditorSceneImporterGLTF<class_EditorSceneImporterGLTF>`
  11. Imports scenes from third-parties' 3D files.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. **EditorSceneImporter** allows to define an importer script for a third-party 3D format.
  16. To use **EditorSceneImporter**, register it using the :ref:`EditorPlugin.add_scene_import_plugin<class_EditorPlugin_method_add_scene_import_plugin>` method first.
  17. .. rst-class:: classref-reftable-group
  18. Methods
  19. -------
  20. .. table::
  21. :widths: auto
  22. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`Array<class_Array>` | :ref:`_get_extensions<class_EditorSceneImporter_method__get_extensions>` **(** **)** |virtual| |
  24. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`_get_import_flags<class_EditorSceneImporter_method__get_import_flags>` **(** **)** |virtual| |
  26. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`Animation<class_Animation>` | :ref:`_import_animation<class_EditorSceneImporter_method__import_animation>` **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`int<class_int>` bake_fps **)** |virtual| |
  28. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`Node<class_Node>` | :ref:`_import_scene<class_EditorSceneImporter_method__import_scene>` **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`int<class_int>` bake_fps **)** |virtual| |
  30. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Animation<class_Animation>` | :ref:`import_animation_from_other_importer<class_EditorSceneImporter_method_import_animation_from_other_importer>` **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`int<class_int>` bake_fps **)** |
  32. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`Node<class_Node>` | :ref:`import_scene_from_other_importer<class_EditorSceneImporter_method_import_scene_from_other_importer>` **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`int<class_int>` bake_fps, :ref:`int<class_int>` compress_flags **)** |
  34. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. .. rst-class:: classref-section-separator
  36. ----
  37. .. rst-class:: classref-descriptions-group
  38. Constants
  39. ---------
  40. .. _class_EditorSceneImporter_constant_IMPORT_SCENE:
  41. .. rst-class:: classref-constant
  42. **IMPORT_SCENE** = ``1``
  43. .. _class_EditorSceneImporter_constant_IMPORT_ANIMATION:
  44. .. rst-class:: classref-constant
  45. **IMPORT_ANIMATION** = ``2``
  46. .. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_DETECT_LOOP:
  47. .. rst-class:: classref-constant
  48. **IMPORT_ANIMATION_DETECT_LOOP** = ``4``
  49. .. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_OPTIMIZE:
  50. .. rst-class:: classref-constant
  51. **IMPORT_ANIMATION_OPTIMIZE** = ``8``
  52. .. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_FORCE_ALL_TRACKS_IN_ALL_CLIPS:
  53. .. rst-class:: classref-constant
  54. **IMPORT_ANIMATION_FORCE_ALL_TRACKS_IN_ALL_CLIPS** = ``16``
  55. .. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_KEEP_VALUE_TRACKS:
  56. .. rst-class:: classref-constant
  57. **IMPORT_ANIMATION_KEEP_VALUE_TRACKS** = ``32``
  58. .. _class_EditorSceneImporter_constant_IMPORT_GENERATE_TANGENT_ARRAYS:
  59. .. rst-class:: classref-constant
  60. **IMPORT_GENERATE_TANGENT_ARRAYS** = ``256``
  61. .. _class_EditorSceneImporter_constant_IMPORT_FAIL_ON_MISSING_DEPENDENCIES:
  62. .. rst-class:: classref-constant
  63. **IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = ``512``
  64. .. _class_EditorSceneImporter_constant_IMPORT_MATERIALS_IN_INSTANCES:
  65. .. rst-class:: classref-constant
  66. **IMPORT_MATERIALS_IN_INSTANCES** = ``1024``
  67. .. rst-class:: classref-section-separator
  68. ----
  69. .. rst-class:: classref-descriptions-group
  70. Method Descriptions
  71. -------------------
  72. .. _class_EditorSceneImporter_method__get_extensions:
  73. .. rst-class:: classref-method
  74. :ref:`Array<class_Array>` **_get_extensions** **(** **)** |virtual|
  75. .. container:: contribute
  76. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  77. .. rst-class:: classref-item-separator
  78. ----
  79. .. _class_EditorSceneImporter_method__get_import_flags:
  80. .. rst-class:: classref-method
  81. :ref:`int<class_int>` **_get_import_flags** **(** **)** |virtual|
  82. .. container:: contribute
  83. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  84. .. rst-class:: classref-item-separator
  85. ----
  86. .. _class_EditorSceneImporter_method__import_animation:
  87. .. rst-class:: classref-method
  88. :ref:`Animation<class_Animation>` **_import_animation** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`int<class_int>` bake_fps **)** |virtual|
  89. .. container:: contribute
  90. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  91. .. rst-class:: classref-item-separator
  92. ----
  93. .. _class_EditorSceneImporter_method__import_scene:
  94. .. rst-class:: classref-method
  95. :ref:`Node<class_Node>` **_import_scene** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`int<class_int>` bake_fps **)** |virtual|
  96. .. container:: contribute
  97. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  98. .. rst-class:: classref-item-separator
  99. ----
  100. .. _class_EditorSceneImporter_method_import_animation_from_other_importer:
  101. .. rst-class:: classref-method
  102. :ref:`Animation<class_Animation>` **import_animation_from_other_importer** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`int<class_int>` bake_fps **)**
  103. .. container:: contribute
  104. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  105. .. rst-class:: classref-item-separator
  106. ----
  107. .. _class_EditorSceneImporter_method_import_scene_from_other_importer:
  108. .. rst-class:: classref-method
  109. :ref:`Node<class_Node>` **import_scene_from_other_importer** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`int<class_int>` bake_fps, :ref:`int<class_int>` compress_flags **)**
  110. .. container:: contribute
  111. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  112. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  113. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  114. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  115. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`