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
The CogEllipticalAnnulusSection type exposes the following members.
| Name | Description | |
|---|---|---|
| CogEllipticalAnnulusSection | Constructs a new instance of this class. | |
| CogEllipticalAnnulusSection(IntPtr) | Constructs a new instance of this class using com pointer. | |
| CogEllipticalAnnulusSection(CogEllipticalAnnulusSection) | Constructs a new instance of this class as a deep copy of the given instance. |
| 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 annulus section, copying the specified parameters. | |
| CopyBase | Copy a graphic and its derived parameters. | |
| CreateEllipticalArc | 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. | |
| 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 | (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.) | |
| GetCenterRadiusXYRotationAngleStartAngleSpanRadialScale | Gets CenterX, CenterY, RadiusX, RadiusY, Rotation, AngleStart, AngleSpan, and RadialScale of this elliptical 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.) | |
| GetUnitCircleParams | 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). | |
| 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 | 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. | |
| 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. | |
| SetCenterRadiusXYRotationAngleStartAngleSpanRadialScale | Sets CenterX, CenterY, RadiusX, RadiusY, Rotation, AngleStart, AngleSpan, and RadialScale of this elliptical annulus section. All angles are in radians. | |
| SetFromUnitCircleParams | 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). | |
| 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 | (Inherited from Object.) |
| 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. | |
| 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. | |
| 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. |
| Name | Description | |
|---|---|---|
| AngleSpan | 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. | |
| AngleStart | 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. | |
| ArcDirectionAdornment | 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. | |
| Area | Returns the area enclosed by this elliptical annulus section. | |
| CenterArcAdornment | Returns/sets the center arc adornment of this elliptical annulus section. | |
| 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. | |
| 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 total perimeter length of this elliptical annulus section. | |
| RadialDirectionAdornment | Returns/sets the radial direction adornment of this elliptical annulus section. These adornments indicate the direction from the start arc to the end arc. | |
| RadialScale | 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. | |
| RadiusX | 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. | |
| RadiusY | 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. | |
| 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. | |
| TipText | Text to describe this graphic in a tool tip. | |
| Visible | Visible property of this graphic. |
| 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. |
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 HandleDescriptionSection 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.