BenR: XML import

2019-03-07T11:49:18Z

XML import

New page

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color: gray;" | Version
| 1.6 (Release)
|-
| width="20%" style="color: gray;" | Category
| Indicators
|}

==[[File:Component Icon b0f3982e_7ca6_4504_afe5_1b76fa09fad1.png|Image]] GLCD (SCADA) component==
SImulation runtime only graphical display component designed for SCADA operations.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>PrintNumber</tt>===
This macro prints a decimal number to the Graphical LCD.

'''Parameters'''

:[[Variable Types|INT]] ''Number''
::Byte or Integer number to send to the display.

:[[Variable Types|UINT]] ''X''
::X pixel coordinate to set the output string position.

:[[Variable Types|UINT]] ''Y''
::Y pixel coordinate to set the output string position.

:[[Variable Types|BYTE]] ''Font''
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes

:[[Variable Types|BYTE]] ''Transparent''
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.

'''Return value'''

:''This call does not return a value''

===<tt>DrawLine</tt>===
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

:[[Variable Types|UINT]] ''X2''

:[[Variable Types|UINT]] ''Y2''

'''Return value'''

:''This call does not return a value''

===<tt>Plot</tt>===
Sets a pixel with the current foreground colour at pixel location X, Y.

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

'''Return value'''

:''This call does not return a value''

===<tt>DrawEllipse</tt>===
Draws an ellipse object on the display with the center of the ellipse at the location X,Y

'''Parameters'''

:[[Variable Types|UINT]] ''X''
::X Coordinate for the center of the circle

:[[Variable Types|UINT]] ''Y''
::Y coordinate for the center of the circle

:[[Variable Types|UINT]] ''XRadius''
::Radius of the circle on the X axis specified in pixels

:[[Variable Types|UINT]] ''YRadius''
::Radius of the circle on the Y axis specified in pixels

:[[Variable Types|BYTE]] ''Transparent''
::0=Fill inside circle using background colour / 1=Draw outer circle only

:[[Variable Types|BYTE]] ''Solid''
::0=Use Transparent Setting / 1=Fill with foreground colour

'''Return value'''

:''This call does not return a value''

===<tt>FastPlot</tt>===
Sets a pixel with the current foreground colour at current pixel location.

Not compatible with orientations other than 0.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>SetDisplayOrientation</tt>===
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.

'''Parameters'''

:[[Variable Types|BYTE]] ''Orientation''
::0=Default, 1=90 Degrees CW, 2=180 Degrees CW, 3=270 Degrees CW

'''Return value'''

:''This call does not return a value''

===<tt>BPlot</tt>===
Sets a pixel with the current background colour at pixel location X, Y.

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

'''Return value'''

:''This call does not return a value''

===<tt>Window</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

:[[Variable Types|UINT]] ''X2''

:[[Variable Types|UINT]] ''Y2''

'''Return value'''

:''This call does not return a value''

===<tt>Print</tt>===
This macro prints a string of characters to the Graphical LCD.

'''Parameters'''

:[[Variable Types|<- STRING]] ''Str''
::String of characters to send to the display.
::''This parameter may be returned back to the caller''

:[[Variable Types|UINT]] ''X1''
::X pixel coordinate to set the output string position.

:[[Variable Types|UINT]] ''Y1''
::Y pixel coordinate to set the output string position.

:[[Variable Types|BYTE]] ''Font''
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes

:[[Variable Types|BYTE]] ''Transparent''
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.

'''Return value'''

:''This call does not return a value''

===<tt>ClearDisplay</tt>===
This macro clears the display of any previous output by overwriting the entire display with the background colour.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>SetBackgroundColour</tt>===
Specifies the colour of the background by creating a mixture of red, green and blue.

'''Parameters'''

:[[Variable Types|BYTE]] ''Red''
::Range: 0-255

:[[Variable Types|BYTE]] ''Green''
::Range: 0-255

:[[Variable Types|BYTE]] ''Blue''
::Range: 0-255

'''Return value'''

:''This call does not return a value''

===<tt>DrawCircle</tt>===
Draws a circle object on the display with the center of the circle at the location X,Y

'''Parameters'''

:[[Variable Types|UINT]] ''X''
::X Coordinate for the center of the circle

:[[Variable Types|UINT]] ''Y''
::Y coordinate for the center of the circle

:[[Variable Types|UINT]] ''Radius''
::Radius of the circle specified in pixels

:[[Variable Types|BYTE]] ''Transparent''
::0=Fill inside circle using background colour / 1=Draw outer circle only

:[[Variable Types|BYTE]] ''Solid''
::0=Use Transparent Setting / 1=Fill with foreground colour

'''Return value'''

:''This call does not return a value''

===<tt>SetForegroundColour</tt>===
Specifies the colour of the foreground by creating a mixture of red, green and blue.

'''Parameters'''

:[[Variable Types|BYTE]] ''Red''
::Range: 0-255

:[[Variable Types|BYTE]] ''Green''
::Range: 0-255

:[[Variable Types|BYTE]] ''Blue''
::Range: 0-255

'''Return value'''

:''This call does not return a value''

===<tt>DrawRectangle</tt>===
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

:[[Variable Types|UINT]] ''X2''

:[[Variable Types|UINT]] ''Y2''

:[[Variable Types|BYTE]] ''Transparent''
::Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.

:[[Variable Types|BYTE]] ''Solid''
::Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.

'''Return value'''

:''This call does not return a value''

===<tt>Initialise</tt>===
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

==Simulation macro reference==

===<tt>DrawLineFast</tt>===
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.

'''Parameters'''

:[[Variable Types|UINT]] ''X1''

:[[Variable Types|UINT]] ''Y1''

:[[Variable Types|UINT]] ''X2''

:[[Variable Types|UINT]] ''Y2''

'''Return value'''

:''This call does not return a value''

===<tt>DrawStart</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

==Property reference==
Pixel Height

This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_height''.

Heigt of gLCD canvas measured in pixels.

Pixel Width

This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_width''.

Width of gLCD canvas measured in pixels.

Monochrome

This property is of type ''True or false'' and can be referenced with the variable name ''monochrome''.

Specifies if the display is capable of colour or monochrome only.

Foreground Color

This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''.

Specifies the initial foreground color.

Background Color

This property is of type ''Color picker'' and can be referenced with the variable name ''background_colour''.

Specifies the initial background color.

Colour Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''colour_bit_depth''.

Total color bit depth for the display.

Red Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''red_bit_depth''.

Specifies the red bit depth for the display.

Green Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''green_bit_depth''.

Specifies the green bit depth for the display.

Blue Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''blue_bit_depth''.

Specifies the blue bit depth for the display.

Display Method

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DisplayMethod''.

Chooses which method to use when drawing to the gLCD component

The bitmap is the more common mode but may run slowly on some machines.

The point cloud should run faster but may use more memory.

Component: GLCD (SCADA) (Indicators) - Revision history

BenR: XML import