Class that represents a mask graphic.
Cognex.Vision ShareableBase
Cognex.Vision ChangedEventShareableBase
Cognex.Vision GraphicInteractiveBase
Cognex.Vision MaskGraphic
Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.22.2.0
The MaskGraphic type exposes the following members.
| Name | Description | |
|---|---|---|
 | MaskGraphic | Constructs a new instance of this class. |
| Name | Description | |
|---|---|---|
| CopyBase | Copy a graphic and its derived parameters. |
| Equals | Compares the equality of this object with another. (Overrides GraphicInteractiveBase Equals(Object).) |
| GetHashCode | Returns the hash code of this object. (Overrides GraphicInteractiveBase GetHashCode .) |
| GetMaskColor | Gets the color and opacity associated with the specified mask pixel value. |
| GetParentFromChildTransform | Gets the parent transform from the child transform. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetTypeMeta | Get the TypeMeta that describes the type of this object. |
| ResumeAndRaiseChangedEvent | Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent 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. |
| SetMaskAlpha | Set just the Alpha component of the color associated with the specified mask value. The Blue, Green, and Red components of that color entry are unchanged. |
| SetMaskBlueGreenRed(Byte, Color32) | Copy the Blue, Green, and Red components of the supplied color argument into the color associated with the specified mask value. The Alpha component of that entry is unchanged. |
| SetMaskBlueGreenRed(Byte, Byte, Byte, Byte) | Set just the Blue, Green, and Red components of the color associated with the specified mask value. The Alpha component of that entry is unchanged. |
| SetMaskColor | Sets the color and opacity associated with the specified mask pixel value. |
| SuspendChangedEvent | Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. |
| ToString | Returns a human readable string that represents the object. |
| Name | Description | |
|---|---|---|
  | Equality | Compares the equality of two MaskGraphic objects. |
| Inequality | Compares the inequality of two MaskGraphic objects. |
| Name | Description | |
|---|---|---|
 | SfGetMaskColor | |
| SfImage | |
| SfOffsetX | |
| SfOffsetY |
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended | Indicates if raising the ChangedEvent has been suspended. |
| 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 the graphic when dragged. |
| DragLineWidthInScreenPixels | Line width of this graphic when dragged. |
| FillColor | The fill color of this graphic. |
| GraphicDOFEnable | Get 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. |
| Handle | (Overrides GraphicInteractiveBase Handle.) |
| Image | Get 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 | Get 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 | Get 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 | Return a reference to the containing tracking collection. May be null. |
| 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 | Get (Overrides GraphicInteractiveBase SelectedSpaceName.)Coordinate space in which this shape is to be interpreted. |
| TipText | Text to describe this graphic in a tool tip. Newline characters can be used to create multi-line tip text. |
| Visible | Visible property of this graphic. |
| Name | Description | |
|---|---|---|
 | Changed | The actual event. |
| Dragging | Raised when an interactive graphic is being dragged. |
| DraggingStopped | Raised after the drag operation of an interactive graphic is complete. |
Class describing a mask graphic. MaskGraphic is used only for displaying image masks. Tools use Image8Grey to define image masks. See, for example, PMAlignPattern, TrainImageMask.