EllipticalArc ClassCognex VisionPro 9.25 SR1

An elliptical arc is a portion of an ellipse. You specify this shape using the usual ellipse parameters and two more: AngleStart and AngleSpan. AngleStart defines the angle at which the arc begins and AngleSpan defines the angular extent of the arc.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision GraphicInteractiveBase
        Cognex.Vision EllipticalArc

Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.25.1.0
Syntax

public sealed class EllipticalArc : GraphicInteractiveBase, 
	IShape, IChangedEvent, IObject, IDiamondGraphicShape

The EllipticalArc type exposes the following members.

Constructors

  NameDescription
Public methodEllipticalArc

Constructs a new instance of this class.

Top
Methods

  NameDescription
Public methodCopy

Create a new elliptical arc, copying the specified parameters.

Public methodCopyBase

Copy a graphic and its derived parameters.

(Overrides GraphicInteractiveBase CopyBase(CopyShapeConstants).)
Public methodCreateEllipse

Create a new ellipse shape. The returned ellipse will have the same center, radii, rotation, and unit circle transform as this elliptical arc. Use the CopyFlags to specify what other parts of this shape should be copied into the new one.

Public methodDistanceToPoint

Shortest distance from a boundary of this shape to the given point. Points within closed shapes return a distance less than zero.

Public methodEnclosingRectangle

Minimum enclosing rectangle of this shape.

Public methodEquals
Compares the equality of this object with another.
(Overrides GraphicInteractiveBase Equals(Object).)
Public methodFitToBoundingBox

Adjust the shape's geometric properties so that the shape fits inside passed in rectangle.

Public methodFitToImage

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.

Public methodGetCenterRadiusXYRotationAngleStartAngleSpan

Gets CenterX, CenterY, RadiusX, RadiusY, Rotation, AngleStart, and AngleSpan of this elliptical arc. All angles are in radians.

Public methodGetHashCode
Returns the hash code of this object.
(Overrides GraphicInteractiveBase GetHashCode .)
Public methodGetParentFromChildTransform

Gets the parent transform from the child transform.

(Overrides GraphicInteractiveBase GetParentFromChildTransform .)
Public methodGetStartEnd

Gets the start and end point coordinates of this elliptical arc. The start point occurs at the angle given by AngleStart. The end point occurs at the angle given by AngleStart + AngleSpan.

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeMeta

Get the TypeMeta that describes the type of this object.

(Overrides ShareableBase GetTypeMeta .)
Public methodGetUnitCircleParams

Get a description of this elliptical arc as a unit circular arc and a linear transform that maps it to an elliptical arc. The unit circle arc is centered at (0,0), has a radius of one, and has the provided start angle and span (in radians).

Public methodMap

Maps this shape through the given transform.

Public methodMapLinear

Create a new elliptical arc by mapping this one through the given linear transform. Use the CopyFlags to specify what other parts of this shape should be copied into the new one.

Public methodResumeAndRaiseChangedEvent

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.

(Overrides ChangedEventShareableBase ResumeAndRaiseChangedEvent .)
Public methodSetCenterRadiusXYRotationAngleStartAngleSpan

Sets CenterX, CenterY, RadiusX, RadiusY, Rotation, AngleStart, and AngleSpan of this elliptical arc. All angles are in radians.

Public methodSetFromUnitCircleParams

Set the geometry of this elliptical arc from the given description of a unit circular arc and the linear transform that maps it to an elliptical arc. The unit circle arc is centered at (0,0), has a radius of one, and has the given start angle (in radians) and span (in radians).

Public methodSuspendChangedEvent

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.

(Overrides ChangedEventShareableBase SuspendChangedEvent .)
Public methodToString

Returns a human readable string that represents the object.

(Overrides Object ToString .)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares the equality of two EllipticalArc objects.
Public operatorStatic memberInequality
Compares the inequality of two EllipticalArc objects.
Top
Fields

  NameDescription
Public fieldStatic memberSfAngleSpan
Public fieldStatic memberSfAngleStart
Public fieldStatic memberSfArcLength
Public fieldStatic memberSfCenterX
Public fieldStatic memberSfCenterY
Public fieldStatic memberSfDirectionAdornment
Public fieldStatic memberSfEndPointAdornment
Public fieldStatic memberSfEndX
Public fieldStatic memberSfEndY
Public fieldStatic memberSfRadiusX
Public fieldStatic memberSfRadiusY
Public fieldStatic memberSfRotation
Public fieldStatic memberSfStartPointAdornment
Public fieldStatic memberSfStartX
Public fieldStatic memberSfStartY
Top
Properties

  NameDescription
Public propertyAngleSpan
Get

Returns/sets the angular extent (in radians) and direction of the arc. For example, a value of Pi specifies an arc that is one half of the full ellipse. A value of -Pi specifies the other half.

Public propertyAngleStart
Get

Returns/sets the angle (in radians) that specifies the start of the arc. It is measured from the x-axis of the underlying ellipse.

Public propertyArcLength

Returns the total length of this arc.

Public propertyCenterX
Get

Returns/sets the x coordinate of the ellipse center.

Public propertyCenterY
Get

Returns/sets the y coordinate of the ellipse center.

Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Overrides ChangedEventShareableBase ChangedEventSuspended.)
Public propertyChildren

Children of this graphic.

(Overrides GraphicInteractiveBase Children.)
Public propertyColor

Color of this graphic. Can be any OLE_COLOR.

(Overrides GraphicInteractiveBase Color.)
Public propertyDirectionAdornment
Get

Returns/sets the direction adornment of this elliptical arc. These adornments indicate the direction from the start point to the end point.

Public propertyDragColor

Color of this graphic when dragged.

(Overrides GraphicInteractiveBase DragColor.)
Public propertyDragLineStyle

Line style of the graphic when dragged.

(Overrides GraphicInteractiveBase DragLineStyle.)
Public propertyDragLineWidthInScreenPixels

Line width of this graphic when dragged.

(Overrides GraphicInteractiveBase DragLineWidthInScreenPixels.)
Public propertyEndPointAdornment
Get

Returns/sets the end point adornment of this elliptical arc. The end point occurs at the angle given by AngleStart + AngleSpan.

Public propertyEndX

Returns the x coordinate of the arc's end point. The end point occurs at the angle given by AngleStart + AngleSpan.

Public propertyEndY

Returns the y coordinate of the arc's end point. The end point occurs at the angle given by AngleStart + AngleSpan.

Public propertyFillColor

The fill color of this graphic.

(Overrides GraphicInteractiveBase FillColor.)
Public propertyGraphicDOFEnable
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.

Public propertyGraphicDOFEnableBase

Interactive Degree of freedom for a graphic object. Allows access to each graphic's GraphicDOFEnable property without knowing the specific graphic type.

(Overrides GraphicInteractiveBase GraphicDOFEnableBase.)
Public propertyHandle (Overrides GraphicInteractiveBase Handle.)
Public propertyInteractive

Interactive property allow this graphic object to be selected. See GraphicDOFEnable for information on governing interactive manipulation of an object.

(Overrides GraphicInteractiveBase Interactive.)
Public propertyLineStyle

Line style of this graphic.

(Overrides GraphicInteractiveBase LineStyle.)
Public propertyLineWidthInScreenPixels

Line width (in screen pixels) of this graphic.

(Overrides GraphicInteractiveBase LineWidthInScreenPixels.)
Public propertyMouseCursor

Mouse cursor to be displayed when the mouse is over the graphic. The cursor will be visible only if the graphic is interactive.

(Overrides GraphicInteractiveBase MouseCursor.)
Public propertyParent

Return a reference to the containing tracking collection. May be null.

(Overrides GraphicInteractiveBase Parent.)
Public propertyRadiusX
Get

Returns/sets the distance from the center of the ellipse to its boundary (along the ellipse's x-axis).

Public propertyRadiusY
Get

Returns/sets the distance from the center of the ellipse to its boundary (along the ellipse's y-axis).

Public propertyRotation
Get

Returns/sets the rotation angle (in radians) from the x-axis of the selected coordinate space to the x-axis of the ellipse.

Public propertySelected

True when the shape is selected in a display.

(Overrides GraphicInteractiveBase Selected.)
Public propertySelectedColor

Color of this graphic when selected.

(Overrides GraphicInteractiveBase SelectedColor.)
Public propertySelectedLineStyle

Line style of this graphic when selected.

(Overrides GraphicInteractiveBase SelectedLineStyle.)
Public propertySelectedLineWidthInScreenPixels

Line width of this graphic when selected.

(Overrides GraphicInteractiveBase SelectedLineWidthInScreenPixels.)
Public propertySelectedSpaceName
Get

Coordinate space in which this shape is to be interpreted.

(Overrides GraphicInteractiveBase SelectedSpaceName.)
Public propertyStartPointAdornment
Get

Returns the start point adornment of this elliptical arc. The start point occurs at the angle given by AngleStart.

Public propertyStartX

Returns the x coordinate of the arc's start point. The start point occurs at the angle given by AngleStart.

Public propertyStartY

Returns the y coordinate of the arc's start point. The start point occurs at the angle given by AngleStart.

Public propertyTipText

Text to describe this graphic in a tool tip. Newline characters can be used to create multi-line tip text.

(Overrides GraphicInteractiveBase TipText.)
Public propertyVisible

Visible property of this graphic.

(Overrides GraphicInteractiveBase Visible.)
Top
Events

  NameDescription
Public eventChanged

The actual event.

(Overrides ChangedEventShareableBase Changed.)
Public eventDragging

Raised when an interactive graphic is being dragged.

(Overrides GraphicInteractiveBase Dragging.)
Public eventDraggingStopped

Raised after the drag operation of an interactive graphic is complete.

(Overrides GraphicInteractiveBase DraggingStopped.)
Top
Remarks

An elliptical arc is a portion of an ellipse. You specify this shape using the usual ellipse parameters and two more: AngleStart, the angle at which the arc begins, and AngleSpan, the angular extent of the arc.

See Also