CogMaskGraphic.SetTransparencyMap Method

CogMaskGraphic SetTransparencyMap Method

Cognex VisionPro

Controls transparency of mask values when displayed. The transparency value may be any integer between 0 (fully opaque) and 100 (fully transparent) inclusive.

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

Syntax

C++

Copy to Clipboard Print

public void SetTransparencyMap(
	byte maskVal,
	CogMaskGraphicTransparencyConstants value
)

public void SetTransparencyMap(
	byte maskVal,
	CogMaskGraphicTransparencyConstants value
)

Public Sub SetTransparencyMap ( 
	maskVal As Byte,
	value As CogMaskGraphicTransparencyConstants
)

Public Sub SetTransparencyMap ( 
	maskVal As Byte,
	value As CogMaskGraphicTransparencyConstants
)

public:
void SetTransparencyMap(
	unsigned char maskVal, 
	CogMaskGraphicTransparencyConstants value
)

public:
void SetTransparencyMap(
	unsigned char maskVal, 
	CogMaskGraphicTransparencyConstants value
)

Parameters

maskVal: Type: System Byte
The mask pixel value.

value: Type: Cognex.VisionPro CogMaskGraphicTransparencyConstants

Events

Event Type	Reason
CogMaskGraphic Changed	Fires when the transparency value changes. The following state flag may be affected: SfGetTransparencyMap

Event Type

Reason

CogMaskGraphic Changed

Fires when the transparency value changes.

The following state flag may be affected:

SfGetTransparencyMap

Exceptions

Exception	Condition
ArgumentException	value is not in the range 0 to 100.

Remarks

Controls transparency of mask values when displayed.

The transparency value can be any integer in the range 0 to 100. If the transparency is set to 0 (None), then the mask value is drawn opaque in the color returned by calling GetColorMap(Byte)(maskVal). If the transparency value is 100 (Full), the mask value is completely transparent.

Values between 0 and 100 are color-blended between the color returned by calling GetColorMap(Byte)(maskVal). and the color value at that location under the mask as dictated by graphic z-order.

The predefined transparency constants, None, Half, and Full provide best performance.

Default Value: maskVal = 0 (Don't Care): HalfmaskVal = 1-254 (Tool Specific): HalfmaskVal = 255 (Care): Full