distance

query_ent_var.distance(p0: str) → int

Specify how to parameterize the distance of the computed query (also, how the Distance is labeled on the plot).

This command must lie between either a “query_ent_var: begin” and “query_ent_var: end” pair, or a “query_ent_var: modify_begin” and “query_ent_var: modify_end” pair.

Only applicable with the “query_ent_var: type distance” command.

Args:

p0:

‘option’

• arc_length

• x_arc_length

• y_arc_length

• z_arc_length

• from_origin

• x_from_origin

• y_from_origin

• z_from_origin

Examples:

# 
# Modify to parameterize using only the x-component of the arc length 
# 
ensight.query_ent_var.modify_begin()
# WARNING: following line includes OBSOLETE call (ensight.query_ent_var.type).
ensight.query_ent_var.type("distance")
ensight.query_ent_var.constrain("line_tool")
ensight.query_ent_var.distance("x_arc_length")
ensight.query_ent_var.modify_end()

Returns:

zero on success, non-zero on error