Model.maskentitymark#

Model.maskentitymark(collection, flag)#

Masks the entities in the collection. Only entities in displayed collectors may be masked.

To mask connectors and the realized FE, a flag of 1 must be passed.

To mask only connectors (excluding realized FE) and all other entity types, a flag of zero must be passed.

Currently supported entities for this function are connectors, points, lines, surfaces, solids, elements (both in components and groups), ellipsoidsS, mbjoints, mbplanes, equations, loads, systems, vectors, tags, handles, domains, symmetries, morphconstraints, comps (connectors, points, lines, surfaces, solids, elements), groups (main/secondary elements), loadcols (equations, loads), multibodies (ellipsoids, mbjoints, mbplanes), systcols (systems) and vectorcols (vectors).

Parameters:

  • collection (Collection) – The collection containing the entities to be masked.

  • flag (int) – An integer that manipulates the function as the description.

Example#

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

model = hm.Model()

connectors = hm.Collection(model, ent.Connector)
model.maskentitymark(collection=connectors, flag=1)
Mask all elements in components but not elements in groups#
import hm
import hm.entities as ent

model = hm.Model()

comps = hm.Collection(model, ent.Component, populate=True)
filter = hm.FilterByCollection(ent.Element, ent.Component)
elems = hm.Collection(model, filter, comps)
model.maskentitymark(collection=elems, flag=0)
Mask all entities in all components#
import hm
import hm.entities as ent

model = hm.Model()

comps = hm.Collection(model, ent.Component, populate=True)
model.maskentitymark(collection=comps, flag=0)
On this page