Class that represents a line segment.
Cognex.Vision ShareableBase
Cognex.Vision ChangedEventShareableBase
Cognex.Vision GraphicInteractiveBase
Cognex.Vision LineSegment
Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.10.0.0
The LineSegment type exposes the following members.
| Name | Description | |
|---|---|---|
 | LineSegment | Constructs a new instance of this class. |
| Name | Description | |
|---|---|---|
| Copy | Create a new shape that copies specified parameters. |
| CopyBase | Copy a graphic and its derived parameters. |
| CreateLine | Creates a new Line for this line segment. The reference point on the line will be the midpoint of the segment. The line segment must not be degenerate (i.e. the end points must differ). |
| CreateLine(CopyShapeConstants) | Creates a new Line for this line segment. The reference point on the line will be the midpoint of the segment. The line segment must not be degenerate (i.e. the end points must differ). |
| DistanceToPoint | Shortest distance from a boundary of this shape to the given point. Points within closed shapes return a distance less than zero. |
| EnclosingRectangle | Minimum enclosing rectangle of this shape. |
| Equals | Compares the equality of this object with another. (Overrides GraphicInteractiveBase Equals(Object).) |
| FitToBoundingBox | Adjust the shape's geometric properties so that the shape fits inside passed in rectangle. |
| FitToImage | Adjust the shape's geometric properties such that its default size is based on the image and its SelectedSpaceName. XScale and YScale are multipliers where 1.0 designates 100% scaling. |
| GetHashCode | Returns the hash code of this object. (Overrides GraphicInteractiveBase GetHashCode .) |
| GetParentFromChildTransform | Gets the parent transform from the child transform. |
| GetStartEnd | Gets coordinates StartX, EndX, StartY, EndY for the line segment. |
| GetStartLengthRotation | Gets StartX, StartY, Length and Rotation (in radians from the x-axis) for the line segment. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetTypeMeta | Get the TypeMeta that describes the type of this object. |
| Map | Maps this shape through the given transform. |
| MapLinear | Creates a new line segment by mapping this line segment through a linear transform. |
| ResumeAndRaiseChangedEvent | Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent. |
| SetStartEnd | Sets coordinates StartX, StartY, EndX, EndY for the line segment. |
| SetStartLengthRotation | Sets StartX, StartY, Length and Rotation (in radians, from the x-axis) for the line segment. |
| SuspendChangedEvent | Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. |
| ToString | Returns a human readable string that represents the object. |
| Name | Description | |
|---|---|---|
  | Equality | Compares the equality of two LineSegment objects. |
| Inequality | Compares the inequality of two LineSegment objects. |
| Name | Description | |
|---|---|---|
 | SfCreateLine | |
| SfEndPointAdornment | |
| SfEndX | |
| SfEndY | |
| SfLength | |
| SfMidpointX | |
| SfMidpointY | |
| SfRotation | |
| SfStartPointAdornment | |
| SfStartX | |
| SfStartY |
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended | Indicates if raising the ChangedEvent has been suspended. |
| Children | Children of this graphic. |
| Color | Color of this graphic. Can be any OLE_COLOR. |
| DragColor | Color of this graphic when dragged. |
| DragLineStyle | Line style of the graphic when dragged. |
| DragLineWidthInScreenPixels | Line width of this graphic when dragged. |
| EndPointAdornment | Get The end point adornment of this line segment. |
| EndX | Get The X coordinate of the end point for the line segment. |
| EndY | Get The Y coordinate of the end point for the line segment. |
| FillColor | The fill color of this graphic. |
| GraphicDOFEnable | Get Interactive Degree of freedom for this graphic object. Provides the ability to govern interactive manipulation of an object; for example could be used to prevent an object from being resized. |
| GraphicDOFEnableBase | Interactive Degree of freedom for a graphic object. Allows access to each graphic's GraphicDOFEnable property without knowing the specific graphic type. |
| Handle | (Overrides GraphicInteractiveBase Handle.) |
| Interactive | Interactive property allow this graphic object to be selected. See GraphicDOFEnable for information on governing interactive manipulation of an object. |
| Length | The length of the line segment. |
| LineStyle | Line style of this graphic. |
| LineWidthInScreenPixels | Line width (in screen pixels) of this graphic. |
| MidpointX | The X coordinate halfway between StartX and EndX. |
| MidpointY | The Y coordinate halfway between StartY and EndY. |
| MouseCursor | Mouse cursor to be displayed when the mouse is over the graphic. The cursor will be visible only if the graphic is interactive. |
| Parent | Return a reference to the containing tracking collection. May be null. |
| Rotation | The angle (in radians, from the x-axis) of the line segment. The line segment must not be degenerate (i.e. the end points must differ). |
| Selected | True when the shape is selected in a display. |
| SelectedColor | Color of this graphic when selected. |
| SelectedLineStyle | Line style of this graphic when selected. |
| SelectedLineWidthInScreenPixels | Line width of this graphic when selected. |
| SelectedSpaceName | Get (Overrides GraphicInteractiveBase SelectedSpaceName.)Coordinate space in which this shape is to be interpreted. |
| StartPointAdornment | Get The start point adornment of this line segment. |
| StartX | Get The X coordinate of the start point for the line segment. |
| StartY | Get The Y coordinate of the start point for the line segment. |
| TipText | Text to describe this graphic in a tool tip. Newline characters can be used to create multi-line tip text. |
| Visible | Visible property of this graphic. |
| Name | Description | |
|---|---|---|
 | Changed | The actual event. |
| Dragging | Raised when an interactive graphic is being dragged. |
| DraggingStopped | Raised after the drag operation of an interactive graphic is complete. |
Primary interface of a CogLineSegment.