hm_comparegetcomparea

Returns the comparison area of a specific component.

Syntax

hm_comparegetcomparea match_type match_location ?component_id? ?transformation_index?

Type

HyperMesh Tcl Query Command

Description

Calculates the area values for a specific component. This must be preceded by a call to a relevant hm_compareentities* command. hm_comparesetflags should also be set to 1.

Inputs

match_type: The type of match to query for the area. Valid values are:; 0 - Unmatched; 1 - Topological; 2 - Intersected; 3 - Overlapped; 4 - Matched
match_location: The location of the entities to query for the area. Valid values are:; 1 - Source entities; 2 - Target entities
component_id: The ID of the component to query. If not specified, or given as 0, then the area for the entire source or target is calculated (same behavior as hm_comparegetarea). Ensure that the specified ID matches with the requested match_location.
transformation_index: The index of the transformation to query, starting with 0. The number of transformations can be found using hm_comparegettransformationcount.

Examples

Compare assembly 1 to assembly 2 and query the area of component 10:

*createmark elems 1 "by assems" 1 
*createmark elems 2 "by assems" 2
hm_compareinit
hm_comparesetflags 1
hm_compareentitiessameside elems 1 elems 2 1.0 2 0
hm_comparegetcomparea 4 1 10
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

2020