
###############
HighlightHelper
###############

.. js:class:: cee.ug.HighlightHelper

   Helper class for highlighting objects in a :js:class:`RemoteModel <cee.ug.RemoteModel>` based on picking information.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.ug.HighlightHelper.constructor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.ug.HighlightHelper.add`
   * :js:meth:`~cee.ug.HighlightHelper.clearAll`
   * :js:meth:`~cee.ug.HighlightHelper.remove`
   * :js:meth:`~cee.ug.HighlightHelper.setMultiHighlight`
   * :js:meth:`~cee.ug.HighlightHelper.toggle`
   
   



.. rst-class:: kind-group kind-constructors

.. rubric:: Constructors
   :class: kind-group-title


.. js:method:: cee.ug.HighlightHelper.constructor

      .. rst-class:: sig-pretty-signature
      
         | HighlightHelper(**model**\ : :js:class:`RemoteModel <cee.ug.RemoteModel>`\ ): :js:class:`HighlightHelper <cee.ug.HighlightHelper>`
      
      Creates a new highlight helper for the given model.
      
      **Parameters**
      
      
         **model**\ : :js:class:`RemoteModel <cee.ug.RemoteModel>`
      
      
      **Returns**\ : :js:class:`HighlightHelper <cee.ug.HighlightHelper>`
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: cee.ug.HighlightHelper.add

      .. rst-class:: sig-pretty-signature
      
         | add(**objectType**\ : :js:data:`ObjectType <cee.ug.ObjectType>`\ , **objectId**\ : *number*\ , **geometryIndex**\ : *number*\ ): *void*
      
      Highlights the given object.
      
      **Parameters**
      
      
         **objectType**\ : :js:data:`ObjectType <cee.ug.ObjectType>`
      
         **objectId**\ : *number*
      
         **geometryIndex**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.HighlightHelper.clearAll

      .. rst-class:: sig-pretty-signature
      
         | clearAll(): *void*
      
      Removes highlighting from all objects.
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.HighlightHelper.remove

      .. rst-class:: sig-pretty-signature
      
         | remove(**objectType**\ : :js:data:`ObjectType <cee.ug.ObjectType>`\ , **objectId**\ : *number*\ , **geometryIndex**\ : *number*\ ): *void*
      
      Removes highlighting from the given object.
      
      **Parameters**
      
      
         **objectType**\ : :js:data:`ObjectType <cee.ug.ObjectType>`
      
         **objectId**\ : *number*
      
         **geometryIndex**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.HighlightHelper.setMultiHighlight

      .. rst-class:: sig-pretty-signature
      
         | setMultiHighlight(**multiHighlight**\ : *boolean*\ ): *void*
      
      Toggles whether multiple objects can be highlighted simultaneously.
      
      **Parameters**
      
      
         **multiHighlight**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.HighlightHelper.toggle

      .. rst-class:: sig-pretty-signature
      
         | toggle(**objectType**\ : :js:data:`ObjectType <cee.ug.ObjectType>`\ , **objectId**\ : *number*\ , **geometryIndex**\ : *number*\ ): *void*
      
      Toggles whether the given object is highlighted.
      
      **Parameters**
      
      
         **objectType**\ : :js:data:`ObjectType <cee.ug.ObjectType>`
      
         **objectId**\ : *number*
      
         **geometryIndex**\ : *number*
      
      
      **Returns**\ : *void*
      




