hm_compareentitiestranslate

Generates comparison results for entities translated along a vector.

Syntax

hm_compareentitiestranslate source_entity_type source_mark_id target_entity_type target_mark_id tolerance vec_x vec_y vec_z distance steps ?result_type? ?review_results?

Type

HyperMesh Tcl Query Command

Description

Generates comparison results for entities translated along a vector. This may find multiple matches, depending on the requested options. 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 or elems.
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 or elems.
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.
vec_x
X-coordinate of translation direction.
vec_y
Y-coordinate of translation direction.
vec_z
Z-coordinate of translation direction.
distance
The translation distance to use for searching for matches.
steps
The number of steps to consider. This dictates how many increments of distance are searched for matches. For example, if distance is 45 and steps is 3, the distances 45, 90 and 135 will be searched. Must be ≥ 1.
result_type
SURFS to SURFS SURFS to ELEMS ELEMS to SURFS ELEMS to ELEMS
0 - Basic

Matched (paired)

Unmatched

Matched (paired)

Unmatched

Matched

Unmatched
1 - Full (default)

Matched (paired)

Overlapped

Intersected

Unmatched

Matched (paired)

Overlapped

Intersected

Unmatched

Matched

Overlapped

Intersected

Unmatched
2 - Detailed

Matched (paired)

Overlapped (paired)

Intersected (paired)

Unmatched

Matched (paired)

Overlapped (paired)

Intersected (paired)

Unmatched

Matched

Overlapped

Intersected

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 translational comparison using a distance of 45 and 6 steps, of surfs 1-20 and 101-120 along the y-direction:

*createmark surfs 1 1-20
*createmark surfs 2 101-120
hm_compareinit
hm_compareentitiestranslate surfs 1 surfs 2 0.1 0 1 0 45 6 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