EllipticalAnnulusSection ClassCognex VisionPro 9.22

An elliptical annulus section is a four-sided shape bounded by two elliptical arcs and two straight lines. The arcs are scaled copies of each other. You specify the 'start' arc and then provide a RadialScale that defines the 'end' arc.

Inheritance Hierarchy

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

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

public sealed class EllipticalAnnulusSection : GraphicInteractiveBase, 
	IRegion, IShape, IChangedEvent, IObject, IDiamondGraphicShape

The EllipticalAnnulusSection type exposes the following members.

Constructors

  NameDescription
Public methodEllipticalAnnulusSection

Constructs a new instance of this class.

Top
Methods

  NameDescription
Public methodCopy

Create a new elliptical annulus section, copying the specified parameters.

Public methodCopyBase

Copy a graphic and its derived parameters.

(Overrides GraphicInteractiveBase CopyBase(CopyShapeConstants).)
Public methodCreateEllipticalArc

Create a new elliptical arc (copying the specified parameters) from this annulus section. The arc is specified as a radial fraction between the start and end arcs. For example, specify 0 for the start arc, 0.5 for the center arc, and 1 for the end arc.

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 methodGetCenterRadiusXYRotationAngleStartAngleSpanRadialScale

Gets CenterX, CenterY, RadiusX, RadiusY, Rotation, AngleStart, AngleSpan, and RadialScale of this elliptical annulus section.

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 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 annulus section as a unit circular arc, a linear transform that maps it to an elliptical arc, and RadialScale. The unit circle arc is centered at (0,0), has a radius of one, and has the given start angle and span (in radians).

Public methodMap

Maps this shape through the given transform.

Public methodMapLinear

Create a new elliptical annulus section 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 methodSetCenterRadiusXYRotationAngleStartAngleSpanRadialScale

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

Public methodSetFromUnitCircleParams

Set the geometry of this annulus section from the given unit circular arc, the linear transform that maps it to an elliptical arc, and RadialScale. 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 EllipticalAnnulusSection objects.
Public operatorStatic memberInequality
Compares the inequality of two EllipticalAnnulusSection objects.
Top
Fields

  NameDescription
Public fieldStatic memberSfAngleSpan
Public fieldStatic memberSfAngleStart
Public fieldStatic memberSfArcDirectionAdornment
Public fieldStatic memberSfArea
Public fieldStatic memberSfCenterArcAdornment
Public fieldStatic memberSfCenterX
Public fieldStatic memberSfCenterY
Public fieldStatic memberSfManipArcFraction
Public fieldStatic memberSfPerimeter
Public fieldStatic memberSfRadialDirectionAdornment
Public fieldStatic memberSfRadialScale
Public fieldStatic memberSfRadiusX
Public fieldStatic memberSfRadiusY
Public fieldStatic memberSfRotation
Top
Properties

  NameDescription
Public propertyAngleSpan
Get

Returns the angular extent (in radians) and direction of the annulus section. For example, a value of π specifies a section that is one half of the full annulus. A value of -π specifies the other half.

Public propertyAngleStart
Get

Returns the angle (in radians) that specifies the start end of the annulus section. It is measured from the x-axis of the underlying ellipse.

Public propertyArcDirectionAdornment
Get

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

Public propertyArea

Returns the area enclosed by this elliptical annulus section.

Public propertyCenterArcAdornment
Get

Returns the center arc adornment of this elliptical annulus section.

Public propertyCenterX
Get

Returns the x coordinate of the ellipse center.

Public propertyCenterY
Get

Returns 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 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 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 propertyManipArcFraction
Get

Returns the fractional distance (between the start and end arcs) where the manipulation arc is drawn. During interactive manipulation, the shape usually resets this fraction to 0.5 but users may reset it sooner if they desire.

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 propertyPerimeter

Returns the total perimeter length of this elliptical annulus section.

Public propertyRadialDirectionAdornment
Get

Returns the radial direction adornment of this elliptical annulus section. These adornments indicate the direction from the start arc to the end arc.

Public propertyRadialScale
Get

Returns the radial scaling factor. The elliptical annulus section contains a 'start' arc, and an 'end' arc that is a scaled copy of it. If RadialScale is greater than 1 the end arc will be larger than the start arc, otherwise it will be smaller.

Public propertyRadiusX
Get

Returns the distance from the center of the start ellipse to its boundary (along the ellipse's x-axis). Note that the start ellipse will be the inner ellipse if RadialScale is greater than one, otherwise it will be the outer one.

Public propertyRadiusY
Get

Returns the distance from the center of the start ellipse to its boundary (along the ellipse's y-axis). Note that the start ellipse will be the inner ellipse if RadialScale is greater than one, otherwise it will be the outer one.

Public propertyRotation
Get

Returns 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 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 annulus section is a four-sided shape bounded by two elliptical arcs and two straight lines. The arcs are scaled copies of each other, and the radial lines connect the endpoints of the arcs. You specify the ( CenterX, CenterY ), RadiusX, RadiusY, Rotation, AngleStart and AngleSpan which defines the start arc and then provide a RadialScale that defines the end arc. If the RadialScale is less than 1, the start arc is the outer arc.

See Also