GUIBitmap

(Engine-Level Function)

Description:	Draws an image of any of the following formats in a window. Can return a Boolean TRUE when selected by a mouse button or when the <ENTER> key is pressed after focus has been acquired. Available formats include, BMP, EMF, WMF, APM, CUT, PCX, JPG, PNG, and TIF
Returns:	GUI Object Return Codes
Usage:	Steady State only.
Function Groups:	Graphics
Format:	GUIBitmap(LeftReference, BottomReference, RightReference, TopReference, ScaleLeft, ScaleBottom, ScaleRight, ScaleTop, ScaleWhole, Trajectory, Rotation, Visibility, Reserved, Button, FocusID, FocusTrigger, Image)
Parameters:

LeftReference

A constant number that gives the left side reference coordinate. It must be a constant. A variable or expression is not valid here.

BottomReference

A constant number that gives the bottom side reference coordinate. It must be a constant. A variable or expression is not valid here. The top and bottom references are measured down from the top of the screen.

RightReference

A constant number that gives the right side reference coordinate. It must be a constant. A variable or expression is not valid here.

TopReference

A constant number that gives the top side reference coordinate. It must be a constant. A variable or expression is not valid here.

ScaleLeft

Required. Either a numeric expression, or any expression that returns a Normalize value. This parameter scales this side from its reference position with respect to the opposite side. If it is a numeric expression, a value of 1 will place the side at its reference position. A value of 0 will place it at the opposite side reference position. Similarly, a Normalize value will scale the side between the high and low limits. If the value is at the high level, the side will be at its reference position. If the value is at the low level, the side will be at the opposite side reference position.

ScaleBottom

ScaleRight

ScaleTop

ScaleWhole

Required. Either a numeric expression, or any expression that returns a Normalize value. This parameter scales the horizontal and vertical dimensions by the specified factor before the left, bottom, right and top coordinates are scaled.

Trajectory

Required. Either a Trajectory function, a variable containing a Trajectory value, or a numeric expression. If this is a Trajectory value or function, the appropriate translation is applied to the image after the rotation is applied. If it is a valid numeric expression, the image isn't translated, but is displayed. Any other value is Invalid.

Rotation

Required. Either a Rotate function, a variable containing a Rotate value, or a numeric expression. If this is a Rotate value or function, the appropriate rotation is applied to the image before the trajectory is applied. If it is a valid numeric expression, the image is rotated clockwise the number of degrees specified. Any other value is Invalid.

Visibility

Required. Any logical expression. If true, the image is drawn normally. If false, the image is not drawn.

Reserved

Reserved for future use, set to 0.

Button

Required. Any numeric expression giving the button combination that activates this graphic.

Value	Locator Buttons
0	No button combination will activate this graphic
1	Right button
2	Middle button
3	Right and middle buttons
4	Left button
5	Left and right buttons
6	Left and middle buttons
7	All three buttons

If the above values are multiplied by 8, the meaning for multiple buttons pressed becomes "OR" rather than "AND." For example, to accept any button on a 2 or 3 button mouse, use 56 (i.e. 8 * 7). To accept the left mouse button regardless of whether the right button is pressed, use 32 (i.e. 8 * 4).

If a 64 is added to this parameter, the function will become true when the mouse buttons are released rather than when they are pressed.

FocusID

Required. Any numeric expression from 0 to 32767 giving the focus number of this graphic. If FocusID is 0, this graphic cannot receive the input focus. This parameter's value may be used in a NextFocusID statement to force this graphic to get the focus.

FocusTrigger

Required. Any Boolean expression. If FocusTrigger changes from a valid false to a valid true, this graphic will acquire focus.

Image

Required. Either an image expression or a text expression. An image value will display that image. A text value identifies the name of an image file.

If an expression is used, this graphic can function like an Image Change, switching images in response to changing application states.

Comments:

32-bit color is used for all VTScada image drawing.
The performance of image drawing is heavily influenced by the presence or absence of graphics acceleration hardware. An anti-aliased image draws much more slowly than one without this option set, and becomes much less compatible with masking operations such as zColorChange.

This function is a layered graphics statement. See "Use Scaling to Position GUI Objects" for information about positioning a layered graphic.
The Left and Right references are interchangeable. Whichever is smaller is taken as the left and the larger of the two values will be used as the right. The same is true of the top and bottom references. Note that the 1^st 42 pixels of a VTScada application will be obscured by the title bar, if present.

EMF/WMF images will not display in the Anywhere Client.

Example:

[
  { variable declaration & assignment }
  Left = 10; { scaling parameters }
  Right = 110;
  Top = 50;
  Bottom = 150;
]
Main [
  GUIBitmap(0, 1, 1, 0 { Bounding box of image },
            1 - Left, Bottom, Right, 1 - Top { Scaling },
            0, 0 { No trajectory or rotation },
            1 { Bitmap is visible },
            0 { Reserved },
            0 { Left mouse button activates },
            0 { Focus ID number },
            FALSE { Focus trigger },
            "..\Bitmaps\Smiley face icon.bmp" { Bitmap file name });

...

This shows an image in the upper left corner of the window. Position and size are set using scaling parameters.

The first four parameters must be constants. See GUITransform for an example of how to compute the position dynamically.

Related Functions: