.. _kaolin_vis-utils:

==================================
Visualization Utils
==================================


Interface Overview
##################

.. image:: /content/images/kaolin_viewport_ui.png

========== ================================== ====================================================================
Ref #      Option                             Result
========== ================================== ====================================================================
1          Scenes                             | Selects from several scene presets to change the lighting of the scene.
2          Mesh Settings                      | Opens the :ref:`kaolin_vis-utils_mesh`.
3          Pointcloud Settings                | Opens the :ref:`kaolin_vis-utils_pointcloud`.
4          Voxelgrid Settings                 | Opens the :ref:`kaolin_vis-utils_voxelgrid`.
========== ================================== ====================================================================

.. _kaolin_vis-utils_mesh:

Mesh Settings
###############

.. image:: /content/images/kaolin_viewport_ui_mesh-settings.png

========== ================================== ====================================================================
Ref #      Option                             Result
========== ================================== ====================================================================
1          Reset                              | Restores default settings
2          Wireframe Mode                     | Toggle between different wireframe modes: "None": standard shading, "Wireframe": unshaded polygon edges, "EdgeOnly": Shaded polygons. *Note: all meshes are automatically converted to triangular meshes by the renderer and will be displayed as such.*
========== ================================== ====================================================================

.. _kaolin_vis-utils_pointcloud:

Pointcloud Settings
###################

.. image:: /content/images/kaolin_viewport_ui_pointcloud-settings.png

========== ================================== ====================================================================
Ref #      Option                             Result
========== ================================== ====================================================================
1          Reset                              | Restores default settings
2          Pointcloud Mode                    | Select from two different pointcloud modes: "Default": New mode supporting large RGB pointclouds, "Spheres": Old mode using spheres to represent points. *Note: Not all pointclouds can be converted to "Sphere" mode. Valid pointclouds must have fewer than 5000 unique colors and fewer than 50,000 points.*
3          Sphere Size                        | Controls the size of points/spheres. *Note: When viewing a large number of points, it may be necessary to increase the "Sphere Size" setting to avoid missing point patches*
4          Shading color                      | Sets a shading color for uncolored pointclouds.
========== ================================== ====================================================================

.. _kaolin_vis-utils_voxelgrid:

Voxelgrid Settings
###################

.. image:: /content/images/kaolin_viewport_ui_voxelgrid-settings.png

========== ================================== ====================================================================
Ref #      Option                             Result
========== ================================== ====================================================================
1          Reset                              | Restores default settings
2          Show Edge                          | Reduces the size of the voxelgrid cubes to display an edge between adjacent cubes.
3          Shading color                      | Sets the shading color of voxelgrids in the scene.
========== ================================== ====================================================================