# HighlightHelper

class `cee.ug.``HighlightHelper`()

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

Constructors

- `constructor`

Methods

- `add`
- `clearAll`
- `remove`
- `setMultiHighlight`
- `toggle`

## Constructors

`HighlightHelper.``constructor`(model)

  Arguments: | model (`RemoteModel`) – None

  Creates a new highlight helper for the given model.

  Return type: | HighlightHelper

## Methods

### add

`HighlightHelper.``add`(objectType, objectId, geometryIndex)

  Arguments: | objectType (`ObjectType`) – None objectId (`number`) – None geometryIndex (`number`) – None

  Highlights the given object.

  Return type: | void

### clearAll

`HighlightHelper.``clearAll`()

  Removes highlighting from all objects.

  Return type: | void

### remove

`HighlightHelper.``remove`(objectType, objectId, geometryIndex)

  Arguments: | objectType (`ObjectType`) – None objectId (`number`) – None geometryIndex (`number`) – None

  Removes highlighting from the given object.

  Return type: | void

### setMultiHighlight

`HighlightHelper.``setMultiHighlight`(multiHighlight)

  Arguments: | multiHighlight (`boolean`) – None

  Toggles whether multiple objects can be highlighted simultaneously.

  Return type: | void

### toggle

`HighlightHelper.``toggle`(objectType, objectId, geometryIndex)

  Arguments: | objectType (`ObjectType`) – None objectId (`number`) – None geometryIndex (`number`) – None

  Toggles whether the given object is highlighted.

  Return type: | void

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Envision for Web or choose a sample question below to start a conversation:

What is HOOPS Envision for Web?
What are the latest release notes for HOOPS Envision for Web?
How do I start evaluating HOOPS Envision for Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...