eVision .NET API
Loading...
Searching...
No Matches
eVision.EBaseROI Class Referenceabstract

This represents the abstract base class for all ROI and image classes. More...

Inheritance diagram for eVision.EBaseROI:
Collaboration diagram for eVision.EBaseROI:

Public Member Functions

bool IsAttached ()
 Returns true if the ROI is attached to an image.
bool IsAnROI ()
 Tests whether this object is an ROI or an image.
bool HasSubROI (eVision.EBaseROI subROI)
 Tests whether this object has a given attached ROI.
eVision.EBaseROI GetNextSiblingSubROI (eVision.EBaseROI subROI)
 This method returns the ROI that is the next sibling of the supplied ROI in the list of sub-ROIs.
eVision.EBaseROI GetNextROI (eVision.EBaseROI startROI)
 Returns the next ROI in the list starting at startROI or null if there is no next ROI.
void SetImagePtr (int width, int height, IntPtr imagePointer, int bitsPerRow)
 Sets the pointer to an externally allocated image buffer.
void SetImagePtr (int width, int height, IntPtr imagePointer)
 Sets the pointer to an externally allocated image buffer.
void UseExternalBuffer (int width, int height, IntPtr buffer, int rowPitch)
 Sets the pointer to an externally allocated image buffer.
IntPtr GetImagePtr (int x, int y)
 Returns a pointer to the pixel at given coordinates within the image/ROI.
IntPtr GetImagePtr ()
 Returns a pointer to the pixel at given coordinates within the image/ROI.
void CropToImage ()
 This method reduces the ROI size so that it is completely contained within its topmost parent image bounds (if such an image exists at the top of the hierarchy). This means that, after calling this method, either the ROI has a zero size, or all of its pixels map to valid pixels of the underlying image buffer. If the ROI is already contained within its parent image bounds, then this method does nothing.
void SetPlacement (int originX, int originY, int width, int height)
 Sets the placement of an ROI, relative to its parent ROI/image.
void SetPlacement (eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft, int paddingRight)
 Sets the placement of an ROI, relative to its parent ROI/image.
void SetPlacement (eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft)
 Sets the placement of an ROI, relative to its parent ROI/image.
void SetPlacement (eVision.ERegion region, int paddingTop, int paddingBottom)
 Sets the placement of an ROI, relative to its parent ROI/image.
void SetPlacement (eVision.ERegion region, int paddingTop)
 Sets the placement of an ROI, relative to its parent ROI/image.
void SetPlacement (eVision.ERegion region)
 Sets the placement of an ROI, relative to its parent ROI/image.
void SetPlacement (eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom, int paddingLeft, int paddingRight)
 Sets the placement of an ROI, relative to its parent ROI/image.
void SetPlacement (eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom, int paddingLeft)
 Sets the placement of an ROI, relative to its parent ROI/image.
void SetPlacement (eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom)
 Sets the placement of an ROI, relative to its parent ROI/image.
void SetPlacement (eVision.ERegion region, eVision.EFrame frame, int paddingTop)
 Sets the placement of an ROI, relative to its parent ROI/image.
void SetPlacement (eVision.ERegion region, eVision.EFrame frame)
 Sets the placement of an ROI, relative to its parent ROI/image.
eVision.EBaseROI[] GetSubBaseROIs (bool recursive)
 Returns all the children, and possibly recursively all their children, too.
eVision.EBaseROI[] GetSubBaseROIs ()
 Returns all the children, and possibly recursively all their children, too.
eVision.EDragHandle HitTest (int x, int y, float zoomX, float zoomY, float panX, float panY)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EDragHandle HitTest (int x, int y, float zoomX, float zoomY, float panX)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EDragHandle HitTest (int x, int y, float zoomX, float zoomY)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EDragHandle HitTest (int x, int y, float zoomX)
 Detects if the cursor is placed over one of the dragging handles.
eVision.EDragHandle HitTest (int x, int y)
 Detects if the cursor is placed over one of the dragging handles.
bool IsPointInside (eVision.EPoint position)
 Detects if the position is inside current ROI.
bool IsPixelInside (int x, int y)
 Detects if a pixel (given its x and y coordinates) is inside current ROI.
void Drag (eVision.EDragHandle dragHandle, int x, int y, float zoomX, float zoomY, float panX, float panY)
 Moves the specified handle to a new position and updates all placement parameters of the ROI.
void Drag (eVision.EDragHandle dragHandle, int x, int y, float zoomX, float zoomY, float panX)
 Moves the specified handle to a new position and updates all placement parameters of the ROI.
void Drag (eVision.EDragHandle dragHandle, int x, int y, float zoomX, float zoomY)
 Moves the specified handle to a new position and updates all placement parameters of the ROI.
void Drag (eVision.EDragHandle dragHandle, int x, int y, float zoomX)
 Moves the specified handle to a new position and updates all placement parameters of the ROI.
void Drag (eVision.EDragHandle dragHandle, int x, int y)
 Moves the specified handle to a new position and updates all placement parameters of the ROI.
void Serialize (eVision.ESerializer serializer)
 Serializes the EBaseROI.
void Detach ()
void Attach (eVision.EBaseROI parent)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, int orgX, int orgY, int width, int height)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, int orgX, int orgY, int width)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, int orgX, int orgY)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft, int paddingRight)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, eVision.ERegion region, int paddingTop, int paddingBottom, int paddingLeft)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, eVision.ERegion region, int paddingTop, int paddingBottom)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, eVision.ERegion region, int paddingTop)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, eVision.ERegion region)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom, int paddingLeft, int paddingRight)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom, int paddingLeft)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop, int paddingBottom)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, eVision.ERegion region, eVision.EFrame frame, int paddingTop)
 This method attaches the ROI to another ROI or image.
void Attach (eVision.EBaseROI parent, eVision.ERegion region, eVision.EFrame frame)
 This method attaches the ROI to another ROI or image.
void CopyTo (eVision.EBaseROI dest)
 Copies all the data of the current EBaseROI object into another EBaseROI object and returns it.
void SetSize (int width, int height)
 Sets the width and height of an ROI/image.
void SetSize (eVision.EBaseROI other)
 Sets the width and height of an ROI/image.
void DrawFrame (eVision.EDrawAdapter graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (eVision.EDrawAdapter graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (eVision.EDrawAdapter graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (eVision.EDrawAdapter graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (eVision.EDrawAdapter graphicContext, eVision.EFramePosition framePosition, bool handles)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (eVision.EDrawAdapter graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (eVision.EDrawAdapter graphicContext, bool handles, float zoomX, float zoomY, float panX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (eVision.EDrawAdapter graphicContext, bool handles, float zoomX, float zoomY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (eVision.EDrawAdapter graphicContext, bool handles, float zoomX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (eVision.EDrawAdapter graphicContext, bool handles)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, bool handles, float zoomX, float zoomY, float panX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, bool handles, float zoomX, float zoomY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, bool handles, float zoomX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, bool handles)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY, float panX, float panY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY, float panX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, eVision.ERGBColor color, bool handles, float zoomX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (IntPtr graphicContext, eVision.ERGBColor color, bool handles)
 Draws a rectangular frame around an image or ROI.
void Draw (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY, float panX, float panY)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY, float panX)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, float zoomX, float zoomY)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, float zoomX)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX, float panY)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EC24Vector c24Vector, float zoomX)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EC24Vector c24Vector)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX, float panY)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EBW8Vector bw8Vector, float zoomX)
 Draws an ROI/image in a device context.
void Draw (eVision.EDrawAdapter graphicContext, eVision.EBW8Vector bw8Vector)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, float zoomX, float zoomY, float panX, float panY)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, float zoomX, float zoomY, float panX)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, float zoomX, float zoomY)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, float zoomX)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX, float panY)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, eVision.EC24Vector c24Vector, float zoomX)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, eVision.EC24Vector c24Vector)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX, float panY)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, eVision.EBW8Vector bw8Vector, float zoomX)
 Draws an ROI/image in a device context.
void Draw (IntPtr graphicContext, eVision.EBW8Vector bw8Vector)
 Draws an ROI/image in a device context.
void DrawFrameWithCurrentPen (IntPtr graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY)
 Draws a rectangular frame around an image or ROI.
void DrawFrameWithCurrentPen (IntPtr graphicContext, bool handles, float zoomX, float zoomY, float panX)
 Draws a rectangular frame around an image or ROI.
void DrawFrameWithCurrentPen (IntPtr graphicContext, bool handles, float zoomX, float zoomY)
 Draws a rectangular frame around an image or ROI.
void DrawFrameWithCurrentPen (IntPtr graphicContext, bool handles, float zoomX)
 Draws a rectangular frame around an image or ROI.
void DrawFrameWithCurrentPen (IntPtr graphicContext, bool handles)
 Draws a rectangular frame around an image or ROI.
void DrawFrameWithCurrentPen (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY)
 Draws a rectangular frame around an image or ROI.
void DrawFrameWithCurrentPen (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX)
 Draws a rectangular frame around an image or ROI.
void DrawFrameWithCurrentPen (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY)
 Draws a rectangular frame around an image or ROI.
void DrawFrameWithCurrentPen (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX)
 Draws a rectangular frame around an image or ROI.
void DrawFrameWithCurrentPen (IntPtr graphicContext, eVision.EFramePosition framePosition, bool handles)
 Draws a rectangular frame around an image or ROI.
void Load (string path)
 Restores an image stored in the given file.
void Load (eVision.ESerializer serializer)
 Restores an image stored in the given file.
void Save (string path, eVision.EImageFileType type)
 Saves the EBaseROI object to the given file.
void Save (string path)
 Saves the EBaseROI object to the given file.
void Save (eVision.ESerializer serializer)
 Saves the EBaseROI object to the given file.
void SavePng (string path, int compression)
 Saves the EBaseROI object to the given file, in PNG format.
void SavePng (string path)
 Saves the EBaseROI object to the given file, in PNG format.
void SaveJpeg (string path, int quality)
 Saves the EBaseROI object to the given file, in JPEG format.
void SaveJpeg (string path)
 Saves the EBaseROI object to the given file, in JPEG format.
void SaveJpeg2K (string path, int quality)
 Saves the EBaseROI object to the given file, in JPEG 2000 format.
void SaveJpeg2K (string path)
 Saves the EBaseROI object to the given file, in JPEG 2000 format.
void DrawFrame (System.Drawing.Graphics graphicContext, bool handles, float zoomX, float zoomY, float panX, float panY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, bool handles, float zoomX, float zoomY, float panX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, bool handles, float zoomX, float zoomY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, bool handles, float zoomX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, bool handles)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX, float panY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY, float panX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX, float zoomY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, eVision.EFramePosition framePosition, bool handles, float zoomX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, eVision.EFramePosition framePosition, bool handles)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY, float panX, float panY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY, float panX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, bool handles, float zoomX, float zoomY)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, bool handles, float zoomX)
 Draws a rectangular frame around an image or ROI.
void DrawFrame (System.Drawing.Graphics graphicContext, eVision.ERGBColor color, bool handles)
 Draws a rectangular frame around an image or ROI.
void Draw (System.Drawing.Graphics graphicContext, float zoomX, float zoomY, float panX, float panY)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, float zoomX, float zoomY, float panX)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, float zoomX, float zoomY)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, float zoomX)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX, float panY)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY, float panX)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, eVision.EC24Vector c24Vector, float zoomX, float zoomY)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, eVision.EC24Vector c24Vector, float zoomX)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, eVision.EC24Vector c24Vector)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX, float panY)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY, float panX)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, eVision.EBW8Vector bw8Vector, float zoomX, float zoomY)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, eVision.EBW8Vector bw8Vector, float zoomX)
 Draws an ROI/image in a device context.
void Draw (System.Drawing.Graphics graphicContext, eVision.EBW8Vector bw8Vector)
 Draws an ROI/image in a device context.

Properties

eVision.EBaseROI BaseTopParent [get]
 Returns the image at the top of the hierarchy, or NULL if there is no image on top.
eVision.EBaseROI BaseImage [get]
 Returns the image associated with this ROI, or NULL if there is no image associated.
eVision.EBaseROI Parent [get]
 Returns the hierarchical parent of this object.
eVision.EBaseROI FirstSubROI [get]
 See GetFirstSubROI in the derived classes.
eVision.EBaseROI NextSiblingROI [get]
 This method returns the ROI that is the next sibling of this ROI.
int RowPitch [get]
 Gets the pitch of a row (the number of bytes between two vertically adjacent pixels). This is also valid for BW1 images (one bit per pixel).
int ColPitch [get]
 Gets the pitch of a column (number of bytes between two horizontally adjacent pixels). For BW1 (one bit per pixel) images, this value is undefined.
uint BitsPerPixel [get]
 Gets the number of storage bits per pixel.
int OrgX [get, set]
 Gets or sets the x-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
int OrgY [get, set]
 Gets or sets the y-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.
int Width [get, set]
 If EBaseROI is a ROI, gets or sets the width of the ROI. Otherwise, if EBaseROI is an image, gets or sets the width of the image (SetWidth has the same effect as EBaseROI.SetSize).
int Height [get, set]
 If EBaseROI is a ROI, gets or sets the height of the ROI. Otherwise, if EBaseROI is an image, gets or sets the height of the image (SetHeight has the same effect as EBaseROI.SetSize).
bool IsVoid [get]
 Tests if the topmost parent image of this hierarchy has a zero size.
int TotalOrgX [get]
 Gets the x-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.
int TotalOrgY [get]
 Gets the y-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.
int TotalWidth [get]
 Gets the width, in pixels, of the ROI topmost parent.
int TotalHeight [get]
 Gets the height, in pixels, of the ROI topmost parent.
uint PlanesPerPixel [get]
 Gets the number of color components in each pixel of the ROI/image.
eVision.EColorSystem ColorSystem [get, set]
 Gets or sets the color system used by this image, as defined by the EColorSystem enumeration.
eVision.EImageType Type [get]
 Gets the ROI/image pixel type, as defined by the EImageType enumeration.
string Author [get, set]
 Gets or sets the Author attribute of the ROI/image. This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.
string Comment [get, set]
 Gets or sets the Comment attribute of the ROI/image. This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.
string Date [get, set]
 Gets or sets the Date attribute of the ROI/image. This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.
string Title [get, set]
 Gets or sets the Title attribute of the ROI/image. This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

Detailed Description

This represents the abstract base class for all ROI and image classes.

License(s): BasicTypes

Member Function Documentation

◆ Attach() [1/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent)

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.

◆ Attach() [2/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
eVision.ERegion region )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
regionRegion whose bounding box defines the position and size of the ROI after attachment.

◆ Attach() [3/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
eVision.ERegion region,
eVision.EFrame frame )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
regionRegion whose bounding box defines the position and size of the ROI after attachment.
frameFrame used to transform the region from local to sensor coordinates before computing the bounding box.

◆ Attach() [4/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
eVision.ERegion region,
eVision.EFrame frame,
int paddingTop )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
regionRegion whose bounding box defines the position and size of the ROI after attachment.
frameFrame used to transform the region from local to sensor coordinates before computing the bounding box.
paddingTopNumber of pixels added above the bounding box.

◆ Attach() [5/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
eVision.ERegion region,
eVision.EFrame frame,
int paddingTop,
int paddingBottom )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
regionRegion whose bounding box defines the position and size of the ROI after attachment.
frameFrame used to transform the region from local to sensor coordinates before computing the bounding box.
paddingTopNumber of pixels added above the bounding box.
paddingBottomNumber of pixels added below the bounding box.

◆ Attach() [6/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
eVision.ERegion region,
eVision.EFrame frame,
int paddingTop,
int paddingBottom,
int paddingLeft )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
regionRegion whose bounding box defines the position and size of the ROI after attachment.
frameFrame used to transform the region from local to sensor coordinates before computing the bounding box.
paddingTopNumber of pixels added above the bounding box.
paddingBottomNumber of pixels added below the bounding box.
paddingLeftNumber of pixels added to the left of the bounding box.

◆ Attach() [7/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
eVision.ERegion region,
eVision.EFrame frame,
int paddingTop,
int paddingBottom,
int paddingLeft,
int paddingRight )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
regionRegion whose bounding box defines the position and size of the ROI after attachment.
frameFrame used to transform the region from local to sensor coordinates before computing the bounding box.
paddingTopNumber of pixels added above the bounding box.
paddingBottomNumber of pixels added below the bounding box.
paddingLeftNumber of pixels added to the left of the bounding box.
paddingRightNumber of pixels added to the right of the bounding box.

◆ Attach() [8/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
eVision.ERegion region,
int paddingTop )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
regionRegion whose bounding box defines the position and size of the ROI after attachment.
paddingTopNumber of pixels added above the bounding box.

◆ Attach() [9/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
eVision.ERegion region,
int paddingTop,
int paddingBottom )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
regionRegion whose bounding box defines the position and size of the ROI after attachment.
paddingTopNumber of pixels added above the bounding box.
paddingBottomNumber of pixels added below the bounding box.

◆ Attach() [10/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
eVision.ERegion region,
int paddingTop,
int paddingBottom,
int paddingLeft )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
regionRegion whose bounding box defines the position and size of the ROI after attachment.
paddingTopNumber of pixels added above the bounding box.
paddingBottomNumber of pixels added below the bounding box.
paddingLeftNumber of pixels added to the left of the bounding box.

◆ Attach() [11/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
eVision.ERegion region,
int paddingTop,
int paddingBottom,
int paddingLeft,
int paddingRight )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
regionRegion whose bounding box defines the position and size of the ROI after attachment.
paddingTopNumber of pixels added above the bounding box.
paddingBottomNumber of pixels added below the bounding box.
paddingLeftNumber of pixels added to the left of the bounding box.
paddingRightNumber of pixels added to the right of the bounding box.

◆ Attach() [12/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
int orgX,
int orgY )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
orgXWhen specified, sets the new x-coordinate of the ROI top-left corner.
orgYWhen specified, sets the new y-coordinate of the ROI top-left corner.

◆ Attach() [13/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
int orgX,
int orgY,
int width )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
orgXWhen specified, sets the new x-coordinate of the ROI top-left corner.
orgYWhen specified, sets the new y-coordinate of the ROI top-left corner.
widthWhen specified, sets the new width of the ROI.

◆ Attach() [14/14]

void eVision.EBaseROI.Attach ( eVision.EBaseROI parent,
int orgX,
int orgY,
int width,
int height )

This method attaches the ROI to another ROI or image.

Only ROIs can be attached. An image can never be attached to another image or ROI. Optionally, the ROI can be moved and resized after attachment by supplying additional parameters.

Parameters
parentROI or image on which to attach the ROI.
orgXWhen specified, sets the new x-coordinate of the ROI top-left corner.
orgYWhen specified, sets the new y-coordinate of the ROI top-left corner.
widthWhen specified, sets the new width of the ROI.
heightWhen specified, sets the new height of the ROI.

◆ CopyTo()

void eVision.EBaseROI.CopyTo ( eVision.EBaseROI dest)

Copies all the data of the current EBaseROI object into another EBaseROI object and returns it.

Parameters
destAn EBaseROI object in which the current EBaseROI object data have to be copied.

This method copies all the object date to the destination object. The attached ROIs are copied recursively and attached to the destination object. They will be deleted automatically when the destination object is deleted.

When the buffer of the source image has been provided by a call to UseExternalBuffer, the pointer will be copied into the destination image. Both images will thus refer the same external buffer.

◆ CropToImage()

void eVision.EBaseROI.CropToImage ( )

This method reduces the ROI size so that it is completely contained within its topmost parent image bounds (if such an image exists at the top of the hierarchy). This means that, after calling this method, either the ROI has a zero size, or all of its pixels map to valid pixels of the underlying image buffer. If the ROI is already contained within its parent image bounds, then this method does nothing.

◆ Detach()

void eVision.EBaseROI.Detach ( )

◆ Drag() [1/5]

void eVision.EBaseROI.Drag ( eVision.EDragHandle dragHandle,
int x,
int y )

Moves the specified handle to a new position and updates all placement parameters of the ROI.

Parameters
dragHandleHandle identifier, as defined by EDragHandle. The value returned by EBaseROI.HitTest should be used.
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.

If zooming and/or panning were used when drawing the ROI, the same values must be used with EBaseROI.HitTest and EBaseROI.Drag.

◆ Drag() [2/5]

void eVision.EBaseROI.Drag ( eVision.EDragHandle dragHandle,
int x,
int y,
float zoomX )

Moves the specified handle to a new position and updates all placement parameters of the ROI.

Parameters
dragHandleHandle identifier, as defined by EDragHandle. The value returned by EBaseROI.HitTest should be used.
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.

If zooming and/or panning were used when drawing the ROI, the same values must be used with EBaseROI.HitTest and EBaseROI.Drag.

◆ Drag() [3/5]

void eVision.EBaseROI.Drag ( eVision.EDragHandle dragHandle,
int x,
int y,
float zoomX,
float zoomY )

Moves the specified handle to a new position and updates all placement parameters of the ROI.

Parameters
dragHandleHandle identifier, as defined by EDragHandle. The value returned by EBaseROI.HitTest should be used.
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.

If zooming and/or panning were used when drawing the ROI, the same values must be used with EBaseROI.HitTest and EBaseROI.Drag.

◆ Drag() [4/5]

void eVision.EBaseROI.Drag ( eVision.EDragHandle dragHandle,
int x,
int y,
float zoomX,
float zoomY,
float panX )

Moves the specified handle to a new position and updates all placement parameters of the ROI.

Parameters
dragHandleHandle identifier, as defined by EDragHandle. The value returned by EBaseROI.HitTest should be used.
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

If zooming and/or panning were used when drawing the ROI, the same values must be used with EBaseROI.HitTest and EBaseROI.Drag.

◆ Drag() [5/5]

void eVision.EBaseROI.Drag ( eVision.EDragHandle dragHandle,
int x,
int y,
float zoomX,
float zoomY,
float panX,
float panY )

Moves the specified handle to a new position and updates all placement parameters of the ROI.

Parameters
dragHandleHandle identifier, as defined by EDragHandle. The value returned by EBaseROI.HitTest should be used.
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

If zooming and/or panning were used when drawing the ROI, the same values must be used with EBaseROI.HitTest and EBaseROI.Drag.

◆ Draw() [1/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext)

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [2/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EBW8Vector bw8Vector )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [3/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [4/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX,
float zoomY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [5/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX,
float zoomY,
float panX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [6/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX,
float zoomY,
float panX,
float panY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [7/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EC24Vector c24Vector )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [8/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EC24Vector c24Vector,
float zoomX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [9/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EC24Vector c24Vector,
float zoomX,
float zoomY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [10/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EC24Vector c24Vector,
float zoomX,
float zoomY,
float panX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [11/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
eVision.EC24Vector c24Vector,
float zoomX,
float zoomY,
float panX,
float panY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [12/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
float zoomX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [13/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
float zoomX,
float zoomY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [14/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
float zoomX,
float zoomY,
float panX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [15/45]

void eVision.EBaseROI.Draw ( eVision.EDrawAdapter graphicContext,
float zoomX,
float zoomY,
float panX,
float panY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ Draw() [16/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext)

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [17/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
eVision.EBW8Vector bw8Vector )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [18/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [19/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX,
float zoomY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [20/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX,
float zoomY,
float panX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [21/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX,
float zoomY,
float panX,
float panY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [22/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
eVision.EC24Vector c24Vector )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [23/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
eVision.EC24Vector c24Vector,
float zoomX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [24/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
eVision.EC24Vector c24Vector,
float zoomX,
float zoomY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [25/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
eVision.EC24Vector c24Vector,
float zoomX,
float zoomY,
float panX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [26/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
eVision.EC24Vector c24Vector,
float zoomX,
float zoomY,
float panX,
float panY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [27/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
float zoomX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [28/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
float zoomX,
float zoomY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [29/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
float zoomX,
float zoomY,
float panX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [30/45]

void eVision.EBaseROI.Draw ( IntPtr graphicContext,
float zoomX,
float zoomY,
float panX,
float panY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [31/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext)

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [32/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
eVision.EBW8Vector bw8Vector )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [33/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [34/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX,
float zoomY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [35/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX,
float zoomY,
float panX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [36/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
eVision.EBW8Vector bw8Vector,
float zoomX,
float zoomY,
float panX,
float panY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
bw8VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to BW8 when drawing.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [37/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
eVision.EC24Vector c24Vector )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [38/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
eVision.EC24Vector c24Vector,
float zoomX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [39/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
eVision.EC24Vector c24Vector,
float zoomX,
float zoomY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [40/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
eVision.EC24Vector c24Vector,
float zoomX,
float zoomY,
float panX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [41/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
eVision.EC24Vector c24Vector,
float zoomX,
float zoomY,
float panX,
float panY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
c24VectorWhen supplied, this parameter allows using a LUT that maps from BW8 to C24 when drawing (false colors).
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [42/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
float zoomX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [43/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
float zoomX,
float zoomY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [44/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
float zoomX,
float zoomY,
float panX )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [45/45]

void eVision.EBaseROI.Draw ( System.Drawing.Graphics graphicContext,
float zoomX,
float zoomY,
float panX,
float panY )

Draws an ROI/image in a device context.

Parameters
graphicContextHandle to the device context of the destination window.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

An ROI/image can be drawn (its pixels rendered) using a device context. The horizontal and vertical zooming factors can be different and must be contained in the 1/16..16 range. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [1/40]

void eVision.EBaseROI.DrawFrame ( eVision.EDrawAdapter graphicContext,
bool handles )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ DrawFrame() [2/40]

void eVision.EBaseROI.DrawFrame ( eVision.EDrawAdapter graphicContext,
bool handles,
float zoomX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ DrawFrame() [3/40]

void eVision.EBaseROI.DrawFrame ( eVision.EDrawAdapter graphicContext,
bool handles,
float zoomX,
float zoomY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ DrawFrame() [4/40]

void eVision.EBaseROI.DrawFrame ( eVision.EDrawAdapter graphicContext,
bool handles,
float zoomX,
float zoomY,
float panX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ DrawFrame() [5/40]

void eVision.EBaseROI.DrawFrame ( eVision.EDrawAdapter graphicContext,
bool handles,
float zoomX,
float zoomY,
float panX,
float panY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ DrawFrame() [6/40]

void eVision.EBaseROI.DrawFrame ( eVision.EDrawAdapter graphicContext,
eVision.EFramePosition framePosition,
bool handles )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ DrawFrame() [7/40]

void eVision.EBaseROI.DrawFrame ( eVision.EDrawAdapter graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ DrawFrame() [8/40]

void eVision.EBaseROI.DrawFrame ( eVision.EDrawAdapter graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ DrawFrame() [9/40]

void eVision.EBaseROI.DrawFrame ( eVision.EDrawAdapter graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY,
float panX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ DrawFrame() [10/40]

void eVision.EBaseROI.DrawFrame ( eVision.EDrawAdapter graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY,
float panX,
float panY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

◆ DrawFrame() [11/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
bool handles )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [12/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
bool handles,
float zoomX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [13/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
bool handles,
float zoomX,
float zoomY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [14/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
bool handles,
float zoomX,
float zoomY,
float panX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [15/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
bool handles,
float zoomX,
float zoomY,
float panX,
float panY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [16/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
eVision.EFramePosition framePosition,
bool handles )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [17/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [18/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [19/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY,
float panX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [20/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY,
float panX,
float panY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [21/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
eVision.ERGBColor color,
bool handles )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
colorColor in which to draw the frame.
handlestrue if handles are to be drawn.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [22/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
eVision.ERGBColor color,
bool handles,
float zoomX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
colorColor in which to draw the frame.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [23/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
eVision.ERGBColor color,
bool handles,
float zoomX,
float zoomY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
colorColor in which to draw the frame.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [24/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
eVision.ERGBColor color,
bool handles,
float zoomX,
float zoomY,
float panX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
colorColor in which to draw the frame.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [25/40]

void eVision.EBaseROI.DrawFrame ( IntPtr graphicContext,
eVision.ERGBColor color,
bool handles,
float zoomX,
float zoomY,
float panX,
float panY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
colorColor in which to draw the frame.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [26/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
bool handles )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [27/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
bool handles,
float zoomX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [28/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
bool handles,
float zoomX,
float zoomY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [29/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
bool handles,
float zoomX,
float zoomY,
float panX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [30/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
bool handles,
float zoomX,
float zoomY,
float panX,
float panY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [31/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
eVision.EFramePosition framePosition,
bool handles )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [32/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [33/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [34/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY,
float panX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [35/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY,
float panX,
float panY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [36/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
eVision.ERGBColor color,
bool handles )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
colorColor in which to draw the frame.
handlestrue if handles are to be drawn.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [37/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
eVision.ERGBColor color,
bool handles,
float zoomX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
colorColor in which to draw the frame.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [38/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
eVision.ERGBColor color,
bool handles,
float zoomX,
float zoomY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
colorColor in which to draw the frame.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [39/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
eVision.ERGBColor color,
bool handles,
float zoomX,
float zoomY,
float panX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
colorColor in which to draw the frame.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrame() [40/40]

void eVision.EBaseROI.DrawFrame ( System.Drawing.Graphics graphicContext,
eVision.ERGBColor color,
bool handles,
float zoomX,
float zoomY,
float panX,
float panY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
colorColor in which to draw the frame.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. A suitable default pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrameWithCurrentPen() [1/10]

void eVision.EBaseROI.DrawFrameWithCurrentPen ( IntPtr graphicContext,
bool handles )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. The current device context pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrameWithCurrentPen() [2/10]

void eVision.EBaseROI.DrawFrameWithCurrentPen ( IntPtr graphicContext,
bool handles,
float zoomX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. The current device context pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrameWithCurrentPen() [3/10]

void eVision.EBaseROI.DrawFrameWithCurrentPen ( IntPtr graphicContext,
bool handles,
float zoomX,
float zoomY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. The current device context pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrameWithCurrentPen() [4/10]

void eVision.EBaseROI.DrawFrameWithCurrentPen ( IntPtr graphicContext,
bool handles,
float zoomX,
float zoomY,
float panX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. The current device context pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrameWithCurrentPen() [5/10]

void eVision.EBaseROI.DrawFrameWithCurrentPen ( IntPtr graphicContext,
bool handles,
float zoomX,
float zoomY,
float panX,
float panY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. The current device context pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrameWithCurrentPen() [6/10]

void eVision.EBaseROI.DrawFrameWithCurrentPen ( IntPtr graphicContext,
eVision.EFramePosition framePosition,
bool handles )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. The current device context pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrameWithCurrentPen() [7/10]

void eVision.EBaseROI.DrawFrameWithCurrentPen ( IntPtr graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. The current device context pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrameWithCurrentPen() [8/10]

void eVision.EBaseROI.DrawFrameWithCurrentPen ( IntPtr graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. The current device context pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrameWithCurrentPen() [9/10]

void eVision.EBaseROI.DrawFrameWithCurrentPen ( IntPtr graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY,
float panX )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. The current device context pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawFrameWithCurrentPen() [10/10]

void eVision.EBaseROI.DrawFrameWithCurrentPen ( IntPtr graphicContext,
eVision.EFramePosition framePosition,
bool handles,
float zoomX,
float zoomY,
float panX,
float panY )

Draws a rectangular frame around an image or ROI.

Parameters
graphicContextHandle to the device context of the destination window.
framePositionPositioning of the frame relative to the ROI.
handlestrue if handles are to be drawn.
zoomXMagnification factor for zooming in or out in the horizontal direction. By default, the image is displayed in true scale.
zoomYMagnification factor for zooming in or out in the vertical direction. Setting a 0 value (which is the default) will result in isotropic scaling (i.e. equal horizontal and vertical factors).
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

A frame can be drawn (using a device context) around an image or ROI, possibly with 9 sizing handles. The current device context pen is used. Zooming and panning are possible. Please note that panning is applied before zooming. (MFC users can use the CDC::GetSafeHdc() method to obtain a suitable device context handle from a CDC instance.)

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ GetImagePtr() [1/2]

IntPtr eVision.EBaseROI.GetImagePtr ( )

Returns a pointer to the pixel at given coordinates within the image/ROI.

This method returns the memory address of the byte that contains the pixel (or address that contains the first byte of the pixel if it is bigger than one byte).

If the pixel coordinates are not specified, the method returns the address of the top-left pixel of the ROI/image.

◆ GetImagePtr() [2/2]

IntPtr eVision.EBaseROI.GetImagePtr ( int x,
int y )

Returns a pointer to the pixel at given coordinates within the image/ROI.

Parameters
xThe pixel x-coordinate.
yThe pixel y-coordinate.

This method returns the memory address of the byte that contains the pixel (or address that contains the first byte of the pixel if it is bigger than one byte).

If the pixel coordinates are not specified, the method returns the address of the top-left pixel of the ROI/image.

◆ GetNextROI()

eVision.EBaseROI eVision.EBaseROI.GetNextROI ( eVision.EBaseROI startROI)

Returns the next ROI in the list starting at startROI or null if there is no next ROI.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ GetNextSiblingSubROI()

eVision.EBaseROI eVision.EBaseROI.GetNextSiblingSubROI ( eVision.EBaseROI subROI)

This method returns the ROI that is the next sibling of the supplied ROI in the list of sub-ROIs.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ GetSubBaseROIs() [1/2]

eVision.EBaseROI[] eVision.EBaseROI.GetSubBaseROIs ( )

Returns all the children, and possibly recursively all their children, too.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ GetSubBaseROIs() [2/2]

eVision.EBaseROI[] eVision.EBaseROI.GetSubBaseROIs ( bool recursive)

Returns all the children, and possibly recursively all their children, too.

Parameters
recursivetrue to retrieve all sub-ROIs recursively. false otherwise.
Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HasSubROI()

bool eVision.EBaseROI.HasSubROI ( eVision.EBaseROI subROI)

Tests whether this object has a given attached ROI.

Parameters
subROISub ROI to find.
Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTest() [1/5]

eVision.EDragHandle eVision.EBaseROI.HitTest ( int x,
int y )

Detects if the cursor is placed over one of the dragging handles.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.

Returns a handle identifier, as defined by EDragHandle. If zooming and/or panning were used when drawing the ROI, the same values must be used with EBaseROI.HitTest and EBaseROI.Drag.

◆ HitTest() [2/5]

eVision.EDragHandle eVision.EBaseROI.HitTest ( int x,
int y,
float zoomX )

Detects if the cursor is placed over one of the dragging handles.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.

Returns a handle identifier, as defined by EDragHandle. If zooming and/or panning were used when drawing the ROI, the same values must be used with EBaseROI.HitTest and EBaseROI.Drag.

◆ HitTest() [3/5]

eVision.EDragHandle eVision.EBaseROI.HitTest ( int x,
int y,
float zoomX,
float zoomY )

Detects if the cursor is placed over one of the dragging handles.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.

Returns a handle identifier, as defined by EDragHandle. If zooming and/or panning were used when drawing the ROI, the same values must be used with EBaseROI.HitTest and EBaseROI.Drag.

◆ HitTest() [4/5]

eVision.EDragHandle eVision.EBaseROI.HitTest ( int x,
int y,
float zoomX,
float zoomY,
float panX )

Detects if the cursor is placed over one of the dragging handles.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.

Returns a handle identifier, as defined by EDragHandle. If zooming and/or panning were used when drawing the ROI, the same values must be used with EBaseROI.HitTest and EBaseROI.Drag.

◆ HitTest() [5/5]

eVision.EDragHandle eVision.EBaseROI.HitTest ( int x,
int y,
float zoomX,
float zoomY,
float panX,
float panY )

Detects if the cursor is placed over one of the dragging handles.

Parameters
xx-coordinate of the mouse cursor.
yy-coordinate of the mouse cursor.
zoomXHorizontal zoom factor. By default, true scale is used.
zoomYVertical zoom factor. By default, true scale is used.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.

Returns a handle identifier, as defined by EDragHandle. If zooming and/or panning were used when drawing the ROI, the same values must be used with EBaseROI.HitTest and EBaseROI.Drag.

◆ IsAnROI()

bool eVision.EBaseROI.IsAnROI ( )

Tests whether this object is an ROI or an image.

◆ IsAttached()

bool eVision.EBaseROI.IsAttached ( )

Returns true if the ROI is attached to an image.

◆ IsPixelInside()

bool eVision.EBaseROI.IsPixelInside ( int x,
int y )

Detects if a pixel (given its x and y coordinates) is inside current ROI.

Parameters
xx-coordinate of the pixel.
yy-coordinate of the pixel.

For more information about image coordinate systems, please check eVision conventions.

◆ IsPointInside()

bool eVision.EBaseROI.IsPointInside ( eVision.EPoint position)

Detects if the position is inside current ROI.

Parameters
positionPosition to be tested.

For more information about image coordinate systems, please check eVision conventions.

◆ Load() [1/2]

void eVision.EBaseROI.Load ( eVision.ESerializer serializer)

Restores an image stored in the given file.

Parameters
serializerThe ESerializer file-like object that is read from.

When loading, an image is resized if need be. On the opposite, an ROI cannot be resized, and the sizes must match. The image contents around the ROI remains unchanged. If a serializer is used, then the Euresys proprietary file format is expected. This format preserves attributes and sub-ROIs. See Supported Image File Types for details about supported files. See Image File Access - Save, Load - for details about file format and compatibility. When loading a color image file into a gray-level image, the conversion equation will depend on the current ERgbStandard set.

◆ Load() [2/2]

void eVision.EBaseROI.Load ( string path)

Restores an image stored in the given file.

Parameters
pathFull path of the file.

When loading, an image is resized if need be. On the opposite, an ROI cannot be resized, and the sizes must match. The image contents around the ROI remains unchanged. If a serializer is used, then the Euresys proprietary file format is expected. This format preserves attributes and sub-ROIs. See Supported Image File Types for details about supported files. See Image File Access - Save, Load - for details about file format and compatibility. When loading a color image file into a gray-level image, the conversion equation will depend on the current ERgbStandard set.

◆ Save() [1/3]

void eVision.EBaseROI.Save ( eVision.ESerializer serializer)

Saves the EBaseROI object to the given file.

Parameters
serializerThe ESerializer file-like object that is written to.

By default, (if no format is specified), the file format is determined from the file extension. If a serializer is used, then the Euresys proprietary file format is used. This format preserves attributes and sub-ROIs. See Supported Image File Types for details about supported files. See Image File Access - Save, Load - for details about file format and compatibility.

◆ Save() [2/3]

void eVision.EBaseROI.Save ( string path)

Saves the EBaseROI object to the given file.

Parameters
pathThe full path of the destination file.

By default, (if no format is specified), the file format is determined from the file extension. If a serializer is used, then the Euresys proprietary file format is used. This format preserves attributes and sub-ROIs. See Supported Image File Types for details about supported files. See Image File Access - Save, Load - for details about file format and compatibility.

◆ Save() [3/3]

void eVision.EBaseROI.Save ( string path,
eVision.EImageFileType type )

Saves the EBaseROI object to the given file.

Parameters
pathThe full path of the destination file.
typeFile format, as defined by EImageFileType. If not specified, the file format is determined from the file extension.

By default, (if no format is specified), the file format is determined from the file extension. If a serializer is used, then the Euresys proprietary file format is used. This format preserves attributes and sub-ROIs. See Supported Image File Types for details about supported files. See Image File Access - Save, Load - for details about file format and compatibility.

◆ SaveJpeg() [1/2]

void eVision.EBaseROI.SaveJpeg ( string path)

Saves the EBaseROI object to the given file, in JPEG format.

Parameters
pathThe full path of the destination file.

See Image File Access - Save, Load - for details about file format and quality.

◆ SaveJpeg() [2/2]

void eVision.EBaseROI.SaveJpeg ( string path,
int quality )

Saves the EBaseROI object to the given file, in JPEG format.

Parameters
pathThe full path of the destination file.
qualityJPEG quality, between 0 and 100 (100 is the best quality). The default value is 75.

See Image File Access - Save, Load - for details about file format and quality.

◆ SaveJpeg2K() [1/2]

void eVision.EBaseROI.SaveJpeg2K ( string path)

Saves the EBaseROI object to the given file, in JPEG 2000 format.

Parameters
pathThe full path of the destination file.

See Image File Access - Save, Load - for details about file format and quality.

◆ SaveJpeg2K() [2/2]

void eVision.EBaseROI.SaveJpeg2K ( string path,
int quality )

Saves the EBaseROI object to the given file, in JPEG 2000 format.

Parameters
pathThe full path of the destination file.
qualityJPEG 2000 quality, between 1 and 512. The default value is 16.

See Image File Access - Save, Load - for details about file format and quality.

◆ SavePng() [1/2]

void eVision.EBaseROI.SavePng ( string path)

Saves the EBaseROI object to the given file, in PNG format.

Parameters
pathThe full path of the destination file.

See Image File Access - Save, Load - for details about file format and quality.

◆ SavePng() [2/2]

void eVision.EBaseROI.SavePng ( string path,
int compression )

Saves the EBaseROI object to the given file, in PNG format.

Parameters
pathThe full path of the destination file.
compressionPNG compression, between 1 and 9 (1 is the fastest and 9 is the best compression). The default value is 1.

See Image File Access - Save, Load - for details about file format and quality.

◆ Serialize()

void eVision.EBaseROI.Serialize ( eVision.ESerializer serializer)
abstract

Serializes the EBaseROI.

◆ SetImagePtr() [1/2]

void eVision.EBaseROI.SetImagePtr ( int width,
int height,
IntPtr imagePointer )

Sets the pointer to an externally allocated image buffer.

Parameters
widthThe width of the supplied buffer, in pixels.
heightThe height of the supplied buffer, in pixels.
imagePointerThe pointer (aligned on 4 bytes) to the buffer, which must be large enough to hold the image.

This call is only valid on an image. An ROI gets its buffer from its parent while an image normally allocates a pixel buffer automatically. The pointer to this buffer refers to the top left pixel of the image. The next pixels are stored contiguously, row by row, from top to bottom and from left to right.

Padding at the end of a row may be used, but it must lead to rows that are multiple of 4 bytes. This method overrides the internally allocated image buffer of the EBaseROI.

As long as the image accesses this buffer, it must not be deleted.

Deprecated

Use EBaseROI.UseExternalBuffer instead.

Deprecated in version 26.2. Scheduled to be removed in version 27.6.

◆ SetImagePtr() [2/2]

void eVision.EBaseROI.SetImagePtr ( int width,
int height,
IntPtr imagePointer,
int bitsPerRow )

Sets the pointer to an externally allocated image buffer.

Parameters
widthThe width of the supplied buffer, in pixels.
heightThe height of the supplied buffer, in pixels.
imagePointerThe pointer (aligned on 4 bytes) to the buffer, which must be large enough to hold the image.
bitsPerRowThe total number of bits contained in a row, padding included. Using the value 0 (default) means that this size is computed from the buffer width and the pixel size plus a padding with the smallest possible value that leads to a multiple of 4 bytes (32 bits), which is the minimum padding accepted by this method.

This call is only valid on an image. An ROI gets its buffer from its parent while an image normally allocates a pixel buffer automatically. The pointer to this buffer refers to the top left pixel of the image. The next pixels are stored contiguously, row by row, from top to bottom and from left to right.

Padding at the end of a row may be used, but it must lead to rows that are multiple of 4 bytes. This method overrides the internally allocated image buffer of the EBaseROI.

As long as the image accesses this buffer, it must not be deleted.

Deprecated

Use EBaseROI.UseExternalBuffer instead.

Deprecated in version 26.2. Scheduled to be removed in version 27.6.

◆ SetPlacement() [1/11]

void eVision.EBaseROI.SetPlacement ( eVision.ERegion region)

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
regionRegion whose bounding box defines the new position and size of the ROI.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetPlacement() [2/11]

void eVision.EBaseROI.SetPlacement ( eVision.ERegion region,
eVision.EFrame frame )

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
regionRegion whose bounding box defines the new position and size of the ROI.
frameFrame used to define the input region.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetPlacement() [3/11]

void eVision.EBaseROI.SetPlacement ( eVision.ERegion region,
eVision.EFrame frame,
int paddingTop )

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
regionRegion whose bounding box defines the new position and size of the ROI.
frameFrame used to define the input region.
paddingTopNumber of pixels added above (or removed from, if negative) the bounding box.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetPlacement() [4/11]

void eVision.EBaseROI.SetPlacement ( eVision.ERegion region,
eVision.EFrame frame,
int paddingTop,
int paddingBottom )

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
regionRegion whose bounding box defines the new position and size of the ROI.
frameFrame used to define the input region.
paddingTopNumber of pixels added above (or removed from, if negative) the bounding box.
paddingBottomNumber of pixels added below (or removed from, if negative) the bounding box.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetPlacement() [5/11]

void eVision.EBaseROI.SetPlacement ( eVision.ERegion region,
eVision.EFrame frame,
int paddingTop,
int paddingBottom,
int paddingLeft )

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
regionRegion whose bounding box defines the new position and size of the ROI.
frameFrame used to define the input region.
paddingTopNumber of pixels added above (or removed from, if negative) the bounding box.
paddingBottomNumber of pixels added below (or removed from, if negative) the bounding box.
paddingLeftNumber of pixels added to the left of (or removed from, if negative) the bounding box.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetPlacement() [6/11]

void eVision.EBaseROI.SetPlacement ( eVision.ERegion region,
eVision.EFrame frame,
int paddingTop,
int paddingBottom,
int paddingLeft,
int paddingRight )

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
regionRegion whose bounding box defines the new position and size of the ROI.
frameFrame used to define the input region.
paddingTopNumber of pixels added above (or removed from, if negative) the bounding box.
paddingBottomNumber of pixels added below (or removed from, if negative) the bounding box.
paddingLeftNumber of pixels added to the left of (or removed from, if negative) the bounding box.
paddingRightNumber of pixels added to the right of (or removed from, if negative) the bounding box.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetPlacement() [7/11]

void eVision.EBaseROI.SetPlacement ( eVision.ERegion region,
int paddingTop )

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
regionRegion whose bounding box defines the new position and size of the ROI.
paddingTopNumber of pixels added above (or removed from, if negative) the bounding box.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetPlacement() [8/11]

void eVision.EBaseROI.SetPlacement ( eVision.ERegion region,
int paddingTop,
int paddingBottom )

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
regionRegion whose bounding box defines the new position and size of the ROI.
paddingTopNumber of pixels added above (or removed from, if negative) the bounding box.
paddingBottomNumber of pixels added below (or removed from, if negative) the bounding box.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetPlacement() [9/11]

void eVision.EBaseROI.SetPlacement ( eVision.ERegion region,
int paddingTop,
int paddingBottom,
int paddingLeft )

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
regionRegion whose bounding box defines the new position and size of the ROI.
paddingTopNumber of pixels added above (or removed from, if negative) the bounding box.
paddingBottomNumber of pixels added below (or removed from, if negative) the bounding box.
paddingLeftNumber of pixels added to the left of (or removed from, if negative) the bounding box.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetPlacement() [10/11]

void eVision.EBaseROI.SetPlacement ( eVision.ERegion region,
int paddingTop,
int paddingBottom,
int paddingLeft,
int paddingRight )

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
regionRegion whose bounding box defines the new position and size of the ROI.
paddingTopNumber of pixels added above (or removed from, if negative) the bounding box.
paddingBottomNumber of pixels added below (or removed from, if negative) the bounding box.
paddingLeftNumber of pixels added to the left of (or removed from, if negative) the bounding box.
paddingRightNumber of pixels added to the right of (or removed from, if negative) the bounding box.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetPlacement() [11/11]

void eVision.EBaseROI.SetPlacement ( int originX,
int originY,
int width,
int height )

Sets the placement of an ROI, relative to its parent ROI/image.

Parameters
originXNew x-coordinate of the top-left pixel of this ROI.
originYNew y-coordinate of the top-left pixel of this ROI.
widthNew ROI width.
heightNew ROI height.

This method can only be called on ROIs. The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ SetSize() [1/2]

void eVision.EBaseROI.SetSize ( eVision.EBaseROI other)

Sets the width and height of an ROI/image.

Parameters
otherThe other ROI/image whose dimensions have to be used for the current object.

eVision will allocate a new image buffer (deallocate the old image buffer) if the supplied width and height are different from the existing ones. If an external buffer has been specified by means of UseExternalBuffer, it will be kept only if the size does not change. Creating a new eVision image buffer and setting its size creates a 4-byte aligned buffer, by default. The size of an image is specified as a number of columns (width) and rows (height). The maximum image dimensions are 2^30 by 2^30. Furthermore, it must fit into the available memory, that depends upon the physical memory, the operating system and the memory already allocated by the process in other modules or libraries. The placement of an ROI is given by the x and y coordinates of its upper left pixel relative to its parent image, and also by its width and its height.

◆ SetSize() [2/2]

void eVision.EBaseROI.SetSize ( int width,
int height )

Sets the width and height of an ROI/image.

Parameters
widthThe new requested ROI/image width.
heightThe new requested ROI/image height.

eVision will allocate a new image buffer (deallocate the old image buffer) if the supplied width and height are different from the existing ones. If an external buffer has been specified by means of UseExternalBuffer, it will be kept only if the size does not change. Creating a new eVision image buffer and setting its size creates a 4-byte aligned buffer, by default. The size of an image is specified as a number of columns (width) and rows (height). The maximum image dimensions are 2^30 by 2^30. Furthermore, it must fit into the available memory, that depends upon the physical memory, the operating system and the memory already allocated by the process in other modules or libraries. The placement of an ROI is given by the x and y coordinates of its upper left pixel relative to its parent image, and also by its width and its height.

◆ UseExternalBuffer()

void eVision.EBaseROI.UseExternalBuffer ( int width,
int height,
IntPtr buffer,
int rowPitch )

Sets the pointer to an externally allocated image buffer.

Parameters
widthThe width of the supplied buffer, in pixels.
heightThe height of the supplied buffer, in pixels.
bufferThe pointer (aligned on 4 bytes) to the buffer, which must be large enough to hold the image.
rowPitchThe total number of bytes contained in a row, padding included.

This call is only valid on an image. An ROI gets its buffer from its parent while an image normally allocates a pixel buffer automatically. The pointer to this buffer refers to the top left pixel of the image. The next pixels are stored contiguously, row by row, from top to bottom and from left to right.

Padding at the end of a row may be used, but it must lead to rows that are multiple of 4 bytes. This method overrides the internally allocated image buffer of the EBaseROI.

As long as the image accesses this buffer, it must not be deleted.

Property Documentation

◆ Author

string eVision.EBaseROI.Author
getset

Gets or sets the Author attribute of the ROI/image. This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ BaseImage

eVision.EBaseROI eVision.EBaseROI.BaseImage
get

Returns the image associated with this ROI, or NULL if there is no image associated.

◆ BaseTopParent

eVision.EBaseROI eVision.EBaseROI.BaseTopParent
get

Returns the image at the top of the hierarchy, or NULL if there is no image on top.

Deprecated

Use EBaseROI.BaseImage instead.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ BitsPerPixel

uint eVision.EBaseROI.BitsPerPixel
get

Gets the number of storage bits per pixel.

◆ ColorSystem

eVision.EColorSystem eVision.EBaseROI.ColorSystem
getset

Gets or sets the color system used by this image, as defined by the EColorSystem enumeration.

Upon object creation, a default color system is set, compatible with the ROI/image type (EColorSystem.EColorSystem_GrayLevel for gray-level types and EColorSystem.EColorSystem_Rgb for color types).

The color system associated to an image is mainly relevant when working on color images. See EasyColor (FG) for more information.

◆ ColPitch

int eVision.EBaseROI.ColPitch
get

Gets the pitch of a column (number of bytes between two horizontally adjacent pixels). For BW1 (one bit per pixel) images, this value is undefined.

◆ Comment

string eVision.EBaseROI.Comment
getset

Gets or sets the Comment attribute of the ROI/image. This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ Date

string eVision.EBaseROI.Date
getset

Gets or sets the Date attribute of the ROI/image. This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ FirstSubROI

eVision.EBaseROI eVision.EBaseROI.FirstSubROI
get

See GetFirstSubROI in the derived classes.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ Height

int eVision.EBaseROI.Height
getset

If EBaseROI is a ROI, gets or sets the height of the ROI. Otherwise, if EBaseROI is an image, gets or sets the height of the image (SetHeight has the same effect as EBaseROI.SetSize).

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ IsVoid

bool eVision.EBaseROI.IsVoid
get

Tests if the topmost parent image of this hierarchy has a zero size.

For an image, this method returns true if the image size is zero.

For an ROI, this method returns true if the topmost parent image size is zero or if there is no topmost image.

◆ NextSiblingROI

eVision.EBaseROI eVision.EBaseROI.NextSiblingROI
get

This method returns the ROI that is the next sibling of this ROI.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of of ROI and Image classes.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ OrgX

int eVision.EBaseROI.OrgX
getset

Gets or sets the x-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ OrgY

int eVision.EBaseROI.OrgY
getset

Gets or sets the y-coordinate of the upper left corner of the ROI, relative to its parent ROI/image.

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).

◆ Parent

eVision.EBaseROI eVision.EBaseROI.Parent
get

Returns the hierarchical parent of this object.

Deprecated

Deprecated due to the high runtime cost on all operations of maintaining a ROI hierarchy.

If a ROI hierarchy is necessary it is now recommended to maintain it outside of ROI and Image classes.

To test if an ROI is attached or not you can also use EBaseROI.IsAttached.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ PlanesPerPixel

uint eVision.EBaseROI.PlanesPerPixel
get

Gets the number of color components in each pixel of the ROI/image.

◆ RowPitch

int eVision.EBaseROI.RowPitch
get

Gets the pitch of a row (the number of bytes between two vertically adjacent pixels). This is also valid for BW1 images (one bit per pixel).

◆ Title

string eVision.EBaseROI.Title
getset

Gets or sets the Title attribute of the ROI/image. This is a convenience property that allows storing some information in the ROI/image. Please note that not all file formats preserve this information.

◆ TotalHeight

int eVision.EBaseROI.TotalHeight
get

Gets the height, in pixels, of the ROI topmost parent.

The total size of an ROI is the size of its topmost parent.

◆ TotalOrgX

int eVision.EBaseROI.TotalOrgX
get

Gets the x-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.

The total origin coordinates of an ROI indicate the position of its upper left pixel relative to the topmost parent image.

The total origin coordinates (top-left pixel) of a topmost parent are always (0,0).

◆ TotalOrgY

int eVision.EBaseROI.TotalOrgY
get

Gets the y-coordinate of the upper left pixel of the ROI, relative to its topmost parent upper left pixel.

The total origin coordinates of an ROI indicate the position of its upper left pixel relative to the topmost parent.

The total origin coordinates (top-left pixel) of a topmost parent are always (0,0).

◆ TotalWidth

int eVision.EBaseROI.TotalWidth
get

Gets the width, in pixels, of the ROI topmost parent.

The total size of an ROI is the size of its topmost parent.

◆ Type

eVision.EImageType eVision.EBaseROI.Type
get

Gets the ROI/image pixel type, as defined by the EImageType enumeration.

◆ Width

int eVision.EBaseROI.Width
getset

If EBaseROI is a ROI, gets or sets the width of the ROI. Otherwise, if EBaseROI is an image, gets or sets the width of the image (SetWidth has the same effect as EBaseROI.SetSize).

The placement of an ROI is given by the coordinates its upper left corner (origin point), relative to its parent ROI/image and by its size (width and height).