HoverBox

class tools.manual.face_viewer.interact.HoverBox(viewport: Viewport)

Bases: object

Handle the current mouse location when over the Viewport.

Highlights the face currently underneath the cursor and handles actions when clicking on a face.

Parameters:

viewport (Viewport) – The viewport object for the FacesViewer canvas

Methods Summary

on_hover(event)

Highlight the face and set the mouse cursor for the mouse's current location.

Methods Documentation

on_hover(event: Event | None) → None

Highlight the face and set the mouse cursor for the mouse’s current location.

Parameters:

event (tkinter.Event or None) – The tkinter mouse event. Provides the current location of the mouse cursor. If None is passed as the event (for example when this function is being called outside of a mouse event) then the location of the cursor will be calculated

Return type:

None

on_hover(event: Event | None) → None

Highlight the face and set the mouse cursor for the mouse’s current location.

Parameters:

event (tkinter.Event or None) – The tkinter mouse event. Provides the current location of the mouse cursor. If None is passed as the event (for example when this function is being called outside of a mouse event) then the location of the cursor will be calculated

Return type:

None