Model.hm_highlightlist

Model.hm_highlightlist(entitylist, highlight, panel_sensitive=0)

Control the highlighting of a list of entities.

Parameters:

• entitylist (EntityList) – The entity list containing the input entities to control the highlighting for.

• highlight (hwString) –

  The state of the highlighting. Valid values are:

  l, low or lowlight - set to low (gray) highlighting

  n, norm or normal - set to normal (no) highlighting

  h, high or highlight - set to high (white) highlighting

• panel_sensitive (unsigned int) – Deprecated. Always set to 0.

Returns:

• hwReturnStatus - Status object

Example

Display a list of elements in a “low” state

import hm
import hm.entities as ent

model = hm.Model()

elem_list = hm.EntityListByInteractiveSelection(
    model, ent.Element, "Select the elements"
)

model.hm_highlightlist(entitylist=elem_list,highlight="low")