This topic contains the following sections.
The Create Segment edit control provides a graphical user interface to the CogLineSegment method, which creates a new line segment. The edit control allows you to specify the length of the segment, dictate which graphics appear as the tool executes, and view tool results. The following figure shows the Create Segment edit control:
The edit control offers the following features:
- A row of control buttons at the top left
- A set of function tabs to specify the endpoints of 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 CogCreateSegment tool. A new CogCreateSegment tool appears as shown in the following figure:
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.
The following table describes the function of each button:
| Button | Description | Function |
 | Run | Creates a line segment with the parameters specified in the Settings tab |
 | Electric mode | Toggles electric mode, where the Create 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 Create Segment tool supports the following image buffers:
|
 | Floating image display | Opens or closes the floating image window, which supports 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 |
Use the Settings tab to specify the location and length of the line segment. The following figure shows the Settings tab:
The Settings tab offers the following features:
| 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. |
| FitToImage | Centers the line segment within the Current.InputImage |
With the Output drawing style section, you can control the appearance of the output shape that is drawn on the image. See the controls and the example below.
| Feature | Description |
| OutputColor | The output shape color |
| OutputLineWidthInScreenPixels | The line width of the output shape |
| OutputLineStyle | The line style of the output shape |
Use the Graphics tab to control which graphics the Create Segment tool generates and displays. The following figure shows the Graphics tab:
The Graphics tab offers the following features:
| 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 Output Segment | Show the output line segment in the LastRun.InputImage buffer |
Use the Results tab to view the parameters of the finished line segment. The following figure shows the Results tab:
The Results tab offers the following features:
| Feature | Description |
| Selected Space Name | The coordinate space for the input image |
| Select Mode | Indicates 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). |
| Start X and Start Y | The starting (x, y) coordinate of the line segment |
| End X and End Y | The ending (x, y) coordinate of the line segment when using the 2 Points option. |
| Length and Rotation | The length and angle of rotation of the line segment when using the Point/Length option. |