ImageParmSet
(VTScada-Layer function. Must be called with a leading backslash.)
| Description: | Returns a structure of image attributes that can be passed to an image-based widget. |
| Returns: | A structure of image parameters suitable for use by a GUITransform |
Usage: ![]() |
Script or steady state. |
| Function Groups: | Graphics |
| Related to: | | | | | | | | GUITransform |
Format: ![]() |
\ImageParmSet(Filename[, ColorMultiplier, Mirror, AntiAlias, RotateAngle, Opacity, Lightness, Contrast, Hue, Saturation, ColorizeIntensity, ColorizeHue]) |
| Parameters: |
| Filename |
| Required. The relative path and file name of the image |
| ColorMultiplier |
| Optional color value in the form aRGB |
| Mirror |
| Optional Boolean. A logical value that can be set to 1 to reflect the image about the vertical axis. The default is no reflection (0). |
| AntiAlias |
|
Optional numeric. This is a bit-wise parameter where Bit 0 controls whether anti-aliasing will be done when the image is stretched. Defaults to 1 (TRUE) if missing or invalid. By default, feathering will be applied to an anti-aliased image when it is stretched. Set bit 1 to 1 (TRUE) to suppress feathering. |
| RotateAngle |
| Optional floating point value, specifying the clockwise rotation in degrees to be applied when the image is drawn. |
| Opacity |
| Optional numeric expression for a multiplier to the transparency (alpha value) of every color in the image. Range 0 (transparent) to 1 (opaque). Defaults to 1 if missing or invalid. |
| Lightness |
| Optional numeric expression that is a multiplier to the brightness of the image. Range 0+. Defaults to 1 if missing or invalid. |
| Contrast |
| Optional numeric expression to enhance the differences between the colors in the image. Range 0+. Defaults to 1 if missing or invalid. |
| Hue |
| Optional numeric expression for the hue rotation to apply to all of the colors in the image. Range -180 to 180. The default is no hue rotation, (0). |
| Saturation |
| Optional numeric expression that is a multiplier to the intensity of each primary color component of every color in the image. Range: 0+. Defaults to 1 if missing or invalid. |
| ColorizeIntensity |
| Optional numeric expression for the intensity of the added color. Zero means that no color is added. Range 0-255. Defaults to 0 if missing or invalid. |
| ColorizeHue |
| Optional numeric expression for the hue value of a color to be mixed with every color in the image. Range -180 to 180. Defaults to 0 if missing or invalid. |
| Comments: |
... |
Example:
GUITransform(207, 195, 307, 95,
1, 1, 1, 1, 1 { Scaling },
0, 0 { Movement },
1, 0 { Visibility, Reserved },
0, 0, 0 { Selectability },
Scope(\Code, "MeterParts", TRUE)\DrawScale(
\ImageParmSet("Bitmaps\Meter Parts\Tick Marks\Large_Thin.png" { Filename },
"<FFFFFFFF>" { ColorMultiplier },
1 { ColorMultiplier },
Invalid { Mirror },
0 { AntiAlias },
1 { RotateAngle },
1 { Opacity },
1 { Lightness },
0 { Contrast },
1 { Hue },
0 { ColorizeIntensity },
0 { ColorizeHue }),
\ImageParmSet("Bitmaps\Meter Parts\Tick Marks\Small_Thin.png",
"<FFFFFFFF>", 0, Invalid, 0,
1, 1, 1, 0, 1, 0, 0), 7, 5, 1,
0, 0, 0, 225, 135, 0, 1, 1, 1,
1, 0, 0, "<FFFFFFFF>", 0));
