wolfhece._overlays

Overlay and panel classes extracted from PyDraw.py.

These classes provide on-canvas HUD overlays and floating control panels for the WolfMapViewer.

Author: HECE - University of Liege, Pierre Archambeau Date: 2024

Copyright (c) 2024 University of Liege. All rights reserved.

This script and its content are protected by copyright law. Unauthorized copying or distribution of this file, via any medium, is strictly prohibited.

Module Contents

class wolfhece._overlays.HillshadePanel(mapviewer: wolfhece.PyDraw.WolfMapViewer)

Bases: wx.Frame

Persistent panel for hillshade / sun-lighting controls.

Provides live sliders for altitude, azimuth, intensity, checkboxes for enable and multi-directional mode, and a sunrise animation button.

_ANIM_INTERVAL_MS = 33

_ANIM_SPEED_DEG_S = 30.0

mapviewer

_panel

_chk_enable

_alt

_az

_int

_chk_multi

_chk_sync

_z_exag

_spec

_gloss

_hl

_anim_speed

_btn_apply

_btn_anim

_btn_natural

_btn_pseudo

_btn_save

_timer

_on_change(event)

Called on Enter key, Apply button, or checkbox — push to mapviewer.

_on_toggle_anim(event)

_apply_preset(altitude, azimuth, intensity, z_exag, multidirectional, specular=0.0, glossiness=0.5, highlight=1.0)

Apply a preset and sync all controls.

_on_preset_natural(event)

Standard cartographic hillshade: NW light, moderate settings.

_on_preset_pseudoscopic(event)

Pseudoscopic illusion: SE light + strong Z exaggeration.

_on_timer(event)

_on_close(event)

_on_sync_toggle(event)

Toggle synchronised / per-array mode.

_on_save(event)

Persist material params to sidecar files.

refresh_from_params()

Refresh spin controls from the active material params source.

class wolfhece._overlays.HillshadeOverlay(mapviewer: wolfhece.PyDraw.WolfMapViewer)

On-canvas HUD for interactive hillshade control.

Draws an azimuth ring and altitude bar in the bottom-right corner of the GL canvas. Responds to mouse drag on these widgets.

Only active while the HillshadePanel is open.

_MARGIN = 20

_RING_RADIUS = 45

_BAR_WIDTH = 14

_MINI_BAR_WIDTH = 10

_GAP = 18

_MINI_GAP = 8

_BG_RGBA = (0.1, 0.1, 0.1, 0.5)

_OUTLINE_RGBA = (0.8, 0.8, 0.8, 0.8)

_SUN_RGBA = (1.0, 0.9, 0.2, 0.9)

_SUN_FILL_RGBA = (1.0, 0.9, 0.2, 0.4)

_SPEC_RGBA = (0.9, 0.9, 1.0, 0.9)

_SPEC_FILL = (0.7, 0.7, 1.0, 0.4)

_ROUGH_RGBA = (0.6, 0.85, 0.6, 0.9)

_ROUGH_FILL = (0.4, 0.7, 0.4, 0.4)

_METAL_RGBA = (0.9, 0.7, 0.3, 0.9)

_METAL_FILL = (0.8, 0.6, 0.2, 0.4)

mapviewer

_dragging: str | None = None

_ring_center()

_bar_rect()

Return (x0, y_bottom, x1, y_top) for the altitude bar.

_mini_bar_rect(index)

Return (x0, y0, x1, y1) for mini bar index (0=S, 1=R, 2=M).

Mini bars sit to the left of the altitude bar.

_wx_to_gl(wx_x, wx_y)

hit_test(wx_x, wx_y)

Return 'azimuth', 'altitude', 'specular', 'glossiness', 'highlight', or None.

on_drag(wx_x, wx_y)

Update the hillshade parameter corresponding to _dragging.

_sync_panel()

Push current mapviewer values back into the HillshadePanel controls.

handle_wheel(rotation, delta, ctrl, shift)

Handle mouse wheel when hillshade panel is open.

Returns True if the event was consumed.

draw()

Draw azimuth ring + altitude bar as a pixel-space HUD.

_draw_azimuth_ring(math, glColor4f, glLineWidth, glBegin, glEnd, glVertex2f, GL_TRIANGLE_FAN, GL_LINE_LOOP, GL_LINES)

_draw_altitude_bar(glColor4f, glLineWidth, glBegin, glEnd, glVertex2f, GL_LINE_LOOP, GL_LINES, GL_QUADS)

_draw_mini_bars(glColor4f, glLineWidth, glBegin, glEnd, glVertex2f, GL_LINE_LOOP, GL_LINES, GL_QUADS)

Draw the three S / R / M mini-bars.

class wolfhece._overlays._ToolButton(icon: str, label: str, *, action: str | None = None, is_toggle: bool = False, callback=None)

Descriptor for one toolbar button.

icon

label

action = None

is_toggle = False

callback = None

SEPARATOR = None

class wolfhece._overlays.CutFillOverlay(mapviewer: wolfhece.PyDraw.WolfMapViewer)

Two side-by-side pie-chart HUDs showing cut/fill earthwork volumes.

The Zoom pie covers only the cells currently visible in the viewport; the Global pie covers the entire active array. Both measure the signed difference z_ref − z_current:

• Cut (orange): cells where the terrain was lowered (ref > current).

• Fill (teal): cells where the terrain was raised (ref < current).

The overlay is visible only when the sculpt or profile brush is active and a reference snapshot has been frozen. It is placed at the bottom-right corner, automatically pushed above the hillshade overlay when that one is also on screen.

_GLOBAL_THROTTLE_S: float = 0.4

PIE_R = 65

CARD_PAD = 10

TITLE_H = 15

VALUE_H = 36

GAP = 14

MARGIN_X = 16

MARGIN_Y = 16

HS_MARGIN = 12

property CARD_W

property CARD_H

BG_RGBA = (0.06, 0.06, 0.06, 0.62)

OUTLINE_RGBA = (0.7, 0.7, 0.7, 0.65)

CUT_RGBA = (1.0, 0.52, 0.12, 0.88)

CUT_FILL = (1.0, 0.52, 0.12, 0.38)

FILL_RGBA = (0.18, 0.8, 0.88, 0.88)

FILL_FILL = (0.18, 0.8, 0.88, 0.38)

ZERO_RGBA = (0.35, 0.35, 0.35, 0.55)

TITLE_RGBA = (0.88, 0.88, 0.88, 1.0)

CUT_TEXT = (1.0, 0.65, 0.3, 1.0)

FILL_TEXT = (0.3, 0.9, 0.95, 1.0)

enabled: bool = True

mapviewer

_g_cut: float = 0.0

_g_fill: float = 0.0

_z_cut: float = 0.0

_z_fill: float = 0.0

_dirty: bool = True

_zoom_dirty: bool = True

_last_viewport: tuple = ()

_last_global_t: float = -1000000000.0

_last_zoom_t: float = -1000000000.0

invalidate() → None

Mark both caches dirty. Call after each brush stroke.

force_recompute() → None

Bypass throttle and recompute global immediately.

Call when brushing ends so the final tally is always accurate.

_get_brush_info()

Return (ref_array, live_data, dx, dy, nullvalue) or None.

Pulls from whichever brush (sculpt or profile) is currently active.

_recompute_global() → None

_compute_zoom()

Return (cut_m3, fill_m3) restricted to the current viewport.

static _vol_str(v: float) → str

_card_bottom_y() → float

Bottom-left y (GL pixels) for the cards, avoiding the hillshade.

_centers()

Return (cx1, cx2, cy) — disc centres for Zoom / Global pies.

static _draw_disc_sector(math, glColor4f, glBegin, glEnd, glVertex2f, GL_TRIANGLE_FAN, cx, cy, r, a_start, a_end, color, n=72)

Draw a filled pie sector from a_start to a_end (CCW radians).

draw() → None

Draw both cut/fill pie chart cards in GL pixel space.

Called every repaint from WolfMapViewer.Paint().

_draw_card(cx, cy, cut, fill, title, math, glColor4f, glLineWidth, glBegin, glEnd, glVertex2f, GL_TRIANGLE_FAN, GL_LINE_LOOP, GL_LINES)

Draw the background rect and pie disc for one card.

_draw_text_card(cx, cy, cut, fill, title, tr, px_mvp, vp, math)

Draw the text labels for one pie card using pixel-space MVP.

class wolfhece._overlays.ToolbarOverlay(mapviewer: wolfhece.PyDraw.WolfMapViewer)

On-canvas contextual toolbar that appears in the top-left corner.

Shows a small indicator (three dots) when collapsed. Expands vertically on hover to show tool buttons relevant to the currently active object type (vectors, arrays, point clouds, cross-sections, tiles).

Toggled completely on/off with the T key.

_INDICATOR_X = 12

_INDICATOR_Y_TOP = 16

_INDICATOR_DOT_R = 3

_INDICATOR_DOT_GAP = 8

_INDICATOR_HIT_W = 28

_INDICATOR_HIT_H = 40

_BTN_SIZE = 30

_BTN_GAP = 3

_BAR_PADDING = 6

_BAR_LEFT = 8

_COLLAPSE_DELAY_MS = 600

_BG = (0.1, 0.1, 0.12, 0.75)

_BG_HOVER = (0.25, 0.25, 0.3, 0.85)

_BG_ACTIVE = (0.15, 0.45, 0.8, 0.9)

_BORDER = (0.55, 0.55, 0.6, 0.8)

_TEXT = (0.95, 0.95, 0.95, 1.0)

_TEXT_ACTIVE = (1.0, 1.0, 1.0, 1.0)

_SEP_COLOR = (0.45, 0.45, 0.5, 0.6)

_DOT_COLOR = (0.7, 0.7, 0.75, 0.8)

_TOOLTIP_BG = (0.08, 0.08, 0.1, 0.9)

_TOOLTIP_TEXT = (0.95, 0.93, 0.8, 1.0)

_BUTTONS_VECTOR: list

_BUTTONS_ARRAY: list

_BUTTONS_CLOUD: list

_BUTTONS_CS: list

_BUTTONS_TILE: list

mapviewer

_expanded = False

_hover_btn: int | None = None

_text_renderer = None

_collapse_timer = None

_last_context: str | None = None

_cached_buttons: list | None = None

_detect_context() → str

Return a context key based on the selected object in the tree.

Multiple active_* attributes can be non-None simultaneously, so they cannot be used to decide which button set to show. The selected_object (tree selection) is the authoritative source.

_get_buttons() → list | None

Return the button list for the current context (cached).

_canvas_size()

static _wx_to_gl(wx_x, wx_y, h)

_indicator_rect_gl()

GL rect (x0, y0, x1, y1) of the 3-dot indicator zone.

_bar_geometry()

Return (x0, y_top, y_bot, bar_w, btn_rects) for expanded bar.

btn_rects is a list of (bx0, by0, bx1, by1) in GL coords, one per non-separator button.

is_inside(wx_x, wx_y) → bool

True if the wx point is over the indicator or the expanded bar.

hit_test(wx_x, wx_y) → int | None

Return button index if wx point is over a button, else None.

on_mouse_move(wx_x, wx_y) → bool

Track hover. Returns True if the event should be consumed.

on_click(wx_x, wx_y) → bool

Handle a left click. Returns True if consumed.

_start_collapse_timer()

_stop_collapse_timer()

_on_collapse()

_tb_add_zone()

_tb_add_vector()

_tb_create_parallel()

_tb_select_all()

_tb_reset_selection()

_tb_dilate()

_tb_erode()

_tb_mask_inside()

_tb_mask_outside()

_tb_open_sculpt()

_tb_sculpt_mode(mode_value: str) → None

Open the sculpt panel, set brush mode, and activate sculpting.

_tb_sculpt_smooth()

_tb_sculpt_raise()

_tb_sculpt_lower()

_tb_sculpt_flatten()

_tb_sculpt_noise()

_tb_open_profile()

Open (or raise) the floating ProfilePanel.

draw()

Draw the toolbar overlay. Called from WolfMapViewer.Paint().

_draw_indicator(w, h, glColor4f, glPointSize, glBegin, glEnd, glVertex2f, GL_POINTS)

Draw three small dots in the top-left corner.

_draw_expanded(w, h, glBegin, glEnd, glVertex2f, glColor4f, glLineWidth, glPointSize, GL_QUADS, GL_LINES, GL_POINTS)

Draw the full expanded toolbar.

_draw_button_icon(btn, bx0, by0, bx1, by1, is_active, w, h)

Draw the icon from the texture atlas, centred in the button.

_draw_separators(buttons, btn_rects, x0, bar_w, glColor4f, glLineWidth, glBegin, glEnd, glVertex2f, GL_LINES)

Draw horizontal separator lines between button groups.

_draw_tooltip(text, btn_rect, w, h, glColor4f, glBegin, glEnd, glVertex2f, GL_QUADS)

Draw a tooltip to the right of a button.

class wolfhece._overlays.PaletteOverlay(mapviewer: wolfhece.PyDraw.WolfMapViewer)

On-canvas HUD for interactive colour-palette editing.

Draws a horizontal gradient bar at the top of the GL canvas showing the active array’s palette. Triangular cursors mark the values at each colour stop and can be dragged to reshape the palette.

Only active while toggled on (key K).

_MARGIN = 20

_BAR_HEIGHT = 24

_CURSOR_H = 12

_LABEL_FONT_SIZE = 11

_LABEL_GAP = 4

_MIN_CURSOR_SEP = 3

_HANDLE_W = 10

_BG_RGBA = (0.12, 0.12, 0.12, 0.55)

_OUTLINE_RGBA = (0.8, 0.8, 0.8, 0.8)

_CURSOR_RGBA = (1.0, 1.0, 1.0, 0.9)

_CURSOR_ACTIVE_RGBA = (1.0, 0.85, 0.0, 1.0)

_LABEL_COLOR = (0.95, 0.93, 0.8, 1.0)

_LABEL_BG = (0.08, 0.08, 0.1, 0.9)

mapviewer

_dragging: int | None = None

_hover: int | None = None

_hover_gl_x: float | None = None

_text_renderer = None

_get_palette_owner()

Return the selected object that owns a palette, or None.

Returns a WolfArray or Wolfresults_2D picked from mapviewer.selected_object.

_get_palette()

Return the active array’s or active 2D result’s palette, or None.

_iter_underlying_arrays()

Yield every WolfArray that backs the current palette owner.

For a plain WolfArray owner, yields just that single array. For a WolfArrayMB owner, yields the parent and every sub-block. For a Wolfresults_2D owner, yields the _current WolfArray of every block via iter_current_arrays().

_bar_rect()

Return (x0, y_bottom, x1, y_top) for the gradient bar.

_value_to_x(val, pal, x0, x1)

Map a palette value to a pixel x-coordinate.

_x_to_value(px_x, pal, x0, x1)

Map a pixel x-coordinate back to a palette value.

_wx_to_gl(wx_x, wx_y)

is_inside(wx_x, wx_y)

Return True if the wx position is inside the overlay zone.

on_mouse_move(wx_x, wx_y)

Track hover position. Returns True if mouse is over the bar.

hit_test(wx_x, wx_y)

Return cursor index, -1 (min handle), -2 (max handle), or None.

on_drag(wx_x, wx_y)

Update palette values based on drag position.

draw()

Draw the palette bar + cursors + labels as a pixel-space HUD.

_draw_gradient_bar(pal, x0, y0, x1, y1, glColor4f, glColor3f, glBegin, glEnd, glVertex2f, GL_QUADS)

Draw the colour gradient (or piecewise-constant blocks).

_draw_cursors(pal, x0, y0, x1, y1, glColor4f, glBegin, glEnd, glVertex2f, GL_TRIANGLES)

Draw triangular cursors below the bar for each colour stop.

_draw_labels(pal, x0, y0, x1, y1, w, h)

Draw min/max value labels with tooltip-style background.

_draw_hover_value(pal, x0, y0, x1, y1, w, h, glColor4f, glLineWidth, glBegin, glEnd, glVertex2f, GL_LINES)

Draw a vertical hair-line + tooltip-style value label at hover.

on_double_click(wx_x, wx_y)

Open a dialog to type an exact value for the clicked cursor.

on_right_click(wx_x, wx_y)

Show context menu if click is inside the overlay area.

_PRESETS: dict

_apply_preset(key: str)

Apply a domain-specific preset palette to the active array.

_apply_model_file(filename: str)

Load a .pal file from wolfhece/models/ into the active palette.

_apply_palette_change()

Rebuild palette internals + invalidate GPU cache + refresh.