hm_compareentities

Generates comparison results for entities positioned at any location.

Syntax

hm_compareentities source_entity_type source_mark_id target_entity_type target_mark_id tolerance ?result_type? ?review_results?

Type

HyperMesh Tcl Query Command

Description

Generates comparison results for entities positioned at any location. A maximum of one match is found for each source entity. This must be preceded by a call to hm_compareinit.

These results can then be queried using hm_compareget* APIs, or written to a file using hm_comparewrite* APIs.

Inputs

source_entity_type
The type of source entity. Valid values are surfs only.
source_mark_id
The ID of the mark containing the source entities. Valid values are 1 and 2.
target_entity_type
The type of target entity. Valid values are surfs only.
target_mark_id
The ID of the mark containing the target entities. Valid values are 1 and 2.
tolerance
The tolerance value to use for the comparison.
result_type
SURFS to SURFS
0 - Basic Matched (paired) Unmatched
1 - Full (default) Matched (paired) Overlapped Intersected Unmatched
2 - Detailed Matched (paired) Overlapped (paired) Intersected (paired) Unmatched
review_results
0 - Do not automatically show the graphical comparison results after execution.
1 - Automatically show the graphical comparison results after execution (default). This is cleared upon a call to hm_compareend.

Example

To write the detailed comparison results file to C:/temp/my_compare.txt for the general comparison of surfs 1-20 and 101-120:
*createmark surfs 1 1-20
*createmark surfs 2 101-120
hm_compareinit
hm_compareentities surfs 1 surfs 2 0.1 2 0
hm_comparewriteresults C:/temp/my_compare.txt
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