Model.hm_proximitygetelementdistance

Model.hm_proximitygetelementdistance(element_entity)

Returns the proximity distance for a given element.

This must be preceded by a call to Model.hm_proximityinit() and followed by a call to Model.hm_proximityend().

Parameters:

element_entity (Entity) – The object describing the entity.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • proximityDistance (double)

Example

Output the proximity distance at each input element

import hm
import hm.entities as ent

model = hm.Model()

components_collection = hm.Collection(model, ent.Component)
model.hm_proximityinit(components_collection, max_distance=2.5)

elemFromComps = hm.Collection(model, ent.Element, populate=False)
model.hm_proximitymarksourceproximityelements(elemFromComps)

for elem in elemFromComps:
    _, result = model.hm_proximitygetelementdistance(element_entity=elem)
    print(f"Distance for element {elem.id} is {result.proximityDistance}")

model.hm_proximityend()