Class that represents a line.
Cognex.Vision ShareableBase
Cognex.Vision ChangedEventShareableBase
Cognex.Vision GraphicInteractiveBase
Cognex.Vision Line
Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.24.0.0
The Line type exposes the following members.
| Name | Description | |
|---|---|---|
| Line | 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. | |
| 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. | |
| GetDistanceRotation | Gets the line's Distance from the origin and its Rotation in radians from the x-axis. The Distance will be negative if the direction from the origin is reversed. | |
| GetHashCode | Returns the hash code of this object. (Overrides GraphicInteractiveBase GetHashCode .) | |
| GetParentFromChildTransform | Gets the parent transform from the child transform. | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| GetTypeMeta | Get the TypeMeta that describes the type of this object. | |
| GetXYRotation | ||
| Map | Maps this shape through the given transform. | |
| MapLinear | Creates a new line by mapping the line 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. | |
| SetDistanceRotation | Sets the X and Y properties of this line to the end of the vector (Distance, Rotation + 90 deg.) or (-Distance, Rotation - 90 deg.) for negative Distance. Sets the Rotation property to the specified Rotation. | |
| SetFromLineSegment | Sets the line parameters from the specified CogLineSegment. StartX, StartY will be used as the reference point. The direction of the line is from the segment's StartX, StartY to the EndX, EndY. | |
| SetFromStartXYEndXY | Sets the line parameters from a pair of X and Y coordinates that are unique points on the line. The first coordinate pair will be used as the reference point on the line. The direction of the line is from the first point to the second. | |
| SetXYRotation | ||
| 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 Line objects. | |
| Inequality | Compares the inequality of two Line objects. |
| Name | Description | |
|---|---|---|
| SfAdornment | ||
| SfRotation | ||
| SfX | ||
| SfY |
| Name | Description | |
|---|---|---|
| Adornment | Get The reference point adornment for the line. | |
| 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. | |
| 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. | |
| LineStyle | Line style of this graphic. | |
| LineWidthInScreenPixels | Line width (in screen pixels) of this graphic. | |
| 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 | Get The angle (in radians, from the x-axis) of this directed line. The Rotation is normalized to the range -π to π. | |
| 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. | |
| 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. | |
| X | Get The X coordinate of the reference point on the line. | |
| Y | Get The Y coordinate of the reference point on the line. |
| 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 Line. A CogLine is a line of infinite length specified by a reference point and a rotation. The rotation is specified from the x-axis.