ILSystem Interface Reference

This interface provide miscellaneous functions to change LPV system configurations globally. More...

Inheritance diagram for ILSystem:

Public Member Functions
BOOL	CheckLib (LString libName)
BOOL	CheckLicense ()
BOOL	CheckVersion (long majorVersion, long minorVersion, long microVersion)
void	DrawCircle (double x, double y, double r, BOOL bFill, HDC hdc, double zoomX, double zoomY, double panX, double panY)
void	DrawLine (double x1, double y1, double x2, double y2, HDC hdc, double zoomX, double zoomY, double panX, double panY)
void	DrawPoint (double x, double y, LPVPointShape shape, HDC hdc, double zoomX, double zoomY, double panX, double panY)
void	DrawPolygon (LArray< double > xs, LArray< double > ys, BOOL bClosed, BOOL bFill, HDC hdc, double zoomX, double zoomY, double panX, double panY)
void	DrawRect (double x, double y, double w, double h, double a, BOOL bFill, HDC hdc, double zoomX, double zoomY, double panX, double panY)
void	DrawString (LString text, int tlx, int tly, HDC hdc, double zoomX, double zoomY, double panX, double panY)
COLORREF	GetColorRef (int red, int green, int blue)
void	GetRGBFromColorRef (COLORREF colorRef, int *red, int *green, int *blue)
LPVErrorCode	RefreshDefaults (LString filename)
void	SetDefault (LString settingName, LString val)
void	SetDrawPointSize (int size)
void	SetRegionHandleSize (int size)

Detailed Description

This interface provide miscellaneous functions to change LPV system configurations globally.

To use this interface, you should create a LSystem object.

Example Code

C++

ILSystemPtr sys = LSystem::Create();
sys->SetDrawPointSize(20);

C#

LSystem sys = new LSystem();
sys.SetDrawPointSize(20);

COM

ILSystemPtr sys = LSystem::Create();
// or, ILSystemPtr sys(__uuidof(LSystem)), for absence of built-in Create functions (before 2.2.0)
sys->SetDrawPointSize(20);

Member Function Documentation

CheckLib()

BOOL CheckLib

(

LString

libName

)

Check whether the library is licensed then you can use the algorithms in that library.
You may call it as:

C++

bool checkResult = sys->CheckLib(L"lpvCore");
if (!checkResult) return; // return if check license failed for lpvCore library

C#

bool checkResult = sys.CheckLib("lpvCore");
if (!checkResult) return; // return if check license failed for lpvCore library

COM

VARIANT_BOOL checkResult = sys->CheckLib(L"lpvCore");
if (!checkResult) return; // return if check license failed for lpvCore library

Parameters

[in]

libName

Pass in the name of the library. The name is case-insensitive, and the "lpv" prefix can be omitted, say "lpvCore.dll", "lpvCore", "core", "CORE".

Return values

val	True for valid license, otherwise, return False.

CheckLicense()

BOOL CheckLicense

(

)

Check any valid license is available. Note: we won't exam the feature IDs here, you should call CheckLib() instead.
You may call it as:

C++

bool checkResult = sys->CheckLicense();
if (!checkResult) return; // return if check license failed

C#

bool checkResult = sys.CheckLicense();
if (!checkResult) return; // return if check license failed

COM

VARIANT_BOOL checkResult = sys->CheckLicense();
if (!checkResult) return; // return if check license failed

Return values

val	True for valid license, otherwise, return False.

CheckVersion()

BOOL CheckVersion	(	long	majorVersion,
		long	minorVersion,
		long	microVersion
	)

Check the compatibility of the running and the compiled version of the LPW toolkit. You may call it as:

C++

bool checkResult1 = sys->CheckVersion(1, 13, 1); // the required version is 1.13.1
if (!checkResult1) return; // return if check version failed
bool checkResult2 = sys->CheckVersion(LPVMajorVersion, LPVMinorVersion, LPVMicroVersion); // use the built-in constants
if (!checkResult2) return; // return if check version failed

C#

bool checkResult1 = sys.CheckVersion(1, 13, 1); // the required version is 1.13.1
if (!checkResult1) return; // return if check version failed
bool checkResult2 = sys.CheckVersion(LPVMajorVersion, LPVMinorVersion, LPVMicroVersion); // use the built-in constants
if (!checkResult2) return; // return if check version failed

COM

VARIANT_BOOL checkResult1 = sys->CheckVersion(1, 13, 1); // the required version is 1.13.1
if (!checkResult1) return; // return if check version failed
VARIANT_BOOL checkResult2 = sys->CheckVersion(LPVMajorVersion, LPVMinorVersion, LPVMicroVersion); // use the built-in constants
if (!checkResult2) return; // return if check version failed

For failed check, you may re-install the correct version. It's recommended to use the same version for compiling and running.

Parameters

[in]	majorVersion	The major version in compiling.
[in]	minorVersion	The minor version in compiling.
[in]	microVersion	The micro version in compiling.

Return values

val	True for valid compatibility, otherwise, return False.

DrawCircle()

void DrawCircle	(	double	x,
		double	y,
		double	r,
		BOOL	bFill,
		HDC	hdc,
		double	zoomX,
		double	zoomY,
		double	panX,
		double	panY
	)

Draw a circle on HDC. Current pen and brush of the system object is used.

Parameters

[in]	x	The x-coordinate of the input circle's center point.
[in]	y	The y-coordinate of the input circle's center point.
[in]	r	The radius of the input circle.
[in]	bFill	Whether to fill the circle using current brush.

See also

Use Draw Functions

Remarks

This function is currently not available on Linux / MacOS platform.

DrawLine()

void DrawLine	(	double	x1,
		double	y1,
		double	x2,
		double	y2,
		HDC	hdc,
		double	zoomX,
		double	zoomY,
		double	panX,
		double	panY
	)

Draw a line on HDC. Current pen of the system object is used.

Parameters

[in]	x1	The x-coordinate of the input line's start point.
[in]	y1	The y-coordinate of the input line's start point.
[in]	x2	The x-coordinate of the input line's end point.
[in]	y2	The y-coordinate of the input line's end point.

See also

Use Draw Functions

Remarks

This function is currently not available on Linux / MacOS platform.

DrawPoint()

void DrawPoint	(	double	x,
		double	y,
		LPVPointShape	shape,
		HDC	hdc,
		double	zoomX,
		double	zoomY,
		double	panX,
		double	panY
	)

Draw a point on HDC. Current pen of the system object is used.

Parameters

[in]	x	The x-coordinate of the input point.
[in]	y	The y-coordinate of the input point.
[in]	shape	The drawn shape of the point.

See also

Use Draw Functions

Remarks

This function is currently not available on Linux / MacOS platform.

DrawPolygon()

void DrawPolygon	(	LArray< double >	xs,
		LArray< double >	ys,
		BOOL	bClosed,
		BOOL	bFill,
		HDC	hdc,
		double	zoomX,
		double	zoomY,
		double	panX,
		double	panY
	)

Draw a polygon on HDC.

Parameters

[in]	xs	The x-coordinates of the input polygon vertexes.
[in]	ys	The y-coordinates of the input polygon vertexes.
[in]	bClosed	Whether this is a closed polygon.
[in]	bFill	Whether to fill the circle using current brush.

See also

Use Draw Functions

Remarks

This function is currently not available on Linux / MacOS platform.

DrawRect()

void DrawRect	(	double	x,
		double	y,
		double	w,
		double	h,
		double	a,
		BOOL	bFill,
		HDC	hdc,
		double	zoomX,
		double	zoomY,
		double	panX,
		double	panY
	)

Draw a rectangle on HDC.

Parameters

[in]	x	The x-coordinate of the input rectangle's center point.
[in]	y	The y-coordinate of the input rectangle's center point.
[in]	w	The width of the input rectangle.
[in]	h	The height of the input rectangle.
[in]	a	The angle of the input rectangle.
[in]	bFill	Whether to fill the circle using current brush.

See also

Use Draw Functions

Remarks

This function is currently not available on Linux / MacOS platform.

DrawString()

void DrawString	(	LString	text,
		int	tlx,
		int	tly,
		HDC	hdc,
		double	zoomX,
		double	zoomY,
		double	panX,
		double	panY
	)

Draw a text string on HDC.

Parameters

[in]	text	The input text string.
[in]	tlx	The x-coordinate of the top-left corner of the text region.
[in]	tly	The y-coordinate of the top-left corner of the text region.

See also

Use Draw Functions

Remarks

This function is currently not available on Linux / MacOS platform.

GetColorRef()

COLORREF GetColorRef	(	int	red,
		int	green,
		int	blue
	)

Convert RGB(red, green, blue) value to a 32-bit value representing the same color, in RRGGBB format. Alternatively, you could use ColorTranslator.ToWin32() for C# or RGB() macro in GDI for C++.

See also

GetRGBFromColorRef()

GetRGBFromColorRef()

void GetRGBFromColorRef	(	COLORREF	colorRef,
		int *	red,
		int *	green,
		int *	blue
	)

Get RGB(red, green, blue) values from a 32-bit value representing the same color. The 32-bit value is in RRGGBB format. Alternatively, you could use ColorTranslator.FromWin32() for C# or GetRValue()/GetGValue()/GetBValue() macro in GDI for C++.

Parameters

[in]	colorRef	The input color value
[out]	red	Output the red value
[out]	green	Output the green value
[out]	blue	Output the blue value

See also

GetColorRef()

RefreshDefaults()

LPVErrorCode RefreshDefaults

(

LString

filename

)

Refresh system default settings from the given .default file, which is a yml file as following:

%YAML:1.0
defaultLogLevel: 0
silent: true

Parameters

[in]

filename

Full path of the file, it could be absolute or relative path with file name and extension.

Return values

error

Return error code if anything is wrong.

Since

2.1.0

SetDefault()

void SetDefault	(	LString	settingName,
		LString	val
	)

Change system default setting. The supported settings are listed in the following table:

Setting	Usage	Default Value
pointSize	Radius of point drawn on canvas (pixel)	5
roiHandleSize	Region handles' size on canvas (pixel)	7
paragraphSpace	Paragraph space for text drawn on canvas (pixel)	6
doublePrecision	Double precision used in drawing a chart on canvas (pixel)	3
defaultLogLevel	Log level (0 Trace, 10000 Debug, 20000 Info, 30000 Warn, 40000 Error, 50000 Fatal, 60000 Off)	30000 (Warn)
noLicenseRetryMsgBox	Whether to stop showing up the licensing failure dialog for user to retry	false (pop up)
silent	Whether to stop showing up any message box	false (pop up)
genCrashDump	Whether to generate the core dump file when crash	false (no)
useFullDump	Whether to generate the full core dump file	false (no)

You may call it as:

C++

sys->SetDefault(L"pointSize", L"16");
sys->SetDefault(L"noLicenseRetryMsgBox", L"true");

C#

sys.SetDefault("pointSize", "16");
sys.SetDefault("noLicenseRetryMsgBox", "true");

COM

sys->SetDefault(L"pointSize", L"16");
sys->SetDefault(L"noLicenseRetryMsgBox", L"true");

Parameters

[in]	settingName	The default setting name.
[in]	val	The new setting value.

Since

2.1.0

SetDrawPointSize()

void SetDrawPointSize

(

int

size

)

Change the radius of point drawn on canvas globally, by default it's 5 pixels.

SetRegionHandleSize()

void SetRegionHandleSize

(

int

size

)

Change the size of region handles(and its interactable area) drawn on canvas globally, by default it's 7 pixels.

Parameters

[in]

size

The required handle size in pixel.