class_editorsceneformatimporter.rst 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorSceneFormatImporter.xml.
  6. .. _class_EditorSceneFormatImporter:
  7. EditorSceneFormatImporter
  8. =========================
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`EditorSceneFormatImporterBlend<class_EditorSceneFormatImporterBlend>`, :ref:`EditorSceneFormatImporterFBX2GLTF<class_EditorSceneFormatImporterFBX2GLTF>`, :ref:`EditorSceneFormatImporterGLTF<class_EditorSceneFormatImporterGLTF>`, :ref:`EditorSceneFormatImporterUFBX<class_EditorSceneFormatImporterUFBX>`
  11. Imports scenes from third-parties' 3D files.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. **EditorSceneFormatImporter** allows to define an importer script for a third-party 3D format.
  16. To use **EditorSceneFormatImporter**, register it using the :ref:`EditorPlugin.add_scene_format_importer_plugin<class_EditorPlugin_method_add_scene_format_importer_plugin>` method first.
  17. .. rst-class:: classref-reftable-group
  18. Methods
  19. -------
  20. .. table::
  21. :widths: auto
  22. +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_get_extensions<class_EditorSceneFormatImporter_private_method__get_extensions>`\ (\ ) |virtual| |const| |
  24. +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`_get_import_flags<class_EditorSceneFormatImporter_private_method__get_import_flags>`\ (\ ) |virtual| |const| |
  26. +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | |void| | :ref:`_get_import_options<class_EditorSceneFormatImporter_private_method__get_import_options>`\ (\ path\: :ref:`String<class_String>`\ ) |virtual| |
  28. +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`Variant<class_Variant>` | :ref:`_get_option_visibility<class_EditorSceneFormatImporter_private_method__get_option_visibility>`\ (\ path\: :ref:`String<class_String>`, for_animation\: :ref:`bool<class_bool>`, option\: :ref:`String<class_String>`\ ) |virtual| |const| |
  30. +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Object<class_Object>` | :ref:`_import_scene<class_EditorSceneFormatImporter_private_method__import_scene>`\ (\ path\: :ref:`String<class_String>`, flags\: :ref:`int<class_int>`, options\: :ref:`Dictionary<class_Dictionary>`\ ) |virtual| |
  32. +---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. .. rst-class:: classref-section-separator
  34. ----
  35. .. rst-class:: classref-descriptions-group
  36. Constants
  37. ---------
  38. .. _class_EditorSceneFormatImporter_constant_IMPORT_SCENE:
  39. .. rst-class:: classref-constant
  40. **IMPORT_SCENE** = ``1`` :ref:`🔗<class_EditorSceneFormatImporter_constant_IMPORT_SCENE>`
  41. .. container:: contribute
  42. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  43. .. _class_EditorSceneFormatImporter_constant_IMPORT_ANIMATION:
  44. .. rst-class:: classref-constant
  45. **IMPORT_ANIMATION** = ``2`` :ref:`🔗<class_EditorSceneFormatImporter_constant_IMPORT_ANIMATION>`
  46. .. container:: contribute
  47. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  48. .. _class_EditorSceneFormatImporter_constant_IMPORT_FAIL_ON_MISSING_DEPENDENCIES:
  49. .. rst-class:: classref-constant
  50. **IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = ``4`` :ref:`🔗<class_EditorSceneFormatImporter_constant_IMPORT_FAIL_ON_MISSING_DEPENDENCIES>`
  51. .. container:: contribute
  52. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  53. .. _class_EditorSceneFormatImporter_constant_IMPORT_GENERATE_TANGENT_ARRAYS:
  54. .. rst-class:: classref-constant
  55. **IMPORT_GENERATE_TANGENT_ARRAYS** = ``8`` :ref:`🔗<class_EditorSceneFormatImporter_constant_IMPORT_GENERATE_TANGENT_ARRAYS>`
  56. .. container:: contribute
  57. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  58. .. _class_EditorSceneFormatImporter_constant_IMPORT_USE_NAMED_SKIN_BINDS:
  59. .. rst-class:: classref-constant
  60. **IMPORT_USE_NAMED_SKIN_BINDS** = ``16`` :ref:`🔗<class_EditorSceneFormatImporter_constant_IMPORT_USE_NAMED_SKIN_BINDS>`
  61. .. container:: contribute
  62. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  63. .. _class_EditorSceneFormatImporter_constant_IMPORT_DISCARD_MESHES_AND_MATERIALS:
  64. .. rst-class:: classref-constant
  65. **IMPORT_DISCARD_MESHES_AND_MATERIALS** = ``32`` :ref:`🔗<class_EditorSceneFormatImporter_constant_IMPORT_DISCARD_MESHES_AND_MATERIALS>`
  66. .. container:: contribute
  67. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  68. .. _class_EditorSceneFormatImporter_constant_IMPORT_FORCE_DISABLE_MESH_COMPRESSION:
  69. .. rst-class:: classref-constant
  70. **IMPORT_FORCE_DISABLE_MESH_COMPRESSION** = ``64`` :ref:`🔗<class_EditorSceneFormatImporter_constant_IMPORT_FORCE_DISABLE_MESH_COMPRESSION>`
  71. .. container:: contribute
  72. There is currently no description for this constant. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  73. .. rst-class:: classref-section-separator
  74. ----
  75. .. rst-class:: classref-descriptions-group
  76. Method Descriptions
  77. -------------------
  78. .. _class_EditorSceneFormatImporter_private_method__get_extensions:
  79. .. rst-class:: classref-method
  80. :ref:`PackedStringArray<class_PackedStringArray>` **_get_extensions**\ (\ ) |virtual| |const| :ref:`🔗<class_EditorSceneFormatImporter_private_method__get_extensions>`
  81. .. container:: contribute
  82. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  83. .. rst-class:: classref-item-separator
  84. ----
  85. .. _class_EditorSceneFormatImporter_private_method__get_import_flags:
  86. .. rst-class:: classref-method
  87. :ref:`int<class_int>` **_get_import_flags**\ (\ ) |virtual| |const| :ref:`🔗<class_EditorSceneFormatImporter_private_method__get_import_flags>`
  88. .. container:: contribute
  89. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  90. .. rst-class:: classref-item-separator
  91. ----
  92. .. _class_EditorSceneFormatImporter_private_method__get_import_options:
  93. .. rst-class:: classref-method
  94. |void| **_get_import_options**\ (\ path\: :ref:`String<class_String>`\ ) |virtual| :ref:`🔗<class_EditorSceneFormatImporter_private_method__get_import_options>`
  95. .. container:: contribute
  96. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  97. .. rst-class:: classref-item-separator
  98. ----
  99. .. _class_EditorSceneFormatImporter_private_method__get_option_visibility:
  100. .. rst-class:: classref-method
  101. :ref:`Variant<class_Variant>` **_get_option_visibility**\ (\ path\: :ref:`String<class_String>`, for_animation\: :ref:`bool<class_bool>`, option\: :ref:`String<class_String>`\ ) |virtual| |const| :ref:`🔗<class_EditorSceneFormatImporter_private_method__get_option_visibility>`
  102. .. container:: contribute
  103. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  104. .. rst-class:: classref-item-separator
  105. ----
  106. .. _class_EditorSceneFormatImporter_private_method__import_scene:
  107. .. rst-class:: classref-method
  108. :ref:`Object<class_Object>` **_import_scene**\ (\ path\: :ref:`String<class_String>`, flags\: :ref:`int<class_int>`, options\: :ref:`Dictionary<class_Dictionary>`\ ) |virtual| :ref:`🔗<class_EditorSceneFormatImporter_private_method__import_scene>`
  109. .. container:: contribute
  110. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  111. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  112. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  113. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  114. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  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.)`
  116. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  117. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  118. .. |void| replace:: :abbr:`void (No return value.)`