Model.reviewentitybymark#

Model.reviewentitybymark(collection_set, color=0, showcomps=False, elements_off=False, geometry_off=False)#

Graphically reviews a collection set of entities.

Parameters:

  • collection_set (CollectionSet) – The set of collections containing possibly multiple type of entities to review.

  • color (int) –

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

    If specified as 0, entities will be reviewed with their 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.

  • elements_off (bool) – This indicates that elements in the specified collectors should not be considered. If not provided, the default is to consider elements in the specified collectors.

  • geometry_off (bool) – This indicates that geometry in the specified collectors should not be considered. If not provided, the default is to consider geometry in the specified collectors.

Example#

Review the elements with IDs 1-100 use color 10#
import hm
import hm.entities as ent

model = hm.Model()

# Creating a collection set that contains the elements with IDs 1-100
filter_elements = hm.FilterByEnumeration(ent.Element, list(range(1, 101)))
elements_collection = hm.Collection(model, filter_elements)
CollectionSet = hm.CollectionSet(model)
CollectionSet.set(elements_collection)

model.reviewentitybymark(collection_set=CollectionSet, color=10, showcomps=False)