.. role:: ts-api-decorator

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

.. js:module:: cee.ug
   :noindex:

.. container:: ts-api-section

   .. js:class:: HighlightHelper

      Helper class for highlighting objects in a ``RemoteModel`` based on picking information.



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~cee.ug.HighlightHelper.constructor`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :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`





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

Constructors
============

.. container:: ts-api-section

   .. js:function:: HighlightHelper.constructor( model)

      :param model: None
      :type model: RemoteModel


      Creates a new highlight helper for the given model.


      :rtype: HighlightHelper



Methods
=======

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

add
---

.. js:method:: HighlightHelper.add( objectType, objectId, geometryIndex)

   :param objectType: None
   :type objectType: ObjectType
   :param objectId: None
   :type objectId: number
   :param geometryIndex: None
   :type geometryIndex: number


   Highlights the given object.


   :rtype: void

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

clearAll
--------

.. js:method:: HighlightHelper.clearAll()



   Removes highlighting from all objects.


   :rtype: void

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

remove
------

.. js:method:: HighlightHelper.remove( objectType, objectId, geometryIndex)

   :param objectType: None
   :type objectType: ObjectType
   :param objectId: None
   :type objectId: number
   :param geometryIndex: None
   :type geometryIndex: number


   Removes highlighting from the given object.


   :rtype: void

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

setMultiHighlight
-----------------

.. js:method:: HighlightHelper.setMultiHighlight( multiHighlight)

   :param multiHighlight: None
   :type multiHighlight: boolean


   Toggles whether multiple objects can be highlighted simultaneously.


   :rtype: void

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

toggle
------

.. js:method:: HighlightHelper.toggle( objectType, objectId, geometryIndex)

   :param objectType: None
   :type objectType: ObjectType
   :param objectId: None
   :type objectId: number
   :param geometryIndex: None
   :type geometryIndex: number


   Toggles whether the given object is highlighted.


   :rtype: void

