Distance Point Segment Edit Control

Cognex VisionPro

This topic contains the following sections.

Control Buttons
Settings Tab
Graphics Tab
Results Tab

The Distance Point Segment edit control provides a graphical user interface to the DistancePointSegment method, which returns the shortest distance from the given point (X, Y) to Segment. The edit control allows you to define the point and the line segment, dictate which graphics appear as the tool executes, and view tool results. The following figure shows the Distance Point Segment edit control:

Cognex Dimensioning Distance Point Segment Control Distance Point 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 define the point and the line segment, 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 CogDistancePointSegment tool. A new CogDistancePointSegment tool appears as shown in the following figure:

Cognex Dimensioning Distance Point Segment Control Distance Point Segment Terminals

The point (X, Y) 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 Point Segment tool accepts the point and circle generated as output from other tools:

Cognex Dimensioning Distance Point Segment Control Distance Point 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 Point Segment Control MTWButton Bar

The following table describes the function of each button:

Table 1. Control buttons

Button	Description	Function
	Run	Measures the distance between the point and the line segment
	Electric mode	Toggles electric mode, where the Distance Point Segment tool executes automatically when particular configuration parameters change. In electric mode, a lightning bolt appears next to every electric property
	Local image display	Opens or closes the local image display window. A Distance Point Segment tool supports the following image buffers: The Current.InputImage buffer the current image and the input point and input line segment The LastRun.InputImage buffer contains the results of the tool after it measures the distance between the point and the line segment
	Floating image display	Opens one or more floating image windows, which support the same image buffers as the local image display window
	Open	Opens 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	Saves 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	Saves the current properties of the vision tool to a new VisionPro persistence (.vpp) file
	Reset	Resets the vision tool to its default state.
	Show ToolTips	Enables or disables the display of tooltips for individual items in the edit control
	Help	Opens this VisionPro online help file

Settings Tab

Use the Settings tab to define the input point and line segment, or use the tab to confirm that the existing shapes correspond to the correct input parameters generated by another tool. The following figure shows the Settings tab:

The Settings tab offers the following features to define the point parameter:

Table 2. Settings tab

Feature	Description
X	The x-coordinate of the point (X, Y)
Y	The y-coordinate of the point (X, Y)

The Settings tab offers the following features to define the Segment parameter:

Table 3. Settings tab

Feature	Description
SelectedSpaceName	Names the coordinate space for the segment shape
Select Mode	Determines 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 StartY	Names the starting (x, y) coordinate of the line segment
EndX and EndY	Names the ending (x, y) coordinate of the line segment when using the 2 Points option.
Length and Rotation	Controls the length and angle of rotation of the line segment when using the Point/Length option.

Graphics Tab

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

The Graphics tab offers the following features:

Table 4. Graphics tab

Feature	Description
Show Input Image	Determines 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 Point	Show Point in the LastRun.InputImage buffer
Show Segment	Show Segment in the LastRun.InputImage buffer
Show Arrow	Show the line segment representing the shortest distance between the point (X, Y) and Segment

Results Tab

Use the Results tab to view the relationship between the point (X, Y) and Segment as determined by the Distance Point Segment tool. The following figure shows the Results tab:

The Results tab offers the following features:

Table 5. Results tab

Feature	Description
Distance	The shortest distance between the point (X, Y) and Segment
SegmentX and SegmentY	The (x, y) coordinate on Segment that is closest to the point (X, Y)