Model.hm_ce_linkprojectionorderget_byentity#

Model.hm_ce_linkprojectionorderget_byentity(entity, option)#

Returns ordered projection information from links of spot connectors.

Parameters:

  • entity (Entity) – The connector entity to query.

  • option (unsigned int) –

    0 - Return stored projection information with spot connector

    1 - Redo projection for spot connector and return projection information

Returns:

  • hwReturnStatus - Status object

  • HmQueryResult - Result object containing the output values:

    • connector (Entity) - Entity Type: Connector

    • numberOfLayers (int)

    • listOfLayerDetails (HmQueryResultList)-Result list object containing HmQueryResult objects with the following output data:

      • index1 (int)

      • index2 (int)

      • projectionLocation (numpy.ndarray)

      • element (Entity) - Entity Type: Element

Example#

Get projection information from spot connector with ID 101#
import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_ce_linkprojectionorderget_byentity(
    entity=ent.Connector(model,101), option=1
)

print("Connector ID:", result.connector.id)
print("No of Layers:", result.numberOfLayers)

proj_infos = result.listOfLayerDetails

for info in proj_infos:
    print("Layer index 1:", info.index1)
    print("Layer index 2:", info.index2)
    print("Projection Location:", info.projectionLocation)
    print("Element ID:", info.element.id)