godot/modules/gltf/doc_classes/GLTFMesh.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFMesh" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		GLTFMesh represents a GLTF mesh.
	</brief_description>
	<description>
		GLTFMesh handles 3D mesh data imported from GLTF files. It includes properties for blend channels, blend weights, instance materials, and the mesh itself.
	</description>
	<tutorials>
		<link title="Runtime file loading and saving">$DOCS_URL/tutorials/io/runtime_file_loading_and_saving.html</link>
	</tutorials>
	<methods>
		<method name="get_additional_data">
			<return type="Variant" />
			<param index="0" name="extension_name" type="StringName" />
			<description>
				Gets additional arbitrary data in this [GLTFMesh] instance. This can be used to keep per-node state data in [GLTFDocumentExtension] classes, which is important because they are stateless.
				The argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the GLTF file), and the return value can be anything you set. If nothing was set, the return value is null.
			</description>
		</method>
		<method name="set_additional_data">
			<return type="void" />
			<param index="0" name="extension_name" type="StringName" />
			<param index="1" name="additional_data" type="Variant" />
			<description>
				Sets additional arbitrary data in this [GLTFMesh] instance. This can be used to keep per-node state data in [GLTFDocumentExtension] classes, which is important because they are stateless.
				The first argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the GLTF file), and the second argument can be anything you want.
			</description>
		</method>
	</methods>
	<members>
		<member name="blend_weights" type="PackedFloat32Array" setter="set_blend_weights" getter="get_blend_weights" default="PackedFloat32Array()">
			An array of floats representing the blend weights of the mesh.
		</member>
		<member name="instance_materials" type="Material[]" setter="set_instance_materials" getter="get_instance_materials" default="[]">
			An array of Material objects representing the materials used in the mesh.
		</member>
		<member name="mesh" type="ImporterMesh" setter="set_mesh" getter="get_mesh">
			The [ImporterMesh] object representing the mesh itself.
		</member>
		<member name="original_name" type="String" setter="set_original_name" getter="get_original_name" default="&quot;&quot;">
			The original name of the mesh.
		</member>
	</members>
</class>
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 08:08:05 +00:00			`<class name="GLTFMesh" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`<brief_description>`
[Doc] Fix some incorrect uses of `a/an` 2024-03-13 11:43:07 +00:00			`GLTFMesh represents a GLTF mesh.`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`</brief_description>`
			`<description>`
Add ufbx for FBX importing This update introduces a new import method for FBX files using ufbx. If the fbx2gltf import fails, it will use the most recently cached scene from the ufbx import. The process is sped up by introducing threads to load the ufbx portion. Key changes include: - Support for importing geometry helper nodes in FBX files. - Addition of cameras and lights with updated names. - Removal of the fbx importer manager. - Introduction of ModelDocument3D and updates to its methods. - Changes to FBX import options and visibility. - Updating the documentation and handling some errors. - Store the original non-unique node, mesh and animation names in FBX and glTF. Co-Authored-By: bqqbarbhg <bqqbarbhg@gmail.com> 2024-02-16 13:25:15 +00:00			`GLTFMesh handles 3D mesh data imported from GLTF files. It includes properties for blend channels, blend weights, instance materials, and the mesh itself.`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`</description>`
			`<tutorials>`
Link to runtime loading/saving tutorial and improve Image documentation 2023-11-13 13:37:27 +00:00			`<link title="Runtime file loading and saving">$DOCS_URL/tutorials/io/runtime_file_loading_and_saving.html</link>`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`</tutorials>`
Add ufbx for FBX importing This update introduces a new import method for FBX files using ufbx. If the fbx2gltf import fails, it will use the most recently cached scene from the ufbx import. The process is sped up by introducing threads to load the ufbx portion. Key changes include: - Support for importing geometry helper nodes in FBX files. - Addition of cameras and lights with updated names. - Removal of the fbx importer manager. - Introduction of ModelDocument3D and updates to its methods. - Changes to FBX import options and visibility. - Updating the documentation and handling some errors. - Store the original non-unique node, mesh and animation names in FBX and glTF. Co-Authored-By: bqqbarbhg <bqqbarbhg@gmail.com> 2024-02-16 13:25:15 +00:00			`<methods>`
			`<method name="get_additional_data">`
			`<return type="Variant" />`
			`<param index="0" name="extension_name" type="StringName" />`
			`<description>`
			`Gets additional arbitrary data in this [GLTFMesh] instance. This can be used to keep per-node state data in [GLTFDocumentExtension] classes, which is important because they are stateless.`
			`The argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the GLTF file), and the return value can be anything you set. If nothing was set, the return value is null.`
			`</description>`
			`</method>`
			`<method name="set_additional_data">`
			`<return type="void" />`
			`<param index="0" name="extension_name" type="StringName" />`
			`<param index="1" name="additional_data" type="Variant" />`
			`<description>`
			`Sets additional arbitrary data in this [GLTFMesh] instance. This can be used to keep per-node state data in [GLTFDocumentExtension] classes, which is important because they are stateless.`
			`The first argument should be the [GLTFDocumentExtension] name (does not have to match the extension name in the GLTF file), and the second argument can be anything you want.`
			`</description>`
			`</method>`
			`</methods>`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`<members>`
Better format arguments in variant parser 2019-09-24 17:45:03 +00:00			`<member name="blend_weights" type="PackedFloat32Array" setter="set_blend_weights" getter="get_blend_weights" default="PackedFloat32Array()">`
Add ufbx for FBX importing This update introduces a new import method for FBX files using ufbx. If the fbx2gltf import fails, it will use the most recently cached scene from the ufbx import. The process is sped up by introducing threads to load the ufbx portion. Key changes include: - Support for importing geometry helper nodes in FBX files. - Addition of cameras and lights with updated names. - Removal of the fbx importer manager. - Introduction of ModelDocument3D and updates to its methods. - Changes to FBX import options and visibility. - Updating the documentation and handling some errors. - Store the original non-unique node, mesh and animation names in FBX and glTF. Co-Authored-By: bqqbarbhg <bqqbarbhg@gmail.com> 2024-02-16 13:25:15 +00:00			`An array of floats representing the blend weights of the mesh.`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`</member>`
Change Array arguments to TypedArray 2022-08-31 17:24:04 +00:00			`<member name="instance_materials" type="Material[]" setter="set_instance_materials" getter="get_instance_materials" default="[]">`
Add ufbx for FBX importing This update introduces a new import method for FBX files using ufbx. If the fbx2gltf import fails, it will use the most recently cached scene from the ufbx import. The process is sped up by introducing threads to load the ufbx portion. Key changes include: - Support for importing geometry helper nodes in FBX files. - Addition of cameras and lights with updated names. - Removal of the fbx importer manager. - Introduction of ModelDocument3D and updates to its methods. - Changes to FBX import options and visibility. - Updating the documentation and handling some errors. - Store the original non-unique node, mesh and animation names in FBX and glTF. Co-Authored-By: bqqbarbhg <bqqbarbhg@gmail.com> 2024-02-16 13:25:15 +00:00			`An array of Material objects representing the materials used in the mesh.`
glTF: Fix override materials and non-empty arrays Keep track of MeshInstance and GeometryInstance override materials in the GLTFMesh object. Ensure all arrays are non-empty to conform with "minItems":1 in glTF spec. 2021-11-02 00:31:59 +00:00			`</member>`
GLTF for game templates. Convert GLTF Document to use ImporterMeshInstance3D. Add a GLTFDocument extension list and an extension for converting the importer mesh instance 3d to mesh instance 3d. Use GLTF module when the editor tools are disabled. Modified the render server to be less restrictive on matching blend arrays and have more logging. Misc bugs with multimesh. Always index the meshes. 2021-09-21 01:24:31 +00:00			`<member name="mesh" type="ImporterMesh" setter="set_mesh" getter="get_mesh">`
Add ufbx for FBX importing This update introduces a new import method for FBX files using ufbx. If the fbx2gltf import fails, it will use the most recently cached scene from the ufbx import. The process is sped up by introducing threads to load the ufbx portion. Key changes include: - Support for importing geometry helper nodes in FBX files. - Addition of cameras and lights with updated names. - Removal of the fbx importer manager. - Introduction of ModelDocument3D and updates to its methods. - Changes to FBX import options and visibility. - Updating the documentation and handling some errors. - Store the original non-unique node, mesh and animation names in FBX and glTF. Co-Authored-By: bqqbarbhg <bqqbarbhg@gmail.com> 2024-02-16 13:25:15 +00:00			`The [ImporterMesh] object representing the mesh itself.`
			`</member>`
			`<member name="original_name" type="String" setter="set_original_name" getter="get_original_name" default="""">`
			`The original name of the mesh.`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`</member>`
			`</members>`
			`</class>`