.. role:: ts-api-decorator

.. _cee.HighlightMode:

#############
HighlightMode
#############

.. js:module:: cee
   :noindex:

.. container:: ts-api-section

   Modes specifying how to render the highlighted parts from the models in the view.

   **Examples of the different highlight modes:**

   .. image:: ../../images/HighlightMode.png





.. container:: api-index-section

   .. rubric:: Enumeration Members

   .. rst-class:: api-index-list-item api-kind-enummember api-parent-kind-enum

   * :ref:`cee.HighlightMode.DEPTH_BASED_DIMMING`
   * :ref:`cee.HighlightMode.OFF`
   * :ref:`cee.HighlightMode.SIMPLE`





------------

Enumeration Members
===================

.. rst-class:: ts-api-section

.. _cee.HighlightMode.DEPTH_BASED_DIMMING:

DEPTH_BASED_DIMMING
-------------------

Draw a halo around the silhouette of the part. The parts of the halo that is obscured by parts of the model 
will be dimmed down. Parts not being highlighted will also be dimmed down depending on the 
``View.nonHighlightedDimFactor`` setting.

.. rst-class:: ts-api-section

.. _cee.HighlightMode.OFF:

OFF
---

Disable halo/silhouette highlighting. Highlight setting is ignored.

.. rst-class:: ts-api-section

.. _cee.HighlightMode.SIMPLE:

SIMPLE
------

Simple halo highlighting, drawing a halo around the silhouette of the part

