class_editorsceneimporter.rst 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  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 EditorSceneImporter.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_EditorSceneImporter:
  6. EditorSceneImporter
  7. ===================
  8. **Inherits:** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`EditorSceneImporterFBX<class_EditorSceneImporterFBX>`, :ref:`EditorSceneImporterGLTF<class_EditorSceneImporterGLTF>`
  10. Imports scenes from third-parties' 3D files.
  11. Description
  12. -----------
  13. ``EditorSceneImporter`` allows to define an importer script for a third-party 3D format.
  14. To use ``EditorSceneImporter``, register it using the :ref:`EditorPlugin.add_scene_import_plugin<class_EditorPlugin_method_add_scene_import_plugin>` method first.
  15. Methods
  16. -------
  17. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  18. | :ref:`Array<class_Array>` | :ref:`_get_extensions<class_EditorSceneImporter_method__get_extensions>` **(** **)** |virtual| |
  19. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  20. | :ref:`int<class_int>` | :ref:`_get_import_flags<class_EditorSceneImporter_method__get_import_flags>` **(** **)** |virtual| |
  21. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :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| |
  23. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :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| |
  25. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :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 **)** |
  27. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :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 **)** |
  29. +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. Constants
  31. ---------
  32. .. _class_EditorSceneImporter_constant_IMPORT_SCENE:
  33. .. _class_EditorSceneImporter_constant_IMPORT_ANIMATION:
  34. .. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_DETECT_LOOP:
  35. .. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_OPTIMIZE:
  36. .. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_FORCE_ALL_TRACKS_IN_ALL_CLIPS:
  37. .. _class_EditorSceneImporter_constant_IMPORT_ANIMATION_KEEP_VALUE_TRACKS:
  38. .. _class_EditorSceneImporter_constant_IMPORT_GENERATE_TANGENT_ARRAYS:
  39. .. _class_EditorSceneImporter_constant_IMPORT_FAIL_ON_MISSING_DEPENDENCIES:
  40. .. _class_EditorSceneImporter_constant_IMPORT_MATERIALS_IN_INSTANCES:
  41. - **IMPORT_SCENE** = **1**
  42. - **IMPORT_ANIMATION** = **2**
  43. - **IMPORT_ANIMATION_DETECT_LOOP** = **4**
  44. - **IMPORT_ANIMATION_OPTIMIZE** = **8**
  45. - **IMPORT_ANIMATION_FORCE_ALL_TRACKS_IN_ALL_CLIPS** = **16**
  46. - **IMPORT_ANIMATION_KEEP_VALUE_TRACKS** = **32**
  47. - **IMPORT_GENERATE_TANGENT_ARRAYS** = **256**
  48. - **IMPORT_FAIL_ON_MISSING_DEPENDENCIES** = **512**
  49. - **IMPORT_MATERIALS_IN_INSTANCES** = **1024**
  50. Method Descriptions
  51. -------------------
  52. .. _class_EditorSceneImporter_method__get_extensions:
  53. - :ref:`Array<class_Array>` **_get_extensions** **(** **)** |virtual|
  54. ----
  55. .. _class_EditorSceneImporter_method__get_import_flags:
  56. - :ref:`int<class_int>` **_get_import_flags** **(** **)** |virtual|
  57. ----
  58. .. _class_EditorSceneImporter_method__import_animation:
  59. - :ref:`Animation<class_Animation>` **_import_animation** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`int<class_int>` bake_fps **)** |virtual|
  60. ----
  61. .. _class_EditorSceneImporter_method__import_scene:
  62. - :ref:`Node<class_Node>` **_import_scene** **(** :ref:`String<class_String>` path, :ref:`int<class_int>` flags, :ref:`int<class_int>` bake_fps **)** |virtual|
  63. ----
  64. .. _class_EditorSceneImporter_method_import_animation_from_other_importer:
  65. - :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 **)**
  66. ----
  67. .. _class_EditorSceneImporter_method_import_scene_from_other_importer:
  68. - :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 **)**
  69. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  70. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  71. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`