hm_comparegetdistance

Returns the distance value for a specific distance index.

Syntax

hm_comparegetdistance distance_index

Type

HyperMesh Tcl Query

Description

Returns the distance value for a specific distance index. This must be preceded by a call to a relevant hm_compareentities* command and hm_comparefinddistances.

Inputs

distance_index: The index of the distance to query, starting with 0. The number of distances can be found using hm_comparegetdistancecount.

Example

To find the distance value for distance index 0 for the recursive comparison of surfs 1-20 and 101-120:

*createmark surfs 1 1-20
*createmark surfs 2 101-120
hm_compareinit
hm_compareentitiesrecursive surfs 1 surfs 2 0.1 2 0
hm_comparefinddistances 1.0 1
set distance [hm_comparegetdistance 0]
hm_compareend

Errors

Incorrect usage results in a Tcl error. To detect errors, you can use the catch command:

if { [ catch {command_name...} ] } {
   # Handle error
}

Version History

12.0