virtualx-engine/doc/classes/ResourceImporterOBJ.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceImporterOBJ" inherits="ResourceImporter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Imports an OBJ 3D model as a standalone [Mesh] or scene.
	</brief_description>
	<description>
		Unlike [ResourceImporterScene], [ResourceImporterOBJ] will import a single [Mesh] resource by default instead of importing a [PackedScene]. This makes it easier to use the [Mesh] resource in nodes that expect direct [Mesh] resources, such as [GridMap], [GPUParticles3D] or [CPUParticles3D]. Note that it is still possible to save mesh resources from 3D scenes using the [b]Advanced Import Settings[/b] dialog, regardless of the source format.
		See also [ResourceImporterScene], which is used for more advanced 3D formats such as glTF.
	</description>
	<tutorials>
		<link title="Importing 3D scenes">$DOCS_URL/tutorials/assets_pipeline/importing_scenes.html</link>
	</tutorials>
	<members>
		<member name="generate_tangents" type="bool" setter="" getter="" default="true">
			If [code]true[/code], generate vertex tangents using [url=http://www.mikktspace.com/]Mikktspace[/url] if the source mesh doesn't have tangent data. When possible, it's recommended to let the 3D modeling software generate tangents on export instead on relying on this option. Tangents are required for correct display of normal and height maps, along with any material/shader features that require tangents.
			If you don't need material features that require tangents, disabling this can reduce output file size and speed up importing if the source 3D file doesn't contain tangents.
		</member>
		<member name="offset_mesh" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
			Offsets the mesh's data by the specified value. This can be used to work around misaligned meshes without having to modify the source file.
		</member>
		<member name="optimize_mesh" type="bool" setter="" getter="" default="true">
			Unused parameter. This currently has no effect.
		</member>
		<member name="scale_mesh" type="Vector3" setter="" getter="" default="Vector3(1, 1, 1)">
			Scales the mesh's data by the specified value. This can be used to work around misscaled meshes without having to modify the source file.
		</member>
	</members>
</class>
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Fix documentation validation after 8352122e70ec2a582af9a713791eabbbcb935c10 2023-07-12 17:30:34 +02:00			`<class name="ResourceImporterOBJ" inherits="ResourceImporter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`<brief_description>`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`Imports an OBJ 3D model as a standalone [Mesh] or scene.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</brief_description>`
			`<description>`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`Unlike [ResourceImporterScene], [ResourceImporterOBJ] will import a single [Mesh] resource by default instead of importing a [PackedScene]. This makes it easier to use the [Mesh] resource in nodes that expect direct [Mesh] resources, such as [GridMap], [GPUParticles3D] or [CPUParticles3D]. Note that it is still possible to save mesh resources from 3D scenes using the [b]Advanced Import Settings[/b] dialog, regardless of the source format.`
			`See also [ResourceImporterScene], which is used for more advanced 3D formats such as glTF.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</description>`
			`<tutorials>`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`<link title="Importing 3D scenes">$DOCS_URL/tutorials/assets_pipeline/importing_scenes.html</link>`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</tutorials>`
			`<members>`
			`<member name="generate_tangents" type="bool" setter="" getter="" default="true">`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`If [code]true[/code], generate vertex tangents using [url=http://www.mikktspace.com/]Mikktspace[/url] if the source mesh doesn't have tangent data. When possible, it's recommended to let the 3D modeling software generate tangents on export instead on relying on this option. Tangents are required for correct display of normal and height maps, along with any material/shader features that require tangents.`
			`If you don't need material features that require tangents, disabling this can reduce output file size and speed up importing if the source 3D file doesn't contain tangents.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</member>`
			`<member name="offset_mesh" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`Offsets the mesh's data by the specified value. This can be used to work around misaligned meshes without having to modify the source file.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</member>`
			`<member name="optimize_mesh" type="bool" setter="" getter="" default="true">`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`Unused parameter. This currently has no effect.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</member>`
			`<member name="scale_mesh" type="Vector3" setter="" getter="" default="Vector3(1, 1, 1)">`
Fill in descriptions for import options in the class reference 2023-07-13 02:25:33 +02:00			`Scales the mesh's data by the specified value. This can be used to work around misscaled meshes without having to modify the source file.`
Document editor import options in the class reference Tooltips are displayed when hovering import options, both in the Import dock and in the import defaults editor (which is in the Project Settings). Co-authored-by: Rémi Verschelde <rverschelde@gmail.com> 2021-05-13 22:34:34 +02:00			`</member>`
			`</members>`
			`</class>`