Model.hm_comparesettransparentmode#

Model.hm_comparesettransparentmode(mode, color=0)#

Sets the graphical transparency mode for non-reviewed entities. This includes entities not part of the comparison, as well as entities turned off for review by Model.hm_comparesetreviewtypes(). This must be followed by a call to Model.hm_comparesetreview() to refresh the graphics.

Parameters:

  • mode (int) –

    0 - Source and target entities with their review type on are shown in their review color. Source and target entities with their review type off, and all non-compared entities, are shown in black.

    1 - Source entities are shown as fully transparent. Target entities are shown in their review color, or as transparent if their review type is off. All non-compared entities are shown as transparent.

    2 - Target entities are shown as fully transparent. Source entities are shown in their review color, or as transparent if their review type is off. All non-compared entities are shown as transparent.

    3 - Both source and target entities are shown as transparent if their review type is off. All non-compared entities are shown as transparent.

  • color (int) –

    0 - Transparent entities shown in gray (default if not specified).

    1 - Transparent entities shown in their review color.

Returns:

Example#

Set the transparent mode to 1 for a same side comparison of elements with IDs 1 - 20 and with IDs 101 - 120#
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_comparesettransparentmode(mode=1, color=0)

model.hm_comparesetreview(type=2)

model.hm_compareend()