mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
325 lines
15 KiB
ReStructuredText
325 lines
15 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/MeshConvexDecompositionSettings.xml.
|
|
|
|
.. _class_MeshConvexDecompositionSettings:
|
|
|
|
MeshConvexDecompositionSettings
|
|
===============================
|
|
|
|
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Parameters to be used with a :ref:`Mesh<class_Mesh>` convex decomposition operation.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Parameters to be used with a :ref:`Mesh<class_Mesh>` convex decomposition operation.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`bool<class_bool>` | :ref:`convex_hull_approximation<class_MeshConvexDecompositionSettings_property_convex_hull_approximation>` | ``true`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`int<class_int>` | :ref:`convex_hull_downsampling<class_MeshConvexDecompositionSettings_property_convex_hull_downsampling>` | ``4`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`float<class_float>` | :ref:`max_concavity<class_MeshConvexDecompositionSettings_property_max_concavity>` | ``1.0`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`int<class_int>` | :ref:`max_convex_hulls<class_MeshConvexDecompositionSettings_property_max_convex_hulls>` | ``1`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`int<class_int>` | :ref:`max_num_vertices_per_convex_hull<class_MeshConvexDecompositionSettings_property_max_num_vertices_per_convex_hull>` | ``32`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`float<class_float>` | :ref:`min_volume_per_convex_hull<class_MeshConvexDecompositionSettings_property_min_volume_per_convex_hull>` | ``0.0001`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`Mode<enum_MeshConvexDecompositionSettings_Mode>` | :ref:`mode<class_MeshConvexDecompositionSettings_property_mode>` | ``0`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`bool<class_bool>` | :ref:`normalize_mesh<class_MeshConvexDecompositionSettings_property_normalize_mesh>` | ``false`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`int<class_int>` | :ref:`plane_downsampling<class_MeshConvexDecompositionSettings_property_plane_downsampling>` | ``4`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`bool<class_bool>` | :ref:`project_hull_vertices<class_MeshConvexDecompositionSettings_property_project_hull_vertices>` | ``true`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`int<class_int>` | :ref:`resolution<class_MeshConvexDecompositionSettings_property_resolution>` | ``10000`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`float<class_float>` | :ref:`revolution_axes_clipping_bias<class_MeshConvexDecompositionSettings_property_revolution_axes_clipping_bias>` | ``0.05`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
| :ref:`float<class_float>` | :ref:`symmetry_planes_clipping_bias<class_MeshConvexDecompositionSettings_property_symmetry_planes_clipping_bias>` | ``0.05`` |
|
|
+--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_MeshConvexDecompositionSettings_Mode:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **Mode**: :ref:`🔗<enum_MeshConvexDecompositionSettings_Mode>`
|
|
|
|
.. _class_MeshConvexDecompositionSettings_constant_CONVEX_DECOMPOSITION_MODE_VOXEL:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Mode<enum_MeshConvexDecompositionSettings_Mode>` **CONVEX_DECOMPOSITION_MODE_VOXEL** = ``0``
|
|
|
|
Constant for voxel-based approximate convex decomposition.
|
|
|
|
.. _class_MeshConvexDecompositionSettings_constant_CONVEX_DECOMPOSITION_MODE_TETRAHEDRON:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`Mode<enum_MeshConvexDecompositionSettings_Mode>` **CONVEX_DECOMPOSITION_MODE_TETRAHEDRON** = ``1``
|
|
|
|
Constant for tetrahedron-based approximate convex decomposition.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_convex_hull_approximation:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **convex_hull_approximation** = ``true`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_convex_hull_approximation>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_convex_hull_approximation**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **get_convex_hull_approximation**\ (\ )
|
|
|
|
If ``true``, uses approximation for computing convex hulls.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_convex_hull_downsampling:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **convex_hull_downsampling** = ``4`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_convex_hull_downsampling>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_convex_hull_downsampling**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_convex_hull_downsampling**\ (\ )
|
|
|
|
Controls the precision of the convex-hull generation process during the clipping plane selection stage. Ranges from ``1`` to ``16``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_max_concavity:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **max_concavity** = ``1.0`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_max_concavity>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_max_concavity**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **get_max_concavity**\ (\ )
|
|
|
|
Maximum concavity. Ranges from ``0.0`` to ``1.0``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_max_convex_hulls:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **max_convex_hulls** = ``1`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_max_convex_hulls>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_max_convex_hulls**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_max_convex_hulls**\ (\ )
|
|
|
|
The maximum number of convex hulls to produce from the merge operation.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_max_num_vertices_per_convex_hull:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **max_num_vertices_per_convex_hull** = ``32`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_max_num_vertices_per_convex_hull>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_max_num_vertices_per_convex_hull**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_max_num_vertices_per_convex_hull**\ (\ )
|
|
|
|
Controls the maximum number of triangles per convex-hull. Ranges from ``4`` to ``1024``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_min_volume_per_convex_hull:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **min_volume_per_convex_hull** = ``0.0001`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_min_volume_per_convex_hull>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_min_volume_per_convex_hull**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **get_min_volume_per_convex_hull**\ (\ )
|
|
|
|
Controls the adaptive sampling of the generated convex-hulls. Ranges from ``0.0`` to ``0.01``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_mode:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Mode<enum_MeshConvexDecompositionSettings_Mode>` **mode** = ``0`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_mode>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_mode**\ (\ value\: :ref:`Mode<enum_MeshConvexDecompositionSettings_Mode>`\ )
|
|
- :ref:`Mode<enum_MeshConvexDecompositionSettings_Mode>` **get_mode**\ (\ )
|
|
|
|
Mode for the approximate convex decomposition.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_normalize_mesh:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **normalize_mesh** = ``false`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_normalize_mesh>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_normalize_mesh**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **get_normalize_mesh**\ (\ )
|
|
|
|
If ``true``, normalizes the mesh before applying the convex decomposition.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_plane_downsampling:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **plane_downsampling** = ``4`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_plane_downsampling>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_plane_downsampling**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_plane_downsampling**\ (\ )
|
|
|
|
Controls the granularity of the search for the "best" clipping plane. Ranges from ``1`` to ``16``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_project_hull_vertices:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **project_hull_vertices** = ``true`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_project_hull_vertices>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_project_hull_vertices**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **get_project_hull_vertices**\ (\ )
|
|
|
|
If ``true``, projects output convex hull vertices onto the original source mesh to increase floating-point accuracy of the results.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_resolution:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **resolution** = ``10000`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_resolution>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_resolution**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_resolution**\ (\ )
|
|
|
|
Maximum number of voxels generated during the voxelization stage.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_revolution_axes_clipping_bias:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **revolution_axes_clipping_bias** = ``0.05`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_revolution_axes_clipping_bias>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_revolution_axes_clipping_bias**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **get_revolution_axes_clipping_bias**\ (\ )
|
|
|
|
Controls the bias toward clipping along revolution axes. Ranges from ``0.0`` to ``1.0``.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_MeshConvexDecompositionSettings_property_symmetry_planes_clipping_bias:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **symmetry_planes_clipping_bias** = ``0.05`` :ref:`🔗<class_MeshConvexDecompositionSettings_property_symmetry_planes_clipping_bias>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_symmetry_planes_clipping_bias**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **get_symmetry_planes_clipping_bias**\ (\ )
|
|
|
|
Controls the bias toward clipping along symmetry planes. Ranges from ``0.0`` to ``1.0``.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
|
.. |void| replace:: :abbr:`void (No return value.)`
|