Model.hm_getlinepointsatdistance#

Model.hm_getlinepointsatdistance(line, dist, x, y, z)#

For a given line, test point, and distance, this function finds all of the line points that are at the specified distance from the test point.

Parameters:

  • line (Entity) – The object describing the input line entity.

  • dist (double) – Distance from the test point.

  • x (double) – The x-coordinate of the test point.

  • y (double) – The y-coordinate of the test point.

  • z (double) – The z-coordinate of the test point.

Returns:

  • hwReturnStatus - Status object

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

    • pointCoordinates (numpy.ndarray) - coordinates of points on the line that are at distance dist from the test point defined by “x”, “y”, “z”.

Example#

Find the line points that are at distance 10 from point ( 4.7 , 6.88 , 9.4 ) and line with ID 48#
import hm
import hm.entities as ent

model = hm.Model()

_, resultlist = model.hm_getlinepointsatdistance(
    line=ent.Line(model, 48), dist=10.0, x=4.7, y=6.88, z=9.4
)

for result in resultlist:
    print("pointCoordinates", result.pointCoordinates)