Class that represents an ellipse.
Cognex.Vision ShareableBase
Cognex.Vision ChangedEventShareableBase
Cognex.Vision GraphicInteractiveBase
Cognex.Vision Ellipse
Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.21.1.1
The Ellipse type exposes the following members.
| Name | Description | |
|---|---|---|
 | Ellipse | 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. |
| GetBoundingRectangleAffine | Extracts an affine rectangle which bounds this ellipse. If DeSkew is TRUE, the rectangle will have zero skew and will be aligned with the principal axes of the ellipse. If DeSkew is false, the rectangle may contain skew. |
| GetCenterXYRadiusXYRotation | Gets the named properties in a single method call. |
| 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. |
| GetUnitCircleTransform | Get a linear transform that maps the unit circle to this ellipse. The unit circle is a circle centered at (0,0) with a radius of one. |
| Map | Maps this shape through the given transform. |
| MapLinear | Create a new ellipse by mapping this one through the given 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. |
| SetCenterXYRadiusXYRotation | Sets the named properties in a single method call. |
| SetFromBoundingRectangleAffine | Sets the properties of this ellipse from the given bounding affine rectangle. |
| SetFromUnitCircleTransform | Set the geometry of this ellipse from the given linear transform that maps the unit circle to an ellipse. The unit circle is a circle centered at (0,0) with a radius of one. |
| 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 Ellipse objects. |
| Inequality | Compares the inequality of two Ellipse objects. |
| Name | Description | |
|---|---|---|
 | SfArea | |
| SfCenterX | |
| SfCenterY | |
| SfPerimeter | |
| SfRadiusX | |
| SfRadiusY | |
| SfRotation | |
| SfXDirectionAdornment | |
| SfYDirectionAdornment |
| Name | Description | |
|---|---|---|
 | Area | Area of this ellipse. |
| CenterX | Get Returns the x coordinate of the ellipse center. |
| CenterY | Get Returns the y coordinate of the ellipse center. |
| 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. |
| Perimeter | Perimeter length of this ellipse. |
| RadiusX | Get Returns the distance from the center of the ellipse to its boundary (measured along the rotated x-axis). |
| RadiusY | Get Returns the distance from the center of the ellipse to its boundary (measured along the rotated y-axis). |
| Rotation | Get Returns the rotation angle (in radians) from the x-axis of the selected coordinate space to the rotated x-axis of the ellipse. |
| 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. |
| XDirectionAdornment | Get The X direction adornment of this ellipse. |
| YDirectionAdornment | Get The Y direction adornment of this ellipse. |
| 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. |
Class that describes an ellipse shape. You specify an ellipse with a center point, a rotation from the shape's x-axis that establishes the ellipse's x- and y-axes, a radius along the x-axis, and a radius along the y-axis.