Model.showentitybymark

Model.showentitybymark(collection_set, showcomps=False, elements_off=False, geometry_off=False)

Turns on the display of a collection set of entities.

Parameters:

• collection_set (CollectionSet) – The set of collections containing possibly multiple type of entities. All entities with a display state on the specified collection set, regardless of entity type, are considered.

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

• 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.

Examples

Show geometry and elements for components with IDs 1 - 3

import hm
import hm.entities as ent

model = hm.Model()

comps_collection = hm.Collection(model, ent.Component, [1, 2, 3])
collection_set = hm.CollectionSet(model)
collection_set.set(comps_collection)

model.showentitybymark(collection_set=collection_set)

Show all components and load collectors, consider only elements

import hm
import hm.entities as ent

model = hm.Model()

comps_collection = hm.Collection(model, ent.Component)
loadcols_collection = hm.Collection(model, ent.Loadcol)
collection_set = hm.CollectionSet(model)
collection_set.set(comps_collection)
collection_set.set(loadcols_collection)

model.showentitybymark(collection_set=collection_set, geometry_off=True)