Model.reviewentity#

Model.reviewentity(entity, color=0, showcomps=False)#

Graphically reviews a specified entity.

Parameters:

  • entity (Entity) – The object describing 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.

Examples#

Review the component with ID 3 use color 10#
import hm
import hm.entities as ent

model = hm.Model()

model.reviewentity(entity=ent.Component(model, 3), color=10, showcomps=False)
Review the element with ID 4, along with its component, use color 10#
import hm
import hm.entities as ent

model = hm.Model()

model.reviewentity(entity=ent.Element(model, 4), color=10, showcomps=True)
On this page