Model.hm_comparesetreview#

Model.hm_comparesetreview(type, min_legend=0, max_legend=0)#

Sets the graphical review type for comparison results. This must be preceded by a call to a relevant hm_compareentities function. For distance review, a call must also be made to hm_comparefinddistances. This is cleared upon a call to Model.hm_compareend().

Parameters:

  • type (int) –

    0 - Off

    1 - Comparisons

    2 - Distance

  • min_legend (double) – Value that indicates the minimum value to use for the legend when type=2. If not specified, the default is 0.0.

  • max_legend (double) – Value that indicates the maximum value to use for the legend when type=2. If not specified, the default is the maximum distance.

Returns:

Example#

Generate a same side comparison of surfs with IDs 1 - 20 and elems with IDs 101 - 120 , use the 2D shell thickness and offset , ignore fillets and all holes < 8.0 in diameter#
import hm
import hm.entities as ent

model = hm.Model()

elems1 = hm.Collection(model, ent.Element, list(range(1, 21)))
elems2 = hm.Collection(model, ent.Element, list(range(101, 121)))

model.hm_compareinit()

model.hm_compareentitiessameside(
    source_entities=elems1,
    target_entities=elems2,
    tolerance=0.1,
    result_type=2,
    review_results=False,
)

model.hm_comparefinddistances(max_distance=1.0, review_results=True)

model.hm_comparesetreview(type=2)

model.hm_compareend()