This shape model object can only be created using the MakeShapeModel method of CogCircle.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation.Internal CogShapeModelCircle
Namespace: Cognex.VisionPro.Implementation.Internal
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 75.1.0.0
Syntax
[SerializableAttribute] public class CogShapeModelCircle : CogObjectBase, ICogNetInternal, IDisposable, ICogShapeModel, ICogModelFeature, ICloneable, ISerializable, ICogHasChanged, ICogChangedEvent, ICogShape, ICogGraphic, ICogGraphicInteractive, ICogGraphicParentChild
The CogShapeModelCircle type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogShapeModelCircle | Constructs a new instance of this class. |
| CogShapeModelCircle(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogShapeModelCircle(CogShapeModelCircle) | Constructs a new instance of this class as a deep copy of the given instance. |
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 |
| CopyBase | Copy a graphic and its derived parameters. |
| 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.) |
| CreateSubFeatureIterator | Returns a newly created iterator for iterating over all subfeatures. The iterator is positioned at the subfeature specified by InitialIndex. A value of -1 creates an iterator that is positioned just after the last valid subfeature. |
| 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.) |
| 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.) |
| GetEffectivePolarity | If this feature has no ParentFeature, then its effective polarity is the value of the Polarity property. If this feature has a ParentFeature, then the effective polarity is the Polarity times the effective polarity of the ParentFeature. |
| GetEffectiveWeight | If this feature has no ParentFeature, then its effective weight is the value of the Weight property. If this feature has a ParentFeature, then the effective weight is the Weight times the effective weight of the ParentFeature. |
| 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. |
| 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. |
| 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.) |
Fields
| Name | Description | |
|---|---|---|
  | SfArea | This bit will be set in the EventArgs of a Changed event every time the value returned by Area 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. |
| 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. |
| SfPolarity | This bit will be set in the EventArgs of a Changed event every time the value returned by Polarity may have changed. |
| SfPolarityAdornment | This bit will be set in the EventArgs of a Changed event every time the value returned by PolarityAdornment 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. |
| SfSubFeatureCount | This bit will be set in the EventArgs of a Changed event every time the value returned by SubFeatureCount 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. |
| SfWeight | This bit will be set in the EventArgs of a Changed event every time the value returned by Weight may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | 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. |
| 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. |
| ParentFeature | If this feature has a ParentFeature, then Weight and Polarity are defined with respect to the parent. The effective weight (or polarity) of this feature is its Weight (or Polarity) times the parent's effective weight (or polarity). |
| Polarity | Returns/sets the polarity of this feature. The polarity of a given feature may be -1, 0(undefined), or +1. Polarities of +1 or -1 define where to find brighter pixels relative to the feature geometry, and 0 means undefined. |
| PolarityAdornment | |
| 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. |
| Shape | Returns a reference to the shape object associated with this model feature. The Weight and Polarity are applied to this shape when it is used as a synthetic model. |
| SubFeatureCount | |
| TipText | Text to describe this graphic in a tool tip. |
| Visible | Visible property of this graphic. |
| Weight | Returns/sets the weight of this feature. The weight of a feature determines its relative importance compared to other features of the model. The weight defaults to 1.0. |
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. |
Remarks
A shape model is an object that holds the weight and polarity information that should be applied to a shape (and its subfeatures, if any) when it is used as a synthetic model.
See Also