class_editorsceneformatimporter.rst 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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. Description
  13. -----------
  14. ``EditorSceneFormatImporter`` allows to define an importer script for a third-party 3D format.
  15. To use ``EditorSceneFormatImporter``, register it using the :ref:`EditorPlugin.add_scene_format_importer_plugin<class_EditorPlugin_method_add_scene_format_importer_plugin>` method first.
  16. Methods
  17. -------
  18. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_get_extensions<class_EditorSceneFormatImporter_method__get_extensions>` **(** **)** |virtual| |const| |
  20. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`_get_import_flags<class_EditorSceneFormatImporter_method__get_import_flags>` **(** **)** |virtual| |const| |
  22. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`_get_import_options<class_EditorSceneFormatImporter_method__get_import_options>` **(** :ref:`String<class_String>` path **)** |virtual| |
  24. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`Variant<class_Variant>` | :ref:`_get_option_visibility<class_EditorSceneFormatImporter_method__get_option_visibility>` **(** :ref:`String<class_String>` path, :ref:`bool<class_bool>` for_animation, :ref:`String<class_String>` option **)** |virtual| |const| |
  26. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`Object<class_Object>` | :ref:`_import_scene<class_EditorSceneFormatImporter_method__import_scene>` **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`Dictionary<class_Dictionary>` options, :ref:`int<class_int>` bake_fps **)** |virtual| |
  28. +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. Constants
  30. ---------
  31. .. _class_EditorSceneFormatImporter_constant_IMPORT_SCENE:
  32. .. _class_EditorSceneFormatImporter_constant_IMPORT_ANIMATION:
  33. .. _class_EditorSceneFormatImporter_constant_IMPORT_FAIL_ON_MISSING_DEPENDENCIES:
  34. .. _class_EditorSceneFormatImporter_constant_IMPORT_GENERATE_TANGENT_ARRAYS:
  35. .. _class_EditorSceneFormatImporter_constant_IMPORT_USE_NAMED_SKIN_BINDS:
  36. .. _class_EditorSceneFormatImporter_constant_IMPORT_DISCARD_MESHES_AND_MATERIALS:
  37. - **IMPORT_SCENE** = **1**
  38. - **IMPORT_ANIMATION** = **2**
  39. - **IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = **4**
  40. - **IMPORT_GENERATE_TANGENT_ARRAYS** = **8**
  41. - **IMPORT_USE_NAMED_SKIN_BINDS** = **16**
  42. - **IMPORT_DISCARD_MESHES_AND_MATERIALS** = **32**
  43. Method Descriptions
  44. -------------------
  45. .. _class_EditorSceneFormatImporter_method__get_extensions:
  46. - :ref:`PackedStringArray<class_PackedStringArray>` **_get_extensions** **(** **)** |virtual| |const|
  47. ----
  48. .. _class_EditorSceneFormatImporter_method__get_import_flags:
  49. - :ref:`int<class_int>` **_get_import_flags** **(** **)** |virtual| |const|
  50. ----
  51. .. _class_EditorSceneFormatImporter_method__get_import_options:
  52. - void **_get_import_options** **(** :ref:`String<class_String>` path **)** |virtual|
  53. ----
  54. .. _class_EditorSceneFormatImporter_method__get_option_visibility:
  55. - :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|
  56. ----
  57. .. _class_EditorSceneFormatImporter_method__import_scene:
  58. - :ref:`Object<class_Object>` **_import_scene** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`Dictionary<class_Dictionary>` options, :ref:`int<class_int>` bake_fps **)** |virtual|
  59. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  60. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  61. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  62. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  63. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  64. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`