CogCircularArc Class

Cognex VisionPro

A circular arc is a portion of a circle. You specify this shape using the usual circle 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
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro CogCircularArc

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

Syntax

C++

Copy to Clipboard Print

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

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

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

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

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

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

The CogCircularArc type exposes the following members.

Constructors

	Name	Description
	CogCircularArc	Constructs a new instance of this class.
	CogCircularArc(IntPtr)	Constructs a new instance of this class using com pointer.
	CogCircularArc(CogCircularArc)	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 and returns a new circular arc, copying the specified parameters.
	CopyBase	Copy a graphic and its derived parameters.
	CreateCircle	Creates and returns a new circle shape, copying the specified parameters, that is the full circle defined by this circular 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.)
	Dispose
	Dispose(Boolean)
	DistanceToPoint	Shortest distance from this shape to the given point.
	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.)
	GetCenterRadiusAngleStartAngleSpan	Gets CenterX, CenterY, Radius, AngleStart, and AngleSpan of this circular arc.
	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.)
	GetStartEnd	Gets start and end point coordinates of the circular arc.
	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 arc (copying the specified parameters) by mapping this circular arc 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.
	SetCenterRadiusAngleStartAngleSpan	Sets CenterX, CenterY, Radius, AngleStart (in radians) and AngleSpan (in radians) of this circular arc.
	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.
	SfArcLength	This bit will be set in the EventArgs of a Changed event every time the value returned by ArcLength 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.
	SfDirectionAdornment	This bit will be set in the EventArgs of a Changed event every time the value returned by DirectionAdornment may have changed.
	SfDisplayedRadiusInScreenPixels	This bit will be set in the EventArgs of a Changed event every time the value returned by DisplayedRadiusInScreenPixels may have changed.
	SfDisplayMode	This bit will be set in the EventArgs of a Changed event every time the value returned by DisplayMode 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.
	SfEndPointAdornment	This bit will be set in the EventArgs of a Changed event every time the value returned by EndPointAdornment may have changed.
	SfEndX	This bit will be set in the EventArgs of a Changed event every time the value returned by EndX may have changed.
	SfEndY	This bit will be set in the EventArgs of a Changed event every time the value returned by EndY 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.
	SfMidpointX	This bit will be set in the EventArgs of a Changed event every time the value returned by MidpointX may have changed.
	SfMidpointY	This bit will be set in the EventArgs of a Changed event every time the value returned by MidpointY 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.
	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.
	SfStartPointAdornment	This bit will be set in the EventArgs of a Changed event every time the value returned by StartPointAdornment may have changed.
	SfStartX	This bit will be set in the EventArgs of a Changed event every time the value returned by StartX may have changed.
	SfStartY	This bit will be set in the EventArgs of a Changed event every time the value returned by StartY 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 circular arc. Note that this can be positive or negative (but not exactly 0), and implies an arc direction.
	AngleStart	Returns/sets the start angle (in radians) of this circular arc.
	ArcLength	Returns the length of this circular arc.
	CenterX	Returns/sets the X coordinate of the center of the circle.
	CenterY	Returns/sets the Y coordinate of the center of the circle.
	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.
	DirectionAdornment	Returns/sets the arc direction adornment of this circular arc.
	DisplayedRadiusInScreenPixels	Returns/sets the screen radius the arc will be drawn with if DisplayMode is cogCircularArcDisplayModeScreen.
	DisplayMode	Returns/sets the mode in which the arc will be displayed, either with the screen radius (DisplayedRadiusInScreenPixels) or the normal geometric radius (Radius).
	DragColor	Color of this graphic when dragged.
	DragLineStyle	Line style of this graphic when dragged.
	DragLineWidthInScreenPixels	Line width of this graphic when dragged.
	EndPointAdornment	Returns/sets the end point adornment of this circular arc.
	EndX	Returns the x coordinate of the arc end point (the point at the AngleStart + AngleSpan end of the arc).
	EndY	Returns the y coordinate of the arc end point (the point at the AngleStart + AngleSpan end of the arc).
	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.
	MidpointX	Returns the x coordinate of the arc mid-point (the point on the arc halfway between 'start' and 'end').
	MidpointY	Returns the y coordinate of the arc mid-point.
	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.
	Radius	Returns/sets the radius of the circle.
	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.
	StartPointAdornment	Returns/sets the start point adornment of this circular arc.
	StartX	Returns the x coordinate of the arc start point (the point at the AngleStart end of the arc).
	StartY	Returns the y coordinate of the arc start point (the point at the AngleStart end of the arc).
	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 arc is a portion of a circle. You specify this shape using the usual circle parameters and two additional ones: AngleStart, the angle at which the arc begins, and AngleSpan, the angular extent of the arc.

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

Interactive HandleDescription

Arc 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 arc parameters except the other endpoint.

Bend

Lets you change the curvature of the circular arc. Changing the curvature can change all of the other circular arc parameters except the endpoints.