CvInspect.Wpf 0.22.0

CvInspect.Wpf

WPF display and shape-editing controls for the CvInspect machine-vision toolkit, based on OpenCvSharp.

• CvDispCtrl — an image display control with a dockable toolbar (grab / live toggle / fit / zoom / pan / clear), a status bar (cursor position, pixel value, image size, zoom level), and a right-click menu (load / save image file, view operations). Renders OpenCvSharp.Mat frames, renderer-neutral result overlays (ViOverlay), and interactive teaching shapes.
• Teaching shapes — the draggable shapes (CvEditShape family: rotated rect, segment, circle, arc, concentric ring) and the contract by which option POCOs supply them (ICvShapeSource, implemented by every CvInspect option that has geometry, and by host-defined options the same way) live in the core package under CvInspect.Vision.Edit. This package draws them and turns mouse drags into moves, corner resizes and rotation/angle/radius grips; each drag writes straight back into the POCO through the shape's Changed event.

Install

dotnet add package CvInspect.Wpf

This package references only the managed assemblies (CvInspect → OpenCvSharp4). Pick a native OpenCV runtime yourself in the application project, e.g.:

dotnet add package OpenCvSharp4.runtime.win

Quick start

<Window xmlns:cv="clr-namespace:CvInspect.Controls;assembly=CvInspect.Wpf" ...>
  <cv:CvDispCtrl Frame="{Binding Frame}"
                 Overlay="{Binding Overlay}"
                 Shapes="{Binding Shapes}"
                 GrabCommand="{Binding GrabCmd}"
                 ContinuousCommand="{Binding LiveCmd}"
                 StopCommand="{Binding StopCmd}"
                 LoadFrameCommand="{Binding LoadFrameCmd}"
                 IsRunning="{Binding IsLive}" />
</Window>

Property editor

CvPropEditCtrl unfolds any option POCO into category groups and rows — checkbox for bool, text for numbers and strings, combo for enums, a button for Action — using only the standard System.ComponentModel attributes, which the core's [CvCategory] / [CvName] / [CvDesc] derive from. So a core Cv*Opt needs nothing extra:

<cv:CvPropEditCtrl Source="{Binding ToolOpt}" Committed="OnCommitted" />

Rules the rows follow: [Browsable(false)] hides, [ReadOnly(true)] or a getter-only property disables, group order comes from ICvOrderedCategory (or a "N. " prefix on plain [Category] strings), and numeric text commits on Enter or focus loss — an unparsable entry is rejected and the row snaps back to the stored value, so what you see is always what is stored. The control references no UI library; it adopts the host theme's SecondaryTextBrush and PrimaryBrush when those keys exist and falls back to fixed colors otherwise.

Frame lifetime

Frame accepts two kinds of value, with different lifetime rules:

• Mat — CvDispCtrl copies the pixels into its own buffer, so the host may Dispose() the Mat right after setting the property. That copy is the price of a type that can be disposed underneath the control.
• ICvPixelSource (the core contract, implemented by CamFrame in CvInspect.Imaging) — the control holds the pixel array by reference and copies it only once, into the WPF back buffer. The reference is kept for the status-bar pixel probe and for file save, not for rendering — so a buffer that changes after publishing does not tear the picture, it makes those two disagree with what is on screen. This relies on the contract that Pixels is immutable once published; a source that recycles its buffer must not implement it.

Supported formats either way: 8-bit with 1 (Gray8), 3 (Bgr24) or 4 (Bgra32) channels; anything else shows the no-image placeholder. A value of any other type also shows the placeholder and logs a warning through CvLog.

The Mat passed to LoadFrameCommand is owned by the receiver — the view-model disposes it when done (typically after assigning it back to Frame).

Overlay and shape coordinates are in the pixel space of the image being displayed — bind an image and coordinates from the same space, whether that is the original or a derived (scaled) stage image.

Localization and theming

UI strings (menu labels, placeholder text) come from CvLoc in the core package, under the cv: scope. Labels are re-read every time the context menu opens, so a language switch applies without rebuilding the control. Toolbar accent colors use the host theme's PrimaryBrush / SuccessBrush / DangerBrush resource keys when present, and fall back to fixed colors otherwise — no UI library is referenced.

Targets

net8.0-windows, AnyCPU. The native OpenCV runtime is chosen by the consuming application.

License

Apache-2.0. Not affiliated with OpenCV or OpenCvSharp.