ILDisplay Interface Reference

This interface provide functionalities of the display control. More...

Inheritance diagram for ILDisplay:

Public Member Functions
int	AddObject (IDispatch *drawable, int drawFlags)
int	AddRegion (IDispatch *region, BOOL interactable)
void	ClientToImage (int x, int y, double *imageX, double *imageY)
void	FitInViewObject (IDispatch *object, LPVAlignment alignFlags)
IDispatch *	GetImage ()
IDispatch *	GetObjectByID (int objectId)
IDispatch *	GetRegionByID (int regionId)
void	ImageToClient (double imageX, double imageY, int *x, int *y)
void	RemoveAllObjects ()
void	RemoveAllRegions ()
void	RemoveImage ()
void	RemoveObject (IDispatch *drawable)
void	RemoveObjectByID (int objectId)
void	RemoveRegion (IDispatch *region)
void	RemoveRegionByID (int regionId)
void	SetImage (IDispatch *image)
Public Member Functions inherited from ILDisplayCommon
int	AddReferenceLineH (double position, double relativePosition, BOOL attached, OLE_COLOR clr)
int	AddReferenceLineV (double position, double relativePosition, BOOL attached, OLE_COLOR clr)
void	FitInView (int tlx, int tly, int w, int h, LPVAlignment alignFlags)
void	FitToWindow (LPVAlignment alignFlags)
void	Refresh ()
void	RefreshImmediate ()
void	RemoveAllReferenceLine ()
void	RemoveReferenceLine (int refLineId)
int	SaveSceneToFile (BSTR filename, double zoomX, double zoomY)
int	SaveWindowToFile (BSTR filename)
void	SetDisplayFlag (LPVDisplayFlags flag, BOOL enable)
void	SetSize (int w, int h)
void	ShowDialog (BSTR dialogName, int x, int y, int w, int h)
void	ShowDialogAsync (BSTR dialogName, int x, int y, int w, int h, int refreshInterval)

Properties
BOOL	KeepAspectRatio [get, set]
	Whether the display control should keep the aspect ratio when zooming.
int	PixelUnderMouse [get]
	The pixel value under current cursor's position.
Properties inherited from ILDisplayCommon
LPVAlignment	Alignment [get, set]
	The alignment the control is used when fit some part of the scene to the window.
BOOL	AutoRefreshEnabled [get, set]
	Enables or disables automatically display re-rendering triggered by add/remove objects or regions or the image. By default, it's on.
OLE_COLOR	BackColor [get, set]
	The background color of the display control.
LPVDisplayFlags	DisplayFlags [get, set]
	The display flags, see LPVDisplayFlags.
BOOL	DrawingEnabled [get, set]
	Enables or disables all display rendering. Useful when performing many graphics or image operations at once.
LPVScrollBarPolicy	HScrollBarPolicy [get, set]
	The policy of the horizontal scroll bar, see LPVScrollBarPolicy.
double	PanX [get, set]
	The scene's translation in the x-coordinate direction for panning. The final display x position is calculated as: @math_eq{(x + panX) \times zoomX}.
double	PanY [get, set]
	The scene's translation in the y-coordinate direction for panning. The final display y position is calculated as: @math_eq{(y + panY) \times zoomY}.
LPVScrollBarPolicy	VScrollBarPolicy [get, set]
	The policy of the vertical scroll bar, see LPVScrollBarPolicy.
double	Zoom [set]
	Set the scene's zoom factor in both x- and y-coordinate direction.
LPVZoomAnchor	ZoomAnchor [get, set]
	How the control should position the scene when resized, see LPVZoomAnchor.
double	ZoomX [get, set]
	The scene's zoom factor in or out in the x-coordinate direction.
double	ZoomY [get, set]
	The scene's zoom factor in or out in the y-coordinate direction.

Detailed Description

This interface provide functionalities of the display control.

Usually you add the display control via the Toolbox in Visual Studio. This interface helps you to manage the scene in the display control, for the image, regions, geometric shapes and algorithms' results to shown in the control.

See ILDisplayEvents for the control's event.

Example Code

C++

// lpvDisplay is a COM ActiveX library, it supports only COM interface.
// for every pass-in LPV object, you should cast it to IDispatch via LObjectToDispatch() function.
// since 2.2.0, use the built-in implicit type casting.
 
// set image to the control
displayCtrl->SetImage(LObjectToDispatch(*img));
displayCtrl->SetImage(*img); // since 2.2.0
 
// add a rectangle region to the control
ILRectRegionPtr roi = LRectRegion::Create();
roi->SetPlacement(10, 10, 200, 100);
displayCtrl->AddRegion(LObjectToDispatch(*roi), true); // it's interactive
displayCtrl->AddRegion(*roi, true); // since 2.2.0
 
// add a circle to the control
ILCirclePtr circle = LCircle::Create();
circle->Set(100, 50, 50);
displayCtrl->AddObject(LObjectToDispatch(*circle), 0); // use default draw flags
displayCtrl->AddObject(*circle, 0); // since 2.2.0
 
// add the pattern matching result to the control
displayCtrl->AddObject(LObjectToDispatch(*matchResults),
    (LPVPatDrawFlags)(LPVPatDrawFlags::LPVPatDrawBoundingRect | LPVPatDrawFlags::LPVPatDrawCenter));
displayCtrl->AddObject(*matchResults, LPVPatDrawFlags::LPVPatDrawDefault); // since 2.2.0

C#

// set image to the control
displayCtrl.SetImage(img);
 
// add a rectangle region to the control
LRectRegion roi = new LRectRegion();
roi.SetPlacement(10, 10, 200, 100);
displayCtrl.AddRegion(roi, true); // it's interactive
 
// add a circle to the control
LCircle circle = new LCircle();
circle.Set(100, 50, 50);
displayCtrl.AddObject(circle); // use default draw flags
 
// add the pattern matching result to the control
displayCtrl.AddObject(matchResults, LPVPatDrawFlags.LPVPatDrawBoundingRect | LPVPatDrawFlags.LPVPatDrawCenter);

COM

// set image to the control
displayCtrl->SetImage(img);
 
// add a rectangle region to the control
ILRectRegionPtr roi = LRectRegion::Create();
// or, ILRectRegionPtr roi(__uuidof(LRectRegion)), for absence of built-in Create functions (before 2.2.0)
roi->SetPlacement(10, 10, 200, 100);
displayCtrl->AddRegion(roi, VARIANT_TRUE); // it's interactive
 
// add a circle to the control
ILCirclePtr circle = LCircle::Create();
// or, ILCirclePtr circle(__uuidof(LCircle)), for absence of built-in Create functions (before 2.2.0)
circle->Set(100, 50, 50);
displayCtrl->AddObject(circle, 0); // use default draw flags
 
// add the pattern matching result to the control
displayCtrl->AddObject(matchResults, (LPVPatDrawFlags)(LPVPatDrawFlags::LPVPatDrawBoundingRect | LPVPatDrawFlags::LPVPatDrawCenter));

Note: This interface is currently not available on Linux / MacOS platform.

Member Function Documentation

AddObject()

int AddObject	(	IDispatch *	drawable,
		int	drawFlags
	)

Add the drawable item to the scene. It's usually a geometric shape or some algorithm' results.

Parameters

[in]	drawable	The object item, it should be an object implemented the ILDrawable interface, or LText object.
[in]	drawFlags	The draw flags to control the item's drawing behavior.

Return values

objectId

Return the ID of the new item in the scene.

AddRegion()

int AddRegion	(	IDispatch *	region,
		BOOL	interactable
	)

Add the region item to the scene.

Parameters

[in]	region	The region item, it should be a LRegion instance.
[in]	interactable	Whether the region object is interactable. By default, it's True.

Return values

regionId

Return the ID of the new item in the scene.

ClientToImage()

void ClientToImage	(	int	x,
		int	y,
		double *	imageX,
		double *	imageY
	)

Map the position from the display control's client coordinates to the images' coordinates.

Parameters

[in]	x	The x-coordinate of the position, relative to the upper-left corner of the display control's client area.
[in]	y	The y-coordinate of the position, relative to the upper-left corner of the display control's client area.
[out]	imageX	Output the x-coordinate of the transformed position, relative to the upper-left corner of the image.
[out]	imageY	Output the y-coordinate of the transformed position, relative to the upper-left corner of the image.

FitInViewObject()

void FitInViewObject	(	IDispatch *	object,
		LPVAlignment	alignFlags
	)

Zoom and translate the scene, to view the specified object and fit the window.

Parameters

[in]	object	The object item to view.
[in]	alignFlags	The alignment, the control's Alignment property is used if it's not set.

GetImage()

IDispatch* GetImage

(

)

Get the image of the scene.

Return values

image

Return the image object

GetObjectByID()

IDispatch* GetObjectByID

(

int

objectId

)

Get the drawable item by its ID in the scene

Parameters

[in]

objectId

The drawable item's ID.

Return values

drawable

Return the object item

GetRegionByID()

IDispatch* GetRegionByID

(

int

regionId

)

Get the region item by its ID in the scene

Parameters

[in]

regionId

The region item's ID.

Return values

region

Return the region item

ImageToClient()

void ImageToClient	(	double	imageX,
		double	imageY,
		int *	x,
		int *	y
	)

Map the position from the images' coordinates to the display control's client coordinates.

Parameters

[in]	imageX	The x-coordinate of the position, relative to the upper-left corner of the image.
[in]	imageY	The y-coordinate of the position, relative to the upper-left corner of the image.
[out]	x	Output the x-coordinate of the transformed position, relative to the upper-left corner of the display control's client area
[out]	y	Output the y-coordinate of the transformed position, relative to the upper-left corner of the display control's client area

RemoveAllObjects()

void RemoveAllObjects

(

)

Remove all drawable items from the scene.

RemoveAllRegions()

void RemoveAllRegions

(

)

Remove all region items from the scene.

RemoveImage()

void RemoveImage

(

)

Remove the image from the scene. The current scene size is retained.

RemoveObject()

void RemoveObject

(

IDispatch *

drawable

)

Remove the drawable item from the scene.

Parameters

[in]

drawable

The drawable item to be removed.

RemoveObjectByID()

void RemoveObjectByID

(

int

objectId

)

Remove the drawable item from the scene, by its ID.

Parameters

[in]

objectId

The drawable item's ID.

RemoveRegion()

void RemoveRegion

(

IDispatch *

region

)

Remove the region item from the scene.

Parameters

[in]

region

The region item to be removed.

RemoveRegionByID()

void RemoveRegionByID

(

int

regionId

)

Remove the region item from the scene, by its ID.

Parameters

[in]

regionId

The region item's ID.

SetImage()

void SetImage

(

IDispatch *

image

)

Set the image of the scene. The size of the scene is extended to the image size.

Parameters

[in]

image

The image item, it should be a LImage instance.