CogFixtureNPointToNPointTool.ReferenceImage Property

CogFixtureNPointToNPointTool ReferenceImage Property

Cognex VisionPro 9.8 SR1

If it exists, this image will be displayed in the CurrentRecord of the tool. It is for GUI purposes only and will typically be used to hold an application-specific 'reference' image. It is not required for running the tool.

Namespace: Cognex.VisionPro.CalibFix
Assembly: Cognex.VisionPro.CalibFix (in Cognex.VisionPro.CalibFix.dll) Version: 75.0.0.0

Syntax

C++

Copy to Clipboard Print

public ICogImage ReferenceImage { get; set; }

public ICogImage ReferenceImage { get; set; }

Public Property ReferenceImage As ICogImage 
	Get 
	Set

Public Property ReferenceImage As ICogImage 
	Get 
	Set

public:
property ICogImage^ ReferenceImage {
	ICogImage^ get ();
	void set (ICogImage^ value);
}

public:
property ICogImage^ ReferenceImage {
	ICogImage^ get ();
	void set (ICogImage^ value);
}

Property Value

Type: ICogImage

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when the value of this property changes. The following state flag may be affected: SfReferenceImage

Event Type

Reason

ICogChangedEvent Changed

Fires when the value of this property changes.

The following state flag may be affected:

SfReferenceImage

Remarks

If it exists, the reference image will be displayed in the CurrentRecord of the tool. This property is for GUI purposes only and typically holds an application-specific reference image. A user might use the reference image to visually position the desired fixtured space; or other tools might use this image to determine feature locations. However, it is not required for running the tool.

Default Value: NULL