hm_comparegettransformationmatchstate

Returns the state of a specific transformation and match.

Syntax

hm_comparegettransformationmatchstate transformation_index match_index

Type

HyperWorks Tcl Query

Description

Returns the state of a specific transformation and match. This must be preceded by a call to a relevant hm_compareentities* command.

Possible return values are:

0 - Inactive

1 - Active

Inputs

transformation_index: The index of the transformation to query, starting with 0. The number of transformations can be found using hm_comparegettransformationcount.
match_index: The index of the match corresponding to the transformation_index to query, starting with 0. The number of matches can be found using hm_comparegettransformationmatchcount.

Example

To find the state of transformation 0 and match 5 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
set match_state [hm_comparegettransformationmatchstate 0 5]
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