CogCNLSearchResult.CreateResultGraphics Method

CogCNLSearchResult CreateResultGraphics Method

Cognex VisionPro 9.7

Creates a composite result graphic containing child graphics specified by the GraphicOptions which is a bitwise combination of CogCNLSearchResultGraphicConstants.

Namespace: Cognex.VisionPro.CNLSearch
Assembly: Cognex.VisionPro.CNLSearch (in Cognex.VisionPro.CNLSearch.dll) Version: 73.0.0.0

Syntax

C++

Copy to Clipboard Print

public CogCompositeShape CreateResultGraphics(
	CogCNLSearchResultGraphicConstants graphicOptions
)

public CogCompositeShape CreateResultGraphics(
	CogCNLSearchResultGraphicConstants graphicOptions
)

Public Function CreateResultGraphics ( 
	graphicOptions As CogCNLSearchResultGraphicConstants
) As CogCompositeShape

Public Function CreateResultGraphics ( 
	graphicOptions As CogCNLSearchResultGraphicConstants
) As CogCompositeShape

public:
CogCompositeShape^ CreateResultGraphics(
	CogCNLSearchResultGraphicConstants graphicOptions
)

public:
CogCompositeShape^ CreateResultGraphics(
	CogCNLSearchResultGraphicConstants graphicOptions
)

Parameters

graphicOptions: Type: Cognex.VisionPro.CNLSearch CogCNLSearchResultGraphicConstants
A value specifying which graphics to create. Must be formed by ORing together one or more values from CogCNLSearchResultGraphicConstants.

Return Value

Type: CogCompositeShape

A CogCompositeShape that contains the requested graphics.

Remarks

Creates a CogCompositeShape that contains child graphics specified by the graphicOptions, which is a bitwise combination of CogCNLSearchResultGraphicConstants. The Interactive property of all the child graphics is set to True. The name space for the returned graphic is the name of the selected space of InputImage at the time the search was performed.

The ID of the graphic is set to the ID of this result. If the result's Accepted property is true, the graphics appear in green; otherwise they appear in red.

The GetKey(Int32) of each child graphic has the same name as the CogCNLSearchResultGraphicConstants bit that it represents. For example, the graphic that depicts the Origin, has the key "Origin".