class_editorsceneformatimporter.rst 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  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:`EditorSceneFormatImporterFBX<class_EditorSceneFormatImporterFBX>`, :ref:`EditorSceneFormatImporterGLTF<class_EditorSceneFormatImporterGLTF>`
  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>` **(** :ref:`String<class_String>` path **)** |virtual| |
  28. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`Variant<class_Variant>` | :ref:`_get_option_visibility<class_EditorSceneFormatImporter_private_method__get_option_visibility>` **(** :ref:`String<class_String>` path, :ref:`bool<class_bool>` for_animation, :ref:`String<class_String>` option **)** |virtual| |const| |
  30. +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Object<class_Object>` | :ref:`_import_scene<class_EditorSceneFormatImporter_private_method__import_scene>` **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`Dictionary<class_Dictionary>` options **)** |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``
  41. .. _class_EditorSceneFormatImporter_constant_IMPORT_ANIMATION:
  42. .. rst-class:: classref-constant
  43. **IMPORT_ANIMATION** = ``2``
  44. .. _class_EditorSceneFormatImporter_constant_IMPORT_FAIL_ON_MISSING_DEPENDENCIES:
  45. .. rst-class:: classref-constant
  46. **IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = ``4``
  47. .. _class_EditorSceneFormatImporter_constant_IMPORT_GENERATE_TANGENT_ARRAYS:
  48. .. rst-class:: classref-constant
  49. **IMPORT_GENERATE_TANGENT_ARRAYS** = ``8``
  50. .. _class_EditorSceneFormatImporter_constant_IMPORT_USE_NAMED_SKIN_BINDS:
  51. .. rst-class:: classref-constant
  52. **IMPORT_USE_NAMED_SKIN_BINDS** = ``16``
  53. .. _class_EditorSceneFormatImporter_constant_IMPORT_DISCARD_MESHES_AND_MATERIALS:
  54. .. rst-class:: classref-constant
  55. **IMPORT_DISCARD_MESHES_AND_MATERIALS** = ``32``
  56. .. _class_EditorSceneFormatImporter_constant_IMPORT_FORCE_DISABLE_MESH_COMPRESSION:
  57. .. rst-class:: classref-constant
  58. **IMPORT_FORCE_DISABLE_MESH_COMPRESSION** = ``64``
  59. .. rst-class:: classref-section-separator
  60. ----
  61. .. rst-class:: classref-descriptions-group
  62. Method Descriptions
  63. -------------------
  64. .. _class_EditorSceneFormatImporter_private_method__get_extensions:
  65. .. rst-class:: classref-method
  66. :ref:`PackedStringArray<class_PackedStringArray>` **_get_extensions** **(** **)** |virtual| |const|
  67. .. container:: contribute
  68. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  69. .. rst-class:: classref-item-separator
  70. ----
  71. .. _class_EditorSceneFormatImporter_private_method__get_import_flags:
  72. .. rst-class:: classref-method
  73. :ref:`int<class_int>` **_get_import_flags** **(** **)** |virtual| |const|
  74. .. container:: contribute
  75. There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  76. .. rst-class:: classref-item-separator
  77. ----
  78. .. _class_EditorSceneFormatImporter_private_method__get_import_options:
  79. .. rst-class:: classref-method
  80. void **_get_import_options** **(** :ref:`String<class_String>` path **)** |virtual|
  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_option_visibility:
  86. .. rst-class:: classref-method
  87. :ref:`Variant<class_Variant>` **_get_option_visibility** **(** :ref:`String<class_String>` path, :ref:`bool<class_bool>` for_animation, :ref:`String<class_String>` option **)** |virtual| |const|
  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__import_scene:
  93. .. rst-class:: classref-method
  94. :ref:`Object<class_Object>` **_import_scene** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`Dictionary<class_Dictionary>` options **)** |virtual|
  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. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  98. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  99. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  100. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  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. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  103. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`