Model.reviewentity_byname

Model.reviewentity_byname(entity_type, entity_name, color, showcomps=False)

Graphically reviews a specified entity, by providing the entity’s name.

Parameters:

• entity_type (EntityFullType) – The type of entity to review.

• entity_name (hwString) – The name of the entity to review

• color (int) –

  The color used to review the entity. Valid values are 1-64.

  If specified as 0, the entity will be reviewed with its respective entity color (not yet available).

• showcomps (bool) – This indicates that components in which elements/geometry are referred will also be reviewed. If not provided, only specified elements/geometry are reviewed.

Example

Review the component with name “comp1” use color 10

import hm
import hm.entities as ent

model = hm.Model()

model.reviewentity_byname(
    entity_type=ent.Component, entity_name="comp1", color=10, showcomps=False
)