Custom Overlay Controls

NI Vision Builder

Identify Parts
Custom Overlay

Custom Overlay Controls

Main Tab

The following controls are available on the Main tab.

Control Name Description
Step Name Name to give the step.
Clear Previous Overlay Removes any overlays created by previous steps in the inspection when the step executes.

Custom Overlay Tab

The following controls are available on the Custom Overlay tab.

Control Name Description
Selects an overlay element in the image.
Overlays a crosshair identifying a point on the image.
Overlays a line on the image.
Overlays a rectangle on the image.
Overlays a rotated rectangle on the image.
Overlays an oval or circle on the image. Hold down the <Shift> key while dragging to draw a circle.
Overlays a boolean indicator on the image.
Overlays an image file on the image.
Overlays text on the image.
Overlay Elements Displays the individual components that make up the custom overlay.
Delete Removes the element currently selected in Overlay Elements.

Parameters

Note  The available parameters vary according to the type of overlay selected in Overlay Elements

Point

Control Name Description
Point Coordinates Specifies whether the position of the overlay is user-defined, the value of a variable, or the result of a previous measurement.
X X-coordinate of the point.
Y Y-coordinate of the point.
X Offset X offset to the position defined by the selected variable or previous measurement.
Y Offset Y offset to the position defined by the selected variable or previous measurement.
Color Color of the overlay.

Line

Control Name Description
Start Point Specifies whether the start point of the line is user-defined, the value of a variable, or the result of a previous measurement.
End Point Specifies whether the end point of the line is user-defined, the value of a variable, or the result of a previous measurement.
X X-coordinate of the point.
Y Y-coordinate of the point.
X Offset X offset to the position defined by the selected variable or previous measurement.
Y Offset Y offset to the position defined by the selected variable or previous measurement.
Color Color of the overlay.

Rectangle

Control Name Description
Top Left Point Specifies whether the top left point of the rectangle is user-defined, the value of a variable, or the result of a previous measurement.
Bottom Right Point Specifies whether the bottom right of the rectangle is user-defined, the value of a variable, or the result of a previous measurement.
X X-coordinate of the point.
Y Y-coordinate of the point.
X Offset X offset to the position defined by the selected variable or previous measurement.
Y Offset Y offset to the position defined by the selected variable or previous measurement.
Stroke Color of the rectangle border.
Fill Fill color of the rectangle.

Rotated Rectangle

Control Name Description
Center Point Specifies whether the center of the rectangle is user-defined, the value of a variable, or the result of a previous measurement.
X X-coordinate of the point.
Y Y-coordinate of the point.
X Offset X offset to the position defined by the selected variable or previous measurement.
Y Offset Y offset to the position defined by the selected variable or previous measurement.
Width The width of the rectangle.
Height The height of the rectangle.
Angle Rotation angle, in degrees, of the rectangle with the center of the rectangle as the point of rotation.
Stroke Color of the rectangle border.
Fill Fill color of the rectangle.

Oval

Control Name Description
Center Point Specifies whether the center of the oval is user-defined, the value of a variable, or the result of a previous measurement.
X X-coordinate of the point.
Y Y-coordinate of the point.
X Offset X offset to the position defined by the selected variable or previous measurement.
Y Offset Y offset to the position defined by the selected variable or previous measurement.
Width The width of the oval.
Height The height of the oval.
Stroke Color of the oval border.
Fill Fill color of the oval.

Boolean Indicator

Control Name Description
Top Left Point Specifies whether the top left point of the boolean indicator is user-defined, the value of a variable, or the result of a previous measurement.
X X-coordinate of the point.
Y Y-coordinate of the point.
X Offset X offset to the position defined by the selected variable or previous measurement.
Y Offset Y offset to the position defined by the selected variable or previous measurement.
Width The width of the boolean indicator.
Height The height of the boolean indicator.
Value Measurement value to use for the value of the boolean indicator.
True Text Text to display when the result is TRUE.
False Text Text to display when the result is FALSE.
Text Color of the text
Fill Fill color of the boolean indicator.

Image

Control Name Description
Top Left Point Specifies whether the top left point of the overlay image is user-defined, the value of a variable, or the result of a previous measurement.
X X-coordinate of the point.
Y Y-coordinate of the point.
X Offset X offset to the position defined by the selected variable or previous measurement.
Y Offset Y offset to the position defined by the selected variable or previous measurement.
Image File Path Complete file path to the image file to overlay.
Set Color to be Transparent Enable the checkbox to make areas of the image matching the color specified in Color appear transparent.
Color Color in the overlay image that you want to be transparent.

Text

Control Name Description
Insertion Point Specifies whether the bottom left point of the first character of the overlay text is user-defined, the value of a variable, or the result of a previous measurement.
X X-coordinate of the point.
Y Y-coordinate of the point.
X Offset X offset to the position defined by the selected variable or previous measurement.
Y Offset Y offset to the position defined by the selected variable or previous measurement.
Text Text to overlay
Launches the Select Inspection Data dialog box where you can specify a measurement result to display as an overlay.
Launches a dialog box containing options for configuring how the text appears in the overlay.
Text Color Color of the text.
Fill Color of the text background.

Layer Management Tab

The following controls are available on the Layer Management tab.

Control Name Description
Overlay Elements Lists the overlay elements that make up the custom overlay. The following information is available for each element:
  • Name—Name of the overlay element
  • Fill—Fill color of the overlay element
  • X—X-coordinate of the first point of the overlay element.
  • Y—Y-coordinate of the first point of the overlay element.
Up Moves the selected overlay element earlier in the drawing order.
Down Moves the selected overlay element later in the drawing order.
Delete Removes the currently selected element from the overlay.