Model.unmaskentitiesincollector#

Model.unmaskentitiesincollector(collection, flag_1, flag_2, flag_3, flag_4, flag_5, flag_6)#

Unmasks the entities contained within the collector. Only entities in displayed collectors may unmasked. The six flag arguments indicate the type of entities to unmask within the specified collectors. If the flag is set to 1, that entity is unmasked. If the flag is set to 0, that entity is not modified. Currently supported entity_types and flags are:

  • comps

    flag_1 - elements

    flag_2 - points

    flag_3 - lines

    flag_4 - surfaces

    flag_5 - solids

    flags_6 - connectors

  • groups

    flag_1 - main elements

    flag_2 - secondary elements

    flag_3 through flag_6 are not used

  • loadcols

    flag_1 - loads

    flag_2 - equations

    flag_4 through flag_6 are not used

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

  • flag_1 (int) –

    0 - The entity is not modified.

    1 - The entity is unmasked.

  • flag_2 (int) –

    0 - The entity is not modified.

    1 - The entity is unmasked.

  • flag_3 (int) –

    0 - The entity is not modified.

    1 - The entity is unmasked.

  • flag_4 (int) –

    0 - The entity is not modified.

    1 - The entity is unmasked.

  • flag_5 (int) –

    0 - The entity is not modified.

    1 - The entity is unmasked.

  • flag_6 (int) –

    0 - The entity is not modified.

    1 - The entity is unmasked

Example#

Unmask all the points and surfaces in the displayed components#
import hm
import hm.entities as ent

model = hm.Model()

# Creating a collection of the displayed components
collection_displayed_components = hm.CollectionByDisplayed(model, ent.Component)

model.unmaskentitiesincollector(
    collection=collection_displayed_components,
    flag_1=0,
    flag_2=1,
    flag_3=0,
    flag_4=1,
    flag_5=0,
    flag_6=0,
)