CogEllipticalArc Class

Cognex VisionPro 9.8

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
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro CogEllipticalArc

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

Syntax

C++

Copy to Clipboard Print

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

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

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

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

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

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

The CogEllipticalArc type exposes the following members.

Constructors

	Name	Description
	CogEllipticalArc	Constructs a new instance of this class.
	CogEllipticalArc(IntPtr)	Constructs a new instance of this class using com pointer.
	CogEllipticalArc(CogEllipticalArc)	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	Create a new elliptical arc, copying the specified parameters.
	CopyBase	Copy a graphic and its derived parameters.
	CreateEllipse	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.
	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.)
	GetCenterRadiusXYRotationAngleStartAngleSpan	Gets CenterX, CenterY, RadiusX, RadiusY, Rotation, AngleStart, and AngleSpan of this elliptical arc. All angles are in radians.
	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 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.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUnitCircleParams	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).
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MakeShapeModel	Returns a newly created shape model with the given weight and polarity. The 'Shape' property of the returned shape model will refer to this shape, or a copy of this shape, as specified by the CopyShape argument.
	Map	Maps this shape through the given transform.
	MapLinear	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.
	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.
	SetCenterRadiusXYRotationAngleStartAngleSpan	Sets CenterX, CenterY, RadiusX, RadiusY, Rotation, AngleStart, and AngleSpan of this elliptical arc. All angles are in radians.
	SetFromUnitCircleParams	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).
	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.
	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.
	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.
	SfRadiusX	This bit will be set in the EventArgs of a Changed event every time the value returned by RadiusX may have changed.
	SfRadiusY	This bit will be set in the EventArgs of a Changed event every time the value returned by RadiusY may have changed.
	SfRotation	This bit will be set in the EventArgs of a Changed event every time the value returned by Rotation 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 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.
	AngleStart	Returns/sets the angle (in radians) that specifies the start of the arc. It is measured from the x-axis of the underlying ellipse.
	ArcLength	Returns the total length of this arc.
	CenterX	Returns/sets the x coordinate of the ellipse center.
	CenterY	Returns/sets the y coordinate of the ellipse center.
	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 direction adornment of this elliptical arc. These adornments indicate the direction from the start point to the end point.
	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 elliptical arc. The end point occurs at the angle given by AngleStart + AngleSpan.
	EndX	Returns the x coordinate of the arc's end point. The end point occurs at the angle given by AngleStart + AngleSpan.
	EndY	Returns the y coordinate of the arc's end point. The end point occurs at the angle given by AngleStart + AngleSpan.
	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.
	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.
	RadiusX	Returns/sets the distance from the center of the ellipse to its boundary (along the ellipse's x-axis).
	RadiusY	Returns/sets the distance from the center of the ellipse to its boundary (along the ellipse's y-axis).
	Rotation	Returns/sets the rotation angle (in radians) from the x-axis of the selected coordinate space to the x-axis of the ellipse.
	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 elliptical arc. The start point occurs at the angle given by AngleStart.
	StartX	Returns the x coordinate of the arc's start point. The start point occurs at the angle given by AngleStart.
	StartY	Returns the y coordinate of the arc's start point. The start point occurs at the angle given by AngleStart.
	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

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.

The following picture shows the parts of the elliptical 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 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 arc parameters except the other endpoint.

Bend

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

Constrained span

Lets you change the curvature of the elliptical arc by holding the endpoints and the Bend handle constant. As this handle rotates around the Bend handle, the underlying ellipse changes so that the arc 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 arc 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 arc spans 50% of the ellipse.