Model.unmaskentitymark#

Model.unmaskentitymark(collection, flag)#

Unmasks the collection entities. Only entities in displayed collectors may be unmasked. To unmask connectors and the realized FE, the flag must be set to 1. To unmask only connectors (excluding realized FE) and all other entity types, the flag must be set to 0. Currently supported entity types for this function are:

connectors, points, lines, surfaces, solids, elements (both in components and groups) , equations, loads, systems, vectors, tags , handles, domains, symmetries, morphconstraints, comps (connectors, points, lines, surfaces, solids, elements), groups (main/secondary elements), loadcols (equations, loads), systcols (systems), vectorcols (vectors)

Parameters:
  • collection (Collection) – The collection containing the entities to unmask.

  • flag (int) – The option for unmasking the different entities.

Examples#

Unmask all of the displayed connectors and the realized FE#
import hm
import hm.entities as ent

model = hm.Model()

# Creating a collection that contains all the displayed connectors
collection_displayed_connectors = hm.CollectionByDisplayed(model, ent.Connector)

model.unmaskentitymark(collection=collection_displayed_connectors, flag=1)
Unmask all elements in components but not elements in groups#
import hm
import hm.entities as ent

model = hm.Model()

# Creating a collection that contains all the components
component_collection = hm.Collection(model, ent.Component)

# Creating a collection that contains all the elemetns of the components
filter = hm.FilterByCollection(ent.Element, ent.Component)
element_collection = hm.Collection(model, filter, component_collection)

model.unmaskentitymark(collection=element_collection, flag=0)
Unmask all entities in all components#
import hm
import hm.entities as ent

model = hm.Model()

# Creating a collection that contains all the components
component_collection = hm.Collection(model, ent.Component)

model.unmaskentitymark(collection=component_collection, flag=0)