mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
5e9db0fd92
godot/doc/classes/MeshInstance3D.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

109 lines
5.4 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08: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-02-14 21:18:53 +08:00
<class name="MeshInstance3D" inherits="GeometryInstance3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<brief_description>
Node that instances meshes into a scenario.
</brief_description>
<description>
Fix add_surface_from_arrays description in classref Fix add_surface_from_arrays description in ImporterMesh.xml and ArrayMesh.xml to correctly describe sub-array length requirements. Also add missing comma in MeshInstance3D.xml, reword slightly.
2022-07-30 03:48:12 +08:00
MeshInstance3D is a node that takes a [Mesh] resource and adds it to the current scenario by creating an instance of it. This is the class most often used render 3D geometry and can be used to instance a single [Mesh] in many places. This allows reusing geometry, which can save on resources. When a [Mesh] has to be instantiated more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance3D] instead.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
<tutorials>
Link to demos from within the class reference
2020-10-01 16:34:47 +08:00
<link title="3D Material Testers Demo">https://godotengine.org/asset-library/asset/123</link>
<link title="3D Kinematic Character Demo">https://godotengine.org/asset-library/asset/126</link>
<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>
<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</tutorials>
<methods>
<method name="create_convex_collision">
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.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="clean" type="bool" default="true" />
<param index="1" name="simplify" type="bool" default="false" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-31 00:22:57 +08:00
This helper creates a [StaticBody3D] child node with a [ConvexPolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing.
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-12 21:36:48 +08:00
If [param clean] is [code]true[/code] (default), duplicate and interior vertices are removed automatically. You can set it to [code]false[/code] to make the process faster if not needed.
[doc] Fix grammar in class docs: amount vs. number Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases.
2022-08-18 06:08:09 +08:00
If [param simplify] is [code]true[/code], the geometry can be further simplified to reduce the number of vertices. Disabled by default.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source And typo fix from https://github.com/godotengine/godot-docs/pull/4882.
2021-04-29 18:10:58 +08:00
<method name="create_debug_tangents">
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.
2021-07-30 21:28:05 +08:00
<return type="void" />
Expose creating multiple-convex-collision static bodies to GDScript
2020-04-30 14:41:22 +08:00
<description>
doc: Sync classref with current source And typo fix from https://github.com/godotengine/godot-docs/pull/4882.
2021-04-29 18:10:58 +08:00
This helper creates a [MeshInstance3D] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing.
Expose creating multiple-convex-collision static bodies to GDScript
2020-04-30 14:41:22 +08:00
</description>
</method>
doc: Sync classref with current source And typo fix from https://github.com/godotengine/godot-docs/pull/4882.
2021-04-29 18:10:58 +08:00
<method name="create_multiple_convex_collisions">
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.
2021-07-30 21:28:05 +08:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
doc: Sync classref with current source And typo fix from https://github.com/godotengine/godot-docs/pull/4882.
2021-04-29 18:10:58 +08:00
This helper creates a [StaticBody3D] child node with multiple [ConvexPolygonShape3D] collision shapes calculated from the mesh geometry via convex decomposition. It's mainly used for testing.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="create_trimesh_collision">
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.
2021-07-30 21:28:05 +08:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-31 00:22:57 +08:00
This helper creates a [StaticBody3D] child node with a [ConcavePolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Implement Animation Blend Shape Tracks * New track type BLEND_SHAPE * Blend shapes are imported via this new track type * Processing is more optimized (no longer relies on variants) * Modified the Blend Shape API in MeshInstance3D to use indices rather than StringNames (more optimizes) * Promo: Fixed a small bug in gizmo updating in Node3D that affected performance Dedicated BlendShape tracks are required for both optimization and eventually implementing them in animation compression.
2021-10-16 06:04:35 +08:00
<method name="find_blend_shape_by_name">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="name" type="StringName" />
Implement Animation Blend Shape Tracks * New track type BLEND_SHAPE * Blend shapes are imported via this new track type * Processing is more optimized (no longer relies on variants) * Modified the Blend Shape API in MeshInstance3D to use indices rather than StringNames (more optimizes) * Promo: Fixed a small bug in gizmo updating in Node3D that affected performance Dedicated BlendShape tracks are required for both optimization and eventually implementing them in animation compression.
2021-10-16 06:04:35 +08:00
<description>
</description>
</method>
Add a method to retrieve active material from MeshInstance
2020-01-31 09:18:09 +08:00
<method name="get_active_material" qualifiers="const">
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.
2021-07-30 21:28:05 +08:00
<return type="Material" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="surface" type="int" />
Add a method to retrieve active material from MeshInstance
2020-01-31 09:18:09 +08:00
<description>
Returns the [Material] that will be used by the [Mesh] when drawing. This can return the [member GeometryInstance3D.material_override], the surface override [Material] defined in this [MeshInstance3D], or the surface [Material] defined in the [Mesh]. For example, if [member GeometryInstance3D.material_override] is used, all surfaces will return the override material.
</description>
</method>
Implement Animation Blend Shape Tracks * New track type BLEND_SHAPE * Blend shapes are imported via this new track type * Processing is more optimized (no longer relies on variants) * Modified the Blend Shape API in MeshInstance3D to use indices rather than StringNames (more optimizes) * Promo: Fixed a small bug in gizmo updating in Node3D that affected performance Dedicated BlendShape tracks are required for both optimization and eventually implementing them in animation compression.
2021-10-16 06:04:35 +08:00
<method name="get_blend_shape_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="get_blend_shape_value" qualifiers="const">
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="blend_shape_idx" type="int" />
Implement Animation Blend Shape Tracks * New track type BLEND_SHAPE * Blend shapes are imported via this new track type * Processing is more optimized (no longer relies on variants) * Modified the Blend Shape API in MeshInstance3D to use indices rather than StringNames (more optimizes) * Promo: Fixed a small bug in gizmo updating in Node3D that affected performance Dedicated BlendShape tracks are required for both optimization and eventually implementing them in animation compression.
2021-10-16 06:04:35 +08:00
<description>
</description>
</method>
Rename get_surface_material to get_surface_override_material
2021-04-14 11:45:16 +08:00
<method name="get_surface_override_material" qualifiers="const">
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.
2021-07-30 21:28:05 +08:00
<return type="Material" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="surface" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Add a method to retrieve active material from MeshInstance
2020-01-31 09:18:09 +08:00
Returns the override [Material] for the specified surface of the [Mesh] resource.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Rename get_surface_material to get_surface_override_material
2021-04-14 11:45:16 +08:00
<method name="get_surface_override_material_count" qualifiers="const">
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.
2021-07-30 21:28:05 +08:00
<return type="int" />
doc: Sync with current source
2018-10-25 21:14:36 +08:00
<description>
Rename get_surface_material to get_surface_override_material
2021-04-14 11:45:16 +08:00
Returns the number of surface override materials. This is equivalent to [method Mesh.get_surface_count].
doc: Sync with current source
2018-10-25 21:14:36 +08:00
</description>
</method>
Implement Animation Blend Shape Tracks * New track type BLEND_SHAPE * Blend shapes are imported via this new track type * Processing is more optimized (no longer relies on variants) * Modified the Blend Shape API in MeshInstance3D to use indices rather than StringNames (more optimizes) * Promo: Fixed a small bug in gizmo updating in Node3D that affected performance Dedicated BlendShape tracks are required for both optimization and eventually implementing them in animation compression.
2021-10-16 06:04:35 +08:00
<method name="set_blend_shape_value">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="blend_shape_idx" type="int" />
<param index="1" name="value" type="float" />
Implement Animation Blend Shape Tracks * New track type BLEND_SHAPE * Blend shapes are imported via this new track type * Processing is more optimized (no longer relies on variants) * Modified the Blend Shape API in MeshInstance3D to use indices rather than StringNames (more optimizes) * Promo: Fixed a small bug in gizmo updating in Node3D that affected performance Dedicated BlendShape tracks are required for both optimization and eventually implementing them in animation compression.
2021-10-16 06:04:35 +08:00
<description>
</description>
</method>
Rename get_surface_material to get_surface_override_material
2021-04-14 11:45:16 +08:00
<method name="set_surface_override_material">
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.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="surface" type="int" />
<param index="1" name="material" type="Material" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Add a method to retrieve active material from MeshInstance
2020-01-31 09:18:09 +08:00
Sets the override [Material] for the specified surface of the [Mesh] resource. This material is associated with this [MeshInstance3D] rather than with the [Mesh] resource.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
<members>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
The [Mesh] resource for the instance.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="skeleton" type="NodePath" setter="set_skeleton_path" getter="get_skeleton_path" default="NodePath(&quot;..&quot;)">
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-31 00:22:57 +08:00
[NodePath] to the [Skeleton3D] associated with the instance.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
<member name="skin" type="Skin" setter="set_skin" getter="get_skin">
Completed documentation for many visual nodes
2020-01-15 05:27:14 +08:00
Sets the skin to be used by this instance.
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</members>
</class>
Reference in New Issue Copy Permalink