CogGeneralContour Class

Cognex VisionPro 9.5

A general contour is a shape made up of a series of directed line and arc segments followed in order to go from 'start' to 'end' of the contour. You build the shape by adding segments, giving the geometry and start/end connectivity of each one.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro CogGeneralContour

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

Syntax

C++

Copy to Clipboard Print

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

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

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

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

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

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

The CogGeneralContour type exposes the following members.

Constructors

	Name	Description
	CogGeneralContour	Constructs a new instance of this class.
	CogGeneralContour(IntPtr)	Constructs a new instance of this class using com pointer.
	CogGeneralContour(CogGeneralContour)	Constructs a new instance of this class as a deep copy of the given instance.

Top

Methods

	Name	Description
	AddEllipticalArcSegment	Adds an elliptical arc segment before NextSegment. If NextSegment is Nothing, the new segment is added at the end of the contour. If StartFlags has the 'connected' bit set, then StartX and StartY are ignored. This also applies to EndFlags.
	AddLineSegment	Adds a new line segment before NextSegment. If NextSegment is Nothing, the new segment is added at the end of the contour. If StartFlags has the 'connected' bit set, then StartX and StartY are ignored. This also applies to EndFlags.
	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 general contour, copying the specified parameters of this one.
	CopyBase	Copy a graphic and its derived parameters.
	CreateContourFromConnectedSegments	Returns a new contour, copying all segments in the connected segment chain that includes ContourSegment, into it.
	CreateContourFromSegments	Returns a new contour, copying segments from StartSegment up to, but not including, EndSegment, into it. If EndSegment is Nothing, segments are copied from StartSegment to the end of this contour.
	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.)
	CreateSegmentIterator	Creates an iterator to iterate over the segments in the contour. InitialSegmentIndex is the index of the segment pointed at by the iterator on return. A value of -1 is interpreted as SegmentCount, and will return the 'End' iterator.
	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.)
	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.)
	HighlightRelinquish	Decrement the HighlightRequested reference count, unless it is already zero. If HighlightRequested reaches zero, segment highlighting is disabled.
	HighlightRequest	Enables segment highlighting by incrementing HighlightRequested.
	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	Creates a gcnew CogGeneralContour (copying the specified parameters) by mapping this one 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.)
	MergeContours	Returns a new contour that is the result of merging OtherContour into this before NextSegment. StartFlags and EndFlags control how OtherContour's start and end segments connect to this contour's segments in the merged contour.
	NearestSegment	Returns the segment closest to the given point.
	PathLengthCenterOfMass	Computes the center of mass of the contour as if the mass were uniformly distributed along the segments.
	RemoveSegment	Remove the given ContourSegment, disconnecting any neighboring segments it may be connected to. Returns a new iterator positioned at the segment immediately following the removed one (ContourSegment).
	RemoveSegments	Removes all segments from StartSegment up to, but not including EndSegment, possibly disconnecting at StartSegment's start point, and/or EndSegment's start point. If EndSegment is Nothing, segments are removed from StartSegment to the end.
	ReplaceSegmentWithEllipticalArcSegment	Replaces ReplaceSegment with a new elliptical arc segment. If StartFlags has the 'connected' bit set, then StartX and StartY are ignored. This also applies to EndFlags.
	ReplaceSegmentWithLineSegment	Replaces ReplaceSegment with a new line segment. If StartFlags has the 'connected' bit set, then StartX and StartY are ignored. This also applies to EndFlags.
	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	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfChildren	This bit will be set in the EventArgs of a Changed event every time the value returned by Children may have changed.
	SfClosed	This bit will be set in the EventArgs of a Changed event every time the value returned by Closed 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.
	SfGetPenKey	This bit will be set in the EventArgs of a Changed event every time the value returned by GetPenKey may have changed.
	SfGetPenType	This bit will be set in the EventArgs of a Changed event every time the value returned by GetPenType 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.
	SfHighlightColor	This bit will be set in the EventArgs of a Changed event every time the value returned by HighlightColor may have changed.
	SfHighlightIndex	This bit will be set in the EventArgs of a Changed event every time the value returned by HighlightIndex may have changed.
	SfHighlightRequested	This bit will be set in the EventArgs of a Changed event every time the value returned by HighlightRequested 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.
	SfLength	This bit will be set in the EventArgs of a Changed event every time the value returned by Length 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.
	SfPenCount	This bit will be set in the EventArgs of a Changed event every time the value returned by PenCount may have changed.
	SfSegmentCount	This bit will be set in the EventArgs of a Changed event every time the value returned by SegmentCount 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.
	SfVertexAdornment	This bit will be set in the EventArgs of a Changed event every time the value returned by VertexAdornment 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
	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.
	Closed	True if the contour contains a single connected chain of segments that is closed, otherwise False.
	Color	Color of this graphic. Can be any OLE_COLOR.
	DirectionAdornment	Returns/sets the adornment used to indicate the direction of the contour.
	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.
	HighlightColor	Get or set the color of the segment highlight.
	HighlightIndex	Get or set the index of the segment to be highlighted. If set to -1, no segment highlighting will occur.
	HighlightRequested	If greater than zero, segment highlighting is enabled.
	Interactive	Interactive property allow this graphic object to be selected. See GraphicDOFEnable for information on governing interactive manipulation of an object.
	Length	Computes the sum of the lengths of all segments of the contour.
	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.
	OwnedCustomPens	Gets the set of custom pens used when drawing this contour. The pens are owned by this contour object, but are conveniently grouped together inside the returned interface.
	Parent	Parent of this graphic.
	SegmentCount	Returns the number of segments in this contour.
	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.
	VertexAdornment	Returns/sets the adornment drawn at the vertices of the contour.
	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.
	SegmentAdded	Occurs after a segment is added to the general contour.
	SegmentsChanged	Occurs after a geometric property of one or more segments is changed in the general contour.
	SegmentsRemoved	Occurs after one or more segments are deleted from the general contour.

Top

Remarks

A general contour is a shape made up of a series of directed line and arc segments followed in order to go from the start to the end of the contour. You build the shape by adding segments, giving the geometry and start point and end point connectivity of each one.

For information about manipulating a general contour interactively, see the discussion of general contour shape models.