Distance Segment Segment Edit ControlCognex VisionPro

This topic contains the following sections.

The Distance Segment Segment edit control provides a graphical user interface to the DistanceSegmentSegment method, which returns the shortest distance between the two line segments SegmentA and SegmentB. The edit control allows you to configure both line segments, dictate which graphics appear as the tool executes, and view tool results. The following figure shows the Distance Segment Segment edit control:

Cognex Dimensioning Distance Segment Segment Control Distance Segment Segment Whole Control

The edit control offers the following features:

  • A row of control buttons at the top left
  • A set of function tabs to configure the two line segments, choose what graphics the tool will use, and view results
  • An image display window for displaying tool images and graphics

You can experiment with the edit control by using QuickBuild to create a CogDistanceSegmentSegment tool. A new CogDistanceSegmentSegment tool appears as shown in the following figure:

Cognex Dimensioning Distance Segment Segment Control Distance Segment Segment Terminals

The Segment and Segment parameters can either be specified directly from within the edit control or accepted as the result of other shape-generating vision tools. For example, the following figure shows how a Distance Segment Segment tool accepts the line segments generated as output from other tools:

Cognex Dimensioning Distance Segment Segment Control Distance Segment Segment Accept Shapes

To include the edit control in your custom vision application, you must first add it to your Visual Studio.NET development environment. See Using Edit Controls in Your Custom Vision Applications for more information.

Control Buttons

Cognex Dimensioning Distance Segment Segment Control MTWButton Bar

The following table describes the function of each button:

Table 1. Control buttons
ButtonDescriptionFunction
Run Button
RunMeasures the distance between the two line segments
Electric Button
Electric modeToggles electric mode, where the Distance Segment Segment tool executes automatically when particular configuration parameters change. In electric mode, a lightning bolt appears next to every electric property

Local Display Button

Local image display

Opens or closes the local image display window. A Distance Segment Segment tool supports the following image buffers:

  • The Current.InputImage buffer contains the current image and the two input line segments
  • The LastRun.InputImage buffer contains the results of the tool after it measures the distance between the two line segments
Floating Display Button
Floating image displayOpens one or more floating image windows, which support the same image buffers as the local image display window
Open Button
OpenOpens a VisionPro persistence (.vpp) file that contains a set of saved properties for this vision tool object type. VisionPro reports an error if you try to open a .vpp file for another object type.
Save Button
SaveSaves the current properties of the vision tool to a VisionPro persistence (.vpp) file. The edit control allows you to choose between saving the vision tool with or without its image buffers and tool results.
Save As Button
Save AsSaves the current properties of the vision tool to a new VisionPro persistence (.vpp) file
Reset Button
ResetResets the vision tool to its default state.
Tool Tips Button
Show ToolTipsEnables or disables the display of tooltips for individual items in the edit control
Help Button
HelpOpens this VisionPro online help file
Settings Tab

Use the Settings tab to define the input line segments, or use the tab to confirm that the existing shapes correspond to the correct input parameters generated by other tools. The following figure shows the Settings tab:

Cognex Dimensioning Distance Segment Segment Control Distance Segment Segment Settings Tab

The Settings tab offers identical features for defining both SegmentA and SegmentB parameters:

Table 2. Settings tab
FeatureDescription
SelectedSpaceNameNames the coordinate space for the segment shapes
Select ModeDetermines whether the line segment is determined by the 2 Points option (two [x, y] coordinates) or by the Point/Length option (a starting [x, y] coordinate followed by a line length and a measure of rotation).
StartX and StartYNames the starting (x, y) coordinate of the line segment
EndX and EndYNames the ending (x, y) coordinate of the line segment when using the 2 Points option.
Length and RotationControls the length and angle of rotation of the line segment when using the Point/Length option.
Centers the line segment within the Current.InputImage
Graphics Tab

Use the Graphics tab to control which graphics the Distance Segment Segment tool generates and displays. The following figure shows the default Graphics tab:

Cognex Dimensioning Distance Segment Segment Control Distance Segment Segment Graphics Tab

The Graphics tab offers the following features:

Table 3. Graphics tab
FeatureDescription
Show Input ImageDetermines whether or not the input image is recorded as part of the diagnostic record, and whether the image is copied to the record or saved in the record as a reference
Show SegmentAShow SegmentA in the LastRun.InputImage buffer
Show SegmentBShow SegmentB in the LastRun.InputImage buffer
Show ArrowShow the line segment representing the shortest distance between SegmentA and SegmentB
Results Tab

Use the Results tab to view the relationship between the point SegmentA and SegmentB as determined by the Distance Segment Segment tool. The following figure shows the Results tab:

Cognex Dimensioning Distance Segment Segment Control Distance Segment Segment Results Tab

The Results tab offers the following features:

Table 4. Results tab
FeatureDescription
DistanceThe shortest distance between the point SegmentA and SegmentB
SegmentAX and SegmentAYThe (x, y) coordinate on SegmentA that is closest to SegmentB
SegmentBX and SegmentBYThe (x, y) coordinate on SegmentB that is closest to SegmentA