Readme update, version bump to v1.6.0

README.md

@@ -24,9 +24,29 @@ A viewer that shows ImGui UI elemets on the left, and a large image on the right
 * Bundles a [custom build](https://github.com/harskish/pyplotgui) of PyImGui with plotting support (via ImPlot)
 * Dynamically rescalable user interface
 * Window resizing to integer multiple of content resolution
+* Pan and zoom of the main image
 
 ## Installation
 `pip install pyviewer`
 
 ## Usage
 See `examples/demo.py` for a usage example.
+
+## API highlights
+`PannableArea::screen_to_uv_xform`<br>
+Maps absolute screen coordinates (e.g. `imgui.get_mouse_pos()`) to transformed image UVs, useful for picking etc.<br>
+
+`PannableArea::uv_to_screen_xform`<br>
+Maps image UVs to absolute screen coordinates. Useful when combined with imgui's [draw lists](https://pyimgui.readthedocs.io/en/latest/reference/imgui.core.html#imgui.core._DrawList).
+
+`PannableArea::get_visible_box_image()`<br>
+Returns the top-left and bottom-right UV coordinates of the currently visible image region.<br>
+
+`PannableArea::get_hovered_uv_image()`<br>
+Returns the image UVs that lie under the mouse cursor.
+
+`PannableArea::get_hovered_uv_canvas()`<br>
+Returns the *canvas* UVs that lie under the mouse cursor. Differs from the image UVs in case of non-matching image and window aspect ratios.
+
+`from pyviewer.single_image_viewer import draw; draw(img_chw=...)`<br>
+One-liner that opens a new viewer (unless already open) and draws the provided image. Runs in a separate process and thus works even when execution is halted by e.g. a debugger.

pyviewer/utils.py

@@ -211,7 +211,8 @@ def draw_to_canvas(self, texture_in, tW, tH, cW, cH, pan_enabled=True):
         self.pan_enabled = pan_enabled
 
         # Update pan & zoom state
-        self.handle_pan()
+        if self.pan_enabled:
+            self.handle_pan()
 
         #gl.glDisable(gl.GL_BLEND)
         gl.glDisable(gl.GL_CULL_FACE)
@@ -438,9 +439,6 @@ def get_hovered_uv_image(self):
 
     # Handle pan action
     def handle_pan(self):
-        if not self.pan_enabled:
-            return
-
         if imgui.is_mouse_clicked(0) and self.mouse_hovers_content():
             u, v = self.get_hovered_uv_canvas()
             self.pan_start = (u, 1 - v) # convert to y-up

setup.py

@@ -23,7 +23,7 @@
 # or with: `rm -r build\ && pip wheel . && unzip -l pyviewer-*.whl`
 # (not same environment, but good first step)
 setup(name='pyviewer',
-    version='1.5.1',
+    version='1.6.0',
     description='Interactyive python viewers',
     author='Erik Härkönen',
     author_email='erik.harkonen@hotmail.com',