Model.hm_clearshape_bycollection#

Model.hm_clearshape_bycollection(collection, shape='')#

Clears the graphical shape on a collection created by Model.hm_plotshape_bycollection(), Model.hm_plotshape_byentity() functions.

Parameters:
  • collection (Collection) – The collection containing the entities to clear shapes for. Valid entities are nodes.

  • shape (hwString) – The shape type to clear. Valid values are box, cone, cylinder, ellipsoid, frustum and sphere.

Returns:

Examples#

Clear the sphere shapes for nodes with IDs 1 - 100#
import hm
import hm.entities as ent

model = hm.Model()

node_collection = hm.Collection(model, ent.Node, list(range(1, 101)))

model.hm_clearshape_bycollection(collection=node_collection, shape="sphere")
Clear all shapes for nodes with IDs 1 - 100#
import hm
import hm.entities as ent

model = hm.Model()

node_collection = hm.Collection(model, ent.Node, list(range(1, 101)))

model.hm_clearshape_bycollection(collection=node_collection)