Skip to content

Latest commit

 

History

History
323 lines (189 loc) · 14 KB

class_meshconvexdecompositionsettings.rst

File metadata and controls

323 lines (189 loc) · 14 KB
github_url:hide

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

: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

.. rst-class:: classref-enumeration

enum Mode:

.. rst-class:: classref-enumeration-constant

:ref:`Mode<enum_MeshConvexDecompositionSettings_Mode>` CONVEX_DECOMPOSITION_MODE_VOXEL = 0

Constant for voxel-based approximate convex decomposition.

.. 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

.. rst-class:: classref-property

:ref:`bool<class_bool>` convex_hull_approximation = true

.. rst-class:: classref-property-setget

If enabled uses approximation for computing convex hulls.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`int<class_int>` convex_hull_downsampling = 4

.. rst-class:: classref-property-setget

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


.. rst-class:: classref-property

:ref:`float<class_float>` max_concavity = 1.0

.. rst-class:: classref-property-setget

Maximum concavity. Ranges from 0.0 to 1.0.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`int<class_int>` max_convex_hulls = 1

.. rst-class:: classref-property-setget

The maximum number of convex hulls to produce from the merge operation.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`int<class_int>` max_num_vertices_per_convex_hull = 32

.. rst-class:: classref-property-setget

Controls the maximum number of triangles per convex-hull. Ranges from 4 to 1024.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`float<class_float>` min_volume_per_convex_hull = 0.0001

.. rst-class:: classref-property-setget

Controls the adaptive sampling of the generated convex-hulls. Ranges from 0.0 to 0.01.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`Mode<enum_MeshConvexDecompositionSettings_Mode>` mode = 0

.. rst-class:: classref-property-setget

Mode for the approximate convex decomposition.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`bool<class_bool>` normalize_mesh = false

.. rst-class:: classref-property-setget

If enabled normalizes the mesh before applying the convex decomposition.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`int<class_int>` plane_downsampling = 4

.. rst-class:: classref-property-setget

Controls the granularity of the search for the "best" clipping plane. Ranges from 1 to 16.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`bool<class_bool>` project_hull_vertices = true

.. rst-class:: classref-property-setget

If enabled projects output convex hull vertices onto original source mesh to increase floating point accuracy of the results.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`int<class_int>` resolution = 10000

.. rst-class:: classref-property-setget

Maximum number of voxels generated during the voxelization stage.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`float<class_float>` revolution_axes_clipping_bias = 0.05

.. rst-class:: classref-property-setget

Controls the bias toward clipping along revolution axes. Ranges from 0.0 to 1.0.

.. rst-class:: classref-item-separator


.. rst-class:: classref-property

:ref:`float<class_float>` symmetry_planes_clipping_bias = 0.05

.. rst-class:: classref-property-setget

Controls the bias toward clipping along symmetry planes. Ranges from 0.0 to 1.0.