CogMaskGraphic Class

Cognex VisionPro

Class that represents a mask graphic.

Inheritance Hierarchy

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

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

Syntax

C++

Copy to Clipboard Print

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

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

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

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

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

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

The CogMaskGraphic type exposes the following members.

Constructors

	Name	Description
	CogMaskGraphic	Constructs a new instance of this class.
	CogMaskGraphic(IntPtr)	Constructs a new instance of this class using com pointer.
	CogMaskGraphic(CogMaskGraphic)	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
	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.)
	Dispose
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (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.)
	GetColorMap	Controls color of mask pixel values when displayed.
	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.)
	GetTransparencyMap	Controls transparency of mask values when displayed. The transparency value may be any integer between 0 (fully opaque) and 100 (fully transparent) inclusive.
	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.)
	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.
	SetColorMap	Controls color of mask pixel values when displayed.
	SetTransparencyMap	Controls transparency of mask values when displayed. The transparency value may be any integer between 0 (fully opaque) and 100 (fully transparent) inclusive.
	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.
	SfColor	This bit will be set in the EventArgs of a Changed event every time the value returned by Color 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.
	SfGetColorMap	This bit will be set in the EventArgs of a Changed event every time the value returned by GetColorMap may have changed.
	SfGetTransparencyMap	This bit will be set in the EventArgs of a Changed event every time the value returned by GetTransparencyMap 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.
	SfImage	This bit will be set in the EventArgs of a Changed event every time the value returned by Image 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.
	SfOffsetX	This bit will be set in the EventArgs of a Changed event every time the value returned by OffsetX may have changed.
	SfOffsetY	This bit will be set in the EventArgs of a Changed event every time the value returned by OffsetY 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.
	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.

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.
	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.
	Image	Image containing mask data. Only pixel data and Width and Height are used in building mask graphic.
	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.
	OffsetX	The X position, in pixel coordinates, of the upper left corner of the mask image. The X,Y offset controls where the mask graphic will be overlaid on a displayed image.
	OffsetY	The Y position, in pixel coordinates, of the upper left corner of the mask image. The X,Y offset controls where the mask graphic will be overlaid on a displayed image.
	Parent	Parent of this graphic.
	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.

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

Interface describing a mask graphic.

CogMaskGraphic is used only for displaying image masks. Tools use CogImage8Grey to define image masks. See, for example, CogPMAlignPattern.TrainImageMask and CogCNLSearchPattern.TrainImageMask.