Model.displaycollector

Model.displaycollector(entity_type, mode, name, elements, geometry)

Controls the display state of a collector.

Parameters:

• entity_type (EntityFullType) – Collector types. Valid types for this function are Components, Loadcols, Systcols, Vectorcols.

• mode (hwString) –

  The mode being performed, defined by the following:

  on - All collectors are turned on.

  all - All collectors are turned on.

  off - All collectors are turned off.

  none - All collectors are turned off.

  toggle - All collectors are toggled (visible become invisible and vice-versa).

  reverse - All collectors are toggled (visible become invisible and vice-versa).

• name (hwString) – The collector name to be used in the above functions. This parameter may be left blank, if mode is set to “all”, “none”, or “toggle”.

• elements (int) –

  Indicates if elements within components are to be turned on or off.

  0 - No

  1 - Yes

• geometry (int) –

  Indicates if geometry within components is to be turned on or off.

  0 - No

  1 - Yes

Example

Turn the elements and geometry on in the component named “ fender “

import hm
import hm.entities as ent

model = hm.Model()

model.displaycollector(
    entity_type=ent.Component, mode="on", name="fender", elements=1, geometry=1
)