CogEllipticalAnnulusSection ClassCognex VisionPro 9.7
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
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro CogEllipticalAnnulusSection

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 73.0.0.0
Syntax

[SerializableAttribute]
public class CogEllipticalAnnulusSection : CogObjectBase, 
	ICogNetInternal, IDisposable, ICloneable, ISerializable, ICogHasChanged, 
	ICogChangedEvent, ICogShape, ICogRegion, ICogGraphic, ICogGraphicInteractive, 
	ICogGraphicParentChild

The CogEllipticalAnnulusSection type exposes the following members.

Constructors

  NameDescription
Public methodCogEllipticalAnnulusSection 
Constructs a new instance of this class.
Public methodCogEllipticalAnnulusSection(IntPtr)
Constructs a new instance of this class using com pointer.
Public methodCogEllipticalAnnulusSection(CogEllipticalAnnulusSection)
Constructs a new instance of this class as a deep copy of the given instance.
Top
Methods

  NameDescription
Protected methodClone
Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject
Public methodCopy
Create a new elliptical annulus section, copying the specified parameters.
Public methodCopyBase
Copy a graphic and its derived parameters.
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 methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodCreateRLE
Create an RLE representation of this Region.
Public methodDispose 
Protected methodDispose(Boolean)
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
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize (Overrides Object Finalize .)
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.
Protected methodGetAttributes
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetCenterRadiusXYRotationAngleStartAngleSpanRadialScale
Gets CenterX, CenterY, RadiusX, RadiusY, Rotation, AngleStart, AngleSpan, and RadialScale of this elliptical annulus section.
Protected methodGetClassName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetComponentName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetConverter
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultEvent
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultProperty
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEditor
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodGetObjectData
Public methodGetParentFromChildTransform
Protected methodGetProperties 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetProperties( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetPropertyOwner
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
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 methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
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.
Protected methodMemberwiseClone 
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Public methodResumeAndRaiseChangedEvent
Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also raises the Changed event 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.
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 Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Top
Fields

  NameDescription
Public fieldStatic memberSfAngleSpan
This bit will be set in the EventArgs of a Changed event every time the value returned by AngleSpan may have changed.
Public fieldStatic memberSfAngleStart
This bit will be set in the EventArgs of a Changed event every time the value returned by AngleStart may have changed.
Public fieldStatic memberSfArcDirectionAdornment
This bit will be set in the EventArgs of a Changed event every time the value returned by ArcDirectionAdornment may have changed.
Public fieldStatic memberSfArea
This bit will be set in the EventArgs of a Changed event every time the value returned by Area may have changed.
Public fieldStatic memberSfCenterArcAdornment
This bit will be set in the EventArgs of a Changed event every time the value returned by CenterArcAdornment may have changed.
Public fieldStatic memberSfCenterX
This bit will be set in the EventArgs of a Changed event every time the value returned by CenterX may have changed.
Public fieldStatic memberSfCenterY
This bit will be set in the EventArgs of a Changed event every time the value returned by CenterY may have changed.
Public fieldStatic memberSfChildren
This bit will be set in the EventArgs of a Changed event every time the value returned by Children may have changed.
Public fieldStatic memberSfColor
This bit will be set in the EventArgs of a Changed event every time the value returned by Color may have changed.
Public fieldStatic memberSfCreateRLE
This bit will be set in the EventArgs of a Changed event every time the value returned by CreateRLE may have changed.
Public fieldStatic memberSfDragColor
This bit will be set in the EventArgs of a Changed event every time the value returned by DragColor may have changed.
Public fieldStatic memberSfDragLineStyle
This bit will be set in the EventArgs of a Changed event every time the value returned by DragLineStyle may have changed.
Public fieldStatic memberSfDragLineWidthInScreenPixels
This bit will be set in the EventArgs of a Changed event every time the value returned by DragLineWidthInScreenPixels may have changed.
Public fieldStatic memberSfEnclosingRectangle
This bit will be set in the EventArgs of a Changed event every time the value returned by EnclosingRectangle may have changed.
Public fieldStatic memberSfGraphicDOFEnable
This bit will be set in the EventArgs of a Changed event every time the value returned by GraphicDOFEnable may have changed.
Public fieldStatic memberSfGraphicDOFEnableBase
This bit will be set in the EventArgs of a Changed event every time the value returned by GraphicDOFEnableBase may have changed.
Public fieldStatic memberSfInteractive
This bit will be set in the EventArgs of a Changed event every time the value returned by Interactive may have changed.
Public fieldStatic memberSfLineStyle
This bit will be set in the EventArgs of a Changed event every time the value returned by LineStyle may have changed.
Public fieldStatic memberSfLineWidthInScreenPixels
This bit will be set in the EventArgs of a Changed event every time the value returned by LineWidthInScreenPixels may have changed.
Public fieldStatic memberSfManipArcFraction
This bit will be set in the EventArgs of a Changed event every time the value returned by ManipArcFraction may have changed.
Public fieldStatic memberSfMouseCursor
This bit will be set in the EventArgs of a Changed event every time the value returned by MouseCursor may have changed.
Public fieldStatic memberSfParent
This bit will be set in the EventArgs of a Changed event every time the value returned by Parent may have changed.
Public fieldStatic memberSfPerimeter
This bit will be set in the EventArgs of a Changed event every time the value returned by Perimeter may have changed.
Public fieldStatic memberSfRadialDirectionAdornment
This bit will be set in the EventArgs of a Changed event every time the value returned by RadialDirectionAdornment may have changed.
Public fieldStatic memberSfRadialScale
This bit will be set in the EventArgs of a Changed event every time the value returned by RadialScale may have changed.
Public fieldStatic memberSfRadiusX
This bit will be set in the EventArgs of a Changed event every time the value returned by RadiusX may have changed.
Public fieldStatic memberSfRadiusY
This bit will be set in the EventArgs of a Changed event every time the value returned by RadiusY may have changed.
Public fieldStatic memberSfRotation
This bit will be set in the EventArgs of a Changed event every time the value returned by Rotation may have changed.
Public fieldStatic memberSfSelected
This bit will be set in the EventArgs of a Changed event every time the value returned by Selected may have changed.
Public fieldStatic memberSfSelectedColor
This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedColor may have changed.
Public fieldStatic memberSfSelectedLineStyle
This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedLineStyle may have changed.
Public fieldStatic memberSfSelectedLineWidthInScreenPixels
This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedLineWidthInScreenPixels may have changed.
Public fieldStatic memberSfSelectedSpaceName
This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedSpaceName may have changed.
Public fieldStatic memberSfTipText
This bit will be set in the EventArgs of a Changed event every time the value returned by TipText may have changed.
Public fieldStatic memberSfVisible
This bit will be set in the EventArgs of a Changed event every time the value returned by Visible may have changed.
Top
Properties

  NameDescription
Public propertyAngleSpan
Returns/sets the angular extent (in radians) and direction of the annulus section. For example, a value of Pi specifies a section that is one half of the full annulus. A value of -Pi specifies the other half.
Public propertyAngleStart
Returns/sets 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
Returns/sets 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
Returns/sets the center arc adornment of this elliptical annulus section.
Public propertyCenterX
Returns/sets the x coordinate of the ellipse center.
Public propertyCenterY
Returns/sets the y coordinate of the ellipse center.
Public propertyChangedEventSuspended
If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called.
Public propertyChildren
Children of this graphic.
Public propertyColor
Color of this graphic. Can be any OLE_COLOR.
Public propertyDragColor
Color of this graphic when dragged.
Public propertyDragLineStyle
Line style of this graphic when dragged.
Public propertyDragLineWidthInScreenPixels
Line width of this graphic when dragged.
Public propertyGraphicDOFEnable
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.
Public propertyHasChanged
If true, the serializable state of this object has changed since the last time it was serialized.
Public propertyInteractive
Interactive property allow this graphic object to be selected. See GraphicDOFEnable for information on governing interactive manipulation of an object.
Public propertyLineStyle
Line style of this graphic.
Public propertyLineWidthInScreenPixels
Line width (in screen pixels) of this graphic.
Public propertyManipArcFraction
Returns/sets 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.
Public propertyParent
Parent of this graphic.
Public propertyPerimeter
Returns the total perimeter length of this elliptical annulus section.
Public propertyRadialDirectionAdornment
Returns/sets the radial direction adornment of this elliptical annulus section. These adornments indicate the direction from the start arc to the end arc.
Public propertyRadialScale
Returns/sets 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
Returns/sets 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
Returns/sets 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
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.
Public propertySelectedColor
Color of this graphic when selected.
Public propertySelectedLineStyle
Line style of this graphic when selected.
Public propertySelectedLineWidthInScreenPixels
Line width of this graphic when selected.
Public propertySelectedSpaceName
Coordinate space in which this shape is to be interpreted.
Public propertyTipText
Text to describe this graphic in a tool tip.
Public propertyVisible
Visible property of this graphic.
Top
Events

  NameDescription
Public eventChanged
Occurs when one or more parts of the object's state may have changed.
Public eventDragging
Occurs when an interactive graphic is being dragged.
Public eventDraggingStopped
Occurs after the drag operation of an interactive graphic is complete.
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 define 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.

The following picture shows the parts of the elliptical annulus section and the interactive handles available when GraphicDOFEnable is set to All. The handle names are in italics.

Interactive HandleDescription

Section span

Lets you change the length of the arc along the underlying ellipse. The center, radii, and rotation do not change.

Endpoint

Lets you change location of either endpoint. Changing an endpoint can cause changes to all of the other elliptical annulus section parameters except the other endpoint.

Radii

Lets you change the radii of either the inner or outer arc. Changing the radii also changes the RadialScale but not the center, rotation, start angle, or span. If you move the outer arc inside the inner arc or vice versa, the radial direction changes.

Bend

Lets you change the curvature of the elliptical annulus section. Changing the curvature can change all of the other elliptical annulus section parameters except the endpoints.

Constrained span

Lets you change the curvature of the elliptical annulus section by holding the endpoints and the Bend handle constant. As this handle rotates around the Bend handle, the underlying ellipse changes so that the annulus section spans a fraction of the ellipse.

When this handle is 0° relative to the Bend handle (directly to the right in the default coordinate system) the underlying ellipse grows quite large and flat so that the annulus section spans about 10% of the ellipse. When the handle is 180° from the Bend handle (directly to its left in the default coordinate system), the underlying ellipse becomes smaller so that the annulus section spans 50% of the ellipse.

See Also