asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/EditorSceneImporter.xml

78 lines
2.7 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00
<class name="EditorSceneImporter" inherits="Reference" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
<brief_description>
Add docs for EditorInterface, EditorPlugin and EditorSceneImporter
2019-07-20 15:41:42 +02:00
Imports scenes from third-parties' 3D files.
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
</brief_description>
<description>
Improve docs about plugin registration
2021-12-25 16:55:03 +01:00
[EditorSceneImporter] allows to define an importer script for a third-party 3D format.
To use [EditorSceneImporter], register it using the [method EditorPlugin.add_scene_import_plugin] method first.
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="_get_extensions" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Array" />
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
<description>
</description>
</method>
<method name="_get_import_flags" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
<description>
</description>
</method>
<method name="_import_animation" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Animation" />
<argument index="0" name="path" type="String" />
<argument index="1" name="flags" type="int" />
<argument index="2" name="bake_fps" type="int" />
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
<description>
</description>
</method>
<method name="_import_scene" qualifiers="virtual">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Node" />
<argument index="0" name="path" type="String" />
<argument index="1" name="flags" type="int" />
<argument index="2" name="bake_fps" type="int" />
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
<description>
</description>
</method>
<method name="import_animation_from_other_importer">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Animation" />
<argument index="0" name="path" type="String" />
<argument index="1" name="flags" type="int" />
<argument index="2" name="bake_fps" type="int" />
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
<description>
</description>
</method>
<method name="import_scene_from_other_importer">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Node" />
<argument index="0" name="path" type="String" />
<argument index="1" name="flags" type="int" />
<argument index="2" name="bake_fps" type="int" />
Added Mesh Compression Import Options Fleshed out the "Optimize Mesh" options found in the mesh import UI Gave a checkbox to every vertex attribute that can be compressed Surfaced option to enable/disable Octahedral compression for normal/tangent vectors Also surfaces the vertex position compression option which previously inaccessible because the defaults did not compress vertex positions Supports all current importers (obj, fbx, collada, gltf)
2021-05-10 22:51:11 +02:00
<argument index="3" name="compress_flags" type="int" />
doc: Sync classref with current source
2017-12-10 00:43:30 +01:00
<description>
</description>
</method>
</methods>
<constants>
<constant name="IMPORT_SCENE" value="1">
</constant>
<constant name="IMPORT_ANIMATION" value="2">
</constant>
<constant name="IMPORT_ANIMATION_DETECT_LOOP" value="4">
</constant>
<constant name="IMPORT_ANIMATION_OPTIMIZE" value="8">
</constant>
<constant name="IMPORT_ANIMATION_FORCE_ALL_TRACKS_IN_ALL_CLIPS" value="16">
</constant>
<constant name="IMPORT_ANIMATION_KEEP_VALUE_TRACKS" value="32">
</constant>
<constant name="IMPORT_GENERATE_TANGENT_ARRAYS" value="256">
</constant>
<constant name="IMPORT_FAIL_ON_MISSING_DEPENDENCIES" value="512">
</constant>
<constant name="IMPORT_MATERIALS_IN_INSTANCES" value="1024">
</constant>
</constants>
</class>
Reference in a new issue Copy permalink