diff --git a/Emgu.CV.OCR/ITessResultRenderer.cs b/Emgu.CV.OCR/ITessResultRenderer.cs index 7a133b692..edf448e05 100644 --- a/Emgu.CV.OCR/ITessResultRenderer.cs +++ b/Emgu.CV.OCR/ITessResultRenderer.cs @@ -2,24 +2,17 @@ // Copyright (C) 2004-2025 by EMGU Corporation. All rights reserved. //---------------------------------------------------------------------------- -using Emgu.CV.Util; using System; using System.Collections.Generic; -using System.Drawing; using System.Runtime.InteropServices; -using System.Text; -using System.IO; using Emgu.CV; using Emgu.CV.Structure; -using Emgu.Util; -using System.Diagnostics; - namespace Emgu.CV.OCR { /// - /// Interface to the TesseractResultRender + /// Interface to the TessResultRenderer /// public interface ITessResultRenderer { @@ -29,16 +22,40 @@ namespace Emgu.CV.OCR IntPtr TessResultRendererPtr { get; } } - + /// + /// Provides a debugger proxy for the interface. + /// This class is used to simplify the debugging experience by exposing key properties + /// of the implementation in a more accessible manner. + /// public class TessResultRendererDebuggerProxy { private ITessResultRenderer _v; + /// + /// Initializes a new instance of the class. + /// + /// + /// An implementation of the interface to be wrapped by this debugger proxy. + /// + /// + /// This constructor is used to create a debugger proxy for the provided instance, + /// allowing easier inspection of its properties during debugging. + /// public TessResultRendererDebuggerProxy(ITessResultRenderer v) { _v = v; } + /// + /// Gets a value indicating whether the associated Tesseract result renderer is in a "happy" state. + /// + /// + /// true if the renderer is in a "happy" state; otherwise, false. + /// + /// + /// This property provides a simplified way to check the internal state of the Tesseract result renderer + /// during debugging. A "happy" state typically indicates that the renderer is functioning correctly. + /// public bool Happy { get @@ -47,6 +64,20 @@ namespace Emgu.CV.OCR } } + /// + /// Gets the index of the last image provided to the renderer. + /// + /// + /// This property reflects the index of the most recent image given to the renderer, + /// regardless of whether the image was successfully processed or not. + /// It provides insight into the current state of the rendering process: + /// - During a document lifecycle, it indicates the number of the current or last image. + /// - In a completed document, it represents the total number of images processed. + /// - If no document was started, it returns -1. + /// + /// + /// The index of the last image provided to the renderer, or -1 if no document was started. + /// public int ImageNum { get