Model.hideentity_byname#

Model.hideentity_byname(entity_type, entity_name, showcomps=False, elements_off=False, geometry_off=False)#

Turns off the display of an entity.

Parameters:

  • entity_type (EntityFullType) – The type of entity to turn off the display.

  • entity_name (hwString) – The name of the entity.

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

Hide geometry and elements for component with name comps1#
import hm
import hm.entities as ent

model = hm.Model()

model.hideentity_byname(entity_type=ent.Component, entity_name="comps1")
Hide elements only for component with name comps1#
import hm
import hm.entities as ent

model = hm.Model()

model.hideentity_byname(
    entity_type=ent.Component, entity_name="comps1", geometry_off=True
)