LPV Display Library, provide ui controls for display images, regions, geometric primitives and other algorithms' results. More...

Data Structures
interface	ILDisplay
	This interface provide functionalities of the display control. More...

interface	ILDisplayCommon
	This interface provide basic functionalities of the display controls. More...

interface	ILDisplayEvents
	The events for LDisplay control. Note: This interface is currently not available on Linux / MacOS platform. More...

interface	ILText
	This interface expose APIs to create/modify a drawable text object. More...

class	LDisplay

class	LText

Enumerations
enum	LPVAlignment { LPVAlignDefault = 0 , LPVAlignLeft = 0x0001 , LPVAlignRight = 0x0002 , LPVAlignHCenter = 0x0004 , LPVAlignTop = 0x0010 , LPVAlignBottom = 0x0020 , LPVAlignVCenter = 0x0040 , LPVAlignCenter = LPVAlignHCenter + LPVAlignVCenter }
	This enumeration is used to describe alignment. More...

enum	LPVDisplayEventIDs { LPVDisplayEventRefreshed = 0x8101 , LPVDisplayEventMouseDown = 0x8102 , LPVDisplayEventMouseUp = 0x8103 , LPVDisplayEventMouseDoubleClick = 0x8104 , LPVDisplayEventMouseMove = 0x8105 , LPVDisplayEventMouseWheel = 0x8106 , LPVDisplayEventKeyDown = 0x8107 , LPVDisplayEventKeyUp = 0x8108 , LPVDisplayEventRegionDragging = 0x8120 , LPVDisplayEventRegionDragFinished = 0x8121 , LPVDisplayEventRegionRemoving = 0x8122 , LPVDisplayEventRegionRemovingAll = 0x8123 , LPVDisplayEventObjectDragging = 0x8124 , LPVDisplayEventObjectDragFinished = 0x8125 , LPVDisplayEventObjectRemoving = 0x8126 , LPVDisplayEventObjectRemovingAll = 0x8127 }
	This enumeration is for the event IDs from the ILDisplayEvents interface. More...

enum	LPVDisplayFlags { LPVDisplayMovable = 0x01 , LPVDisplayZoomable = 0x02 , LPVDisplayUseContextMenu = 0x04 , LPVDisplayInteractRegion = 0x08 , LPVDisplayShowPixelUnderMouse = 0x10 , LPVDisplayInteractObject = 0x20 , LPVDisplayDefault , LPVDisplayAll = 0xff }
	This enumeration is used to control the behavior of the display control. More...

enum	LPVKeyboardModifiers { LPVKeyboardModifiersNone = 0x00 , LPVKeyboardModifiersCtrl = 0x01 , LPVKeyboardModifiersShift = 0x02 , LPVKeyboardModifiersAlt = 0x04 }
	This enumeration is used to describe which keyboard modifier keys were pressed. The corresponding value will be set when the key is pressed at the time input was being generated. More...

enum	LPVMouseButton { LPVMouseButtonNone = 0x00 , LPVMouseButtonLeft = 0x01 , LPVMouseButtonRight = 0x02 , LPVMouseButtonMid = 0x04 , LPVMouseButtonX1 = 0x08 , LPVMouseButtonX2 = 0x10 }
	This enumeration is used to describe the mouse buttons. More...

enum	LPVScrollBarPolicy { LPVScrollBarAsNeeded = 0 , LPVScrollBarAlwaysOff = 1 , LPVScrollBarAlwaysOn = 2 }
	This enumeration is used to describes the various modes of scroll bars. More...

enum	LPVZoomAnchor { LPVAnchorViewTopLeft = 0 , LPVAnchorViewCenter = 1 , LPVAnchorUnderMouse = 2 }
	This enumeration is used to describe the possible anchors that the display control can use when the user resizes the view or when the view is transformed. More...

Detailed Description

LPV Display Library, provide ui controls for display images, regions, geometric primitives and other algorithms' results.

Example Code

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

Enumeration Type Documentation

◆ LPVAlignment

enum LPVAlignment

This enumeration is used to describe alignment.

Enumerator
LPVAlignDefault	Use default setting.
LPVAlignLeft	Aligns with the left edge.
LPVAlignRight	Aligns with the right edge.
LPVAlignHCenter	Centers horizontally in the available space.
LPVAlignTop	Aligns with the top edge.
LPVAlignBottom	Aligns with the bottom edge.
LPVAlignVCenter	Centers vertically in the available space.
LPVAlignCenter	Centers in both dimensions.

◆ LPVDisplayEventIDs

enum LPVDisplayEventIDs

This enumeration is for the event IDs from the ILDisplayEvents interface.

Enumerator
LPVDisplayEventRefreshed	ILDisplayEvents::Refreshed()
LPVDisplayEventMouseDown	ILDisplayEvents::MouseDown()
LPVDisplayEventMouseUp	ILDisplayEvents::MouseUp()
LPVDisplayEventMouseDoubleClick	ILDisplayEvents::MouseDoubleClick()
LPVDisplayEventMouseMove	ILDisplayEvents::MouseMove()
LPVDisplayEventMouseWheel	ILDisplayEvents::MouseWheel()
LPVDisplayEventKeyDown	ILDisplayEvents::KeyDown()
LPVDisplayEventKeyUp	ILDisplayEvents::KeyUp()
LPVDisplayEventRegionDragging	ILDisplayEvents::RegionDragging()
LPVDisplayEventRegionDragFinished	ILDisplayEvents::RegionDragFinished()
LPVDisplayEventRegionRemoving	ILDisplayEvents::RegionRemoving()
LPVDisplayEventRegionRemovingAll	ILDisplayEvents::RegionRemovingAll()
LPVDisplayEventObjectDragging	ILDisplayEvents::ObjectDragging()
LPVDisplayEventObjectDragFinished	ILDisplayEvents::ObjectDragFinished()
LPVDisplayEventObjectRemoving	ILDisplayEvents::ObjectRemoving()
LPVDisplayEventObjectRemovingAll	ILDisplayEvents::ObjectRemovingAll()

◆ LPVDisplayFlags

enum LPVDisplayFlags

This enumeration is used to control the behavior of the display control.

Enumerator
LPVDisplayMovable	The scene is movable by mouse click then drag
LPVDisplayZoomable	The scene is zoom-able by mouse wheel
LPVDisplayUseContextMenu	Use context menu by mouse right click
LPVDisplayInteractRegion	The regions in the scene is interactive
LPVDisplayShowPixelUnderMouse	Show current position and pixel value under cursor
LPVDisplayInteractObject	The interactable object in the scene is interactive
LPVDisplayDefault	Default display flags, which display a movable, zoom-able and interactive scene with context menu
LPVDisplayAll	Enable all display flags

◆ LPVKeyboardModifiers

enum LPVKeyboardModifiers

This enumeration is used to describe which keyboard modifier keys were pressed. The corresponding value will be set when the key is pressed at the time input was being generated.

Enumerator
LPVKeyboardModifiersNone	No modifier key is pressed.
LPVKeyboardModifiersCtrl	A CTRL key on the keyboard is pressed.
LPVKeyboardModifiersShift	A SHIFT key on the keyboard is pressed.
LPVKeyboardModifiersAlt	An ALT key on the keyboard is pressed.

◆ LPVMouseButton

enum LPVMouseButton

This enumeration is used to describe the mouse buttons.

Enumerator
LPVMouseButtonNone	Not refer to any button
LPVMouseButtonLeft	The left button.
LPVMouseButtonRight	The right button
LPVMouseButtonMid	The middle button
LPVMouseButtonX1	The X1 button, usually it's the 'Back' button
LPVMouseButtonX2	The X2 button, usually it's the 'Forward' button

◆ LPVScrollBarPolicy

enum LPVScrollBarPolicy

This enumeration is used to describes the various modes of scroll bars.

Enumerator
LPVScrollBarAsNeeded	Shows a scroll bar when the content is too large to fit and not otherwise.
LPVScrollBarAlwaysOff	Never shows a scroll bar. This is the default.
LPVScrollBarAlwaysOn	Always shows a scroll bar.

◆ LPVZoomAnchor

enum LPVZoomAnchor

This enumeration is used to describe the possible anchors that the display control can use when the user resizes the view or when the view is transformed.

Enumerator
LPVAnchorViewTopLeft	The left-top corner of the view is used as the anchor.
LPVAnchorViewCenter	The center of the view is used as the anchor.
LPVAnchorUnderMouse	The point under the mouse is used as the anchor. This is the default.

Data Structures

Enumerations