A general contour segment iterator object provides access to all the segment data in the contour.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro CogGeneralContourSegmentIterator
Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 69.0.0.0
Syntax
The CogGeneralContourSegmentIterator type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogGeneralContourSegmentIterator | Constructs a new instance of this class. |
| CogGeneralContourSegmentIterator(IntPtr) | Constructs a new instance of this class using com pointer. |
Methods
| Name | Description | |
|---|---|---|
| Copy | Makes a copy of this iterator. The copy will be positioned at the same item as this plus the given IndexOffset. For example, if IndexOffset is +1 the copy will be positioned at the next item, if IndexOffset is -1, the copy will be at the previous item. |
| 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) | |
| Equals | (Inherited from Object.) |
| Finalize | (Overrides Object Finalize .) |
| 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.) |
| 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.) |
| 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.) |
| 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.) |
| MoveToNext | Moves the iterator to the next position, loading that item's properties into this iterator. If the iterator is at the end position, an error is returned. To avoid getting errors, you may wish to check IsEnd. |
| MoveToPosition | Moves the iterator to the specified position in the sequence, loading that item's properties into this iterator. |
| MoveToPrevious | Moves the iterator to the previous position, loading that item's properties into this iterator. If there are no items before this, an error is returned. To avoid getting errors, you may wish to check IsFirst. |
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | Attributes | Returns property bits describing which iterator methods can be called at the current position of the iterator. |
| Container | Returns a reference to the container object being iterated. This can be used for identifying the iterator's container. |
| CustomPen | Returns/sets the key that refers to the custom pen properties used for drawing this segment. A key of 0 (the default) causes the segment to use the pen properties of the contour. |
| EndAdornmentCustomPen | Returns/sets the custom pen used to draw the adornment at the end point of the segment. |
| EndAngle | Computes the angle (in radians) of the tangent to this segment's shape at the end of the segment. |
| EndFlags | Returns the flags describing the contour's behavior at end point of the segment. |
| EndX | Returns/sets the X coordinate of the end point of the segment. |
| EndY | Returns/sets the Y coordinate of the end point of the segment. |
| IsEnd | Returns True if this iterator is positioned past the last item of the sequence. If True, calling MoveToNext will return an error, and attempting to read item properties will produce an error. Moving the iterator to a valid item will validate it. |
| IsFirst | Returns True if this is the first item. If True, a call to MoveToPrevious would return an error. |
| IsInvalid | Returns True if this iterator is not positioned at a valid item. If True, reading or writing any item properties will produce errors. |
| Length | Computes the length of this segment of the contour. |
| OwnedEllipticalArcSegmentIterator | Gets the full set of elliptical arc segment parameters for this iterator. The parameters are owned by this iterator object, but are conveniently grouped together inside the returned interface. |
| OwnedLineSegmentIterator | Gets the full set of line segment parameters for this iterator. The parameters are owned by this iterator object, but are conveniently grouped together inside the returned interface. |
| Position | Returns the position of the iterator in the container. |
| SegmentType | Returns the type of this segment of the contour. The segment type can be used to choose the most specific iterator to extract all information about the segment. |
| StartAdornmentCustomPen | Returns/sets the custom pen used to draw the adornment at the start point of the segment. |
| StartAngle | Computes the angle (in radians) of the tangent to this segment's shape at the start of the segment. |
| StartFlags | Returns the flags describing the contour's behavior at start point of the segment. |
| StartX | Returns/sets the X coordinate of the start point of the segment. |
| StartY | Returns/sets the Y coordinate of the start point of the segment. |
Remarks
The general contour segment iterator iterates all the segments in a CogGeneralContour, and allows reading and writing of the segment's common properties.
See Also