CogCircularAnnulusSection Class

Cognex VisionPro 9.8 SR1

A circular annulus section is a four-sided shape bounded by two circular arcs and two radial 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 CogCircularAnnulusSection

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

Syntax

C++

Copy to Clipboard Print

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

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

<SerializableAttribute>
Public Class CogCircularAnnulusSection 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, ICogChangedEvent, ICogShape, ICogRegion, ICogGraphic, 
	ICogGraphicInteractive, ICogGraphicParentChild

<SerializableAttribute>
Public Class CogCircularAnnulusSection 
	Inherits CogObjectBase 
	Implements ICogNetInternal, IDisposable, ICloneable, ISerializable, 
	ICogHasChanged, ICogChangedEvent, ICogShape, ICogRegion, ICogGraphic, 
	ICogGraphicInteractive, ICogGraphicParentChild

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

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

The CogCircularAnnulusSection type exposes the following members.

Constructors

	Name	Description
	CogCircularAnnulusSection	Constructs a new instance of this class.
	CogCircularAnnulusSection(IntPtr)	Constructs a new instance of this class using com pointer.
	CogCircularAnnulusSection(CogCircularAnnulusSection)	Constructs a new instance of this class as a deep copy of the given instance.

Top

Methods

	Name	Description
	Clone	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
	Copy	Creates a new circular annulus section, copying the specified parameters.
	CopyBase	Copy a graphic and its derived parameters.
	CreateCircularArc	Creates a new circular arc (copying the specified parameters) defined by this circular annulus section at the given 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.
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	CreateRLE	Create an RLE representation of this Region.
	Dispose
	Dispose(Boolean)
	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	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	(Overrides Object Finalize .)
	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.
	GetAttributes	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetCenterRadiusAngleStartAngleSpanRadialScale	Gets CenterX, CenterY, Radius, AngleStart (in radians), AngleSpan (in radians) and RadialScale of the circular annulus section.
	GetClassName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetComponentName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetConverter	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultEvent	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultProperty	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEditor	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData
	GetParentFromChildTransform
	GetProperties	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetProperties( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	Map	Maps this shape through the given transform.
	MapLinear	Creates a new elliptical annulus section (copying the specified parameters) by mapping this circular annulus section through the given linear transform.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	ResumeAndRaiseChangedEvent	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.
	SetCenterRadiusAngleStartAngleSpanRadialScale	Sets CenterX, CenterY, Radius, AngleStart (in radians), AngleSpan (in radians) and RadialScale of the circular annulus section.
	SuspendChangedEvent	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.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfAngleSpan	This bit will be set in the EventArgs of a Changed event every time the value returned by AngleSpan may have changed.
	SfAngleStart	This bit will be set in the EventArgs of a Changed event every time the value returned by AngleStart may have changed.
	SfArcDirectionAdornment	This bit will be set in the EventArgs of a Changed event every time the value returned by ArcDirectionAdornment may have changed.
	SfArea	This bit will be set in the EventArgs of a Changed event every time the value returned by Area may have changed.
	SfCenterArcAdornment	This bit will be set in the EventArgs of a Changed event every time the value returned by CenterArcAdornment may have changed.
	SfCenterX	This bit will be set in the EventArgs of a Changed event every time the value returned by CenterX may have changed.
	SfCenterY	This bit will be set in the EventArgs of a Changed event every time the value returned by CenterY may have changed.
	SfChildren	This bit will be set in the EventArgs of a Changed event every time the value returned by Children may have changed.
	SfColor	This bit will be set in the EventArgs of a Changed event every time the value returned by Color may have changed.
	SfCreateRLE	This bit will be set in the EventArgs of a Changed event every time the value returned by CreateRLE may have changed.
	SfDragColor	This bit will be set in the EventArgs of a Changed event every time the value returned by DragColor may have changed.
	SfDragLineStyle	This bit will be set in the EventArgs of a Changed event every time the value returned by DragLineStyle may have changed.
	SfDragLineWidthInScreenPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by DragLineWidthInScreenPixels may have changed.
	SfEnclosingRectangle	This bit will be set in the EventArgs of a Changed event every time the value returned by EnclosingRectangle may have changed.
	SfGraphicDOFEnable	This bit will be set in the EventArgs of a Changed event every time the value returned by GraphicDOFEnable may have changed.
	SfGraphicDOFEnableBase	This bit will be set in the EventArgs of a Changed event every time the value returned by GraphicDOFEnableBase may have changed.
	SfInteractive	This bit will be set in the EventArgs of a Changed event every time the value returned by Interactive may have changed.
	SfLineStyle	This bit will be set in the EventArgs of a Changed event every time the value returned by LineStyle may have changed.
	SfLineWidthInScreenPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by LineWidthInScreenPixels may have changed.
	SfManipArcFraction	This bit will be set in the EventArgs of a Changed event every time the value returned by ManipArcFraction may have changed.
	SfMouseCursor	This bit will be set in the EventArgs of a Changed event every time the value returned by MouseCursor may have changed.
	SfParent	This bit will be set in the EventArgs of a Changed event every time the value returned by Parent may have changed.
	SfPerimeter	This bit will be set in the EventArgs of a Changed event every time the value returned by Perimeter may have changed.
	SfRadialDirectionAdornment	This bit will be set in the EventArgs of a Changed event every time the value returned by RadialDirectionAdornment may have changed.
	SfRadialScale	This bit will be set in the EventArgs of a Changed event every time the value returned by RadialScale may have changed.
	SfRadius	This bit will be set in the EventArgs of a Changed event every time the value returned by Radius may have changed.
	SfSelected	This bit will be set in the EventArgs of a Changed event every time the value returned by Selected may have changed.
	SfSelectedColor	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedColor may have changed.
	SfSelectedLineStyle	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedLineStyle may have changed.
	SfSelectedLineWidthInScreenPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedLineWidthInScreenPixels may have changed.
	SfSelectedSpaceName	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedSpaceName may have changed.
	SfTipText	This bit will be set in the EventArgs of a Changed event every time the value returned by TipText may have changed.
	SfVisible	This bit will be set in the EventArgs of a Changed event every time the value returned by Visible may have changed.

Top

Properties

	Name	Description
	AngleSpan	Returns/sets the angle span (in radians) of this annulus section. Note that this can be positive or negative, and implies arc direction.
	AngleStart	Returns/sets the starting angle (in radians) of this annulus section.
	ArcDirectionAdornment	Returns/sets the arc direction adornment of this annulus section.
	Area	Returns the area enclosed by this circular annulus section.
	CenterArcAdornment	Returns/sets the center arc adornment of this annulus section.
	CenterX	Returns/sets the X coordinate of the center of the circle defined by this circular annulus section.
	CenterY	Returns/sets the Y coordinate of the center of the circle defined by this circular annulus section.
	ChangedEventSuspended	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.
	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 this graphic when dragged.
	DragLineWidthInScreenPixels	Line width of this graphic when dragged.
	GraphicDOFEnable	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.
	HasChanged	If true, the serializable state of this object has changed since the last time it was serialized.
	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.
	ManipArcFraction	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.
	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	Parent of this graphic.
	Perimeter	Returns the perimeter length of this circular annulus section.
	RadialDirectionAdornment	Returns/sets the radial direction adornment of this annulus section.
	RadialScale	Returns/sets the radial scale of this annular section. Note that this can be less than or greater than 1 (but not equal to 1, and not <=0) and therefore implies a radial direction.
	Radius	Returns/sets the Radius of the start arc of this annulus section. Note this could be either the inner arc or the outer arc depending on whether RadialScale is greater than or less than 1.0.
	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	Coordinate space in which this shape is to be interpreted.
	TipText	Text to describe this graphic in a tool tip.
	Visible	Visible property of this graphic.

Top

Events

	Name	Description
	Changed	Occurs when one or more parts of the object's state may have changed.
	Dragging	Occurs when an interactive graphic is being dragged.
	DraggingStopped	Occurs after the drag operation of an interactive graphic is complete.

Top

Remarks

A circular annulus section is a four-sided shape bounded by two circular arcs and two radial lines. The arcs are scaled copies of each other, and the radial lines connect the endpoints of the arcs.

You specify the (CenterX,CenterY), Radius, 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 circular 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 circle. The center and radius do not change.

Endpoint

Lets you change location of either endpoint. Changing an endpoint can cause changes to all of the other circular 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, 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 circular annulus section. Changing the curvature can change all of the other circular annulus section parameters except the endpoints.