Model.setreviewbyid#

Model.setreviewbyid(entity, color, review_type)#

Adds entities to the review list based on an entity.

Parameters:
  • entity (Entity) – The object describing the entity to add to review list. Valid entities are blocks and groups.

  • color (int) – The color to use for review of the entity. Valid values are 1-64.

  • review_type (int) –

    The review type to control.

    For blocks:

    1 - Nodes

    2 - Elements

    For groups:

    1 - Secondary only

    2 - Main only

    3 - Main and secondary

Example#

Review only secondary elements from group with ID 5 with color 4 , with all other non - reviewed entities have transparency and gray color#
import hm
import hm.entities as ent

model = hm.Model()

model.setreviewbyid(entity=ent.Group(model, 5), color=4, review_type=1)
model.setreviewcolormode(mode=0)
model.setreviewtransparentmode(mode=1)
model.setreviewmode(mode=1)