CogDisplay.SetScreenPanAnchor Method

CogDisplay SetScreenPanAnchor Method

Cognex VisionPro 9.7

Sets the screen pan anchor position.

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

Syntax

C++

Copy to Clipboard Print

public virtual void SetScreenPanAnchor(
	double x,
	double y,
	CogDisplayPanAnchorConstants method
)

public virtual void SetScreenPanAnchor(
	double x,
	double y,
	CogDisplayPanAnchorConstants method
)

Public Overridable Sub SetScreenPanAnchor ( 
	x As Double,
	y As Double,
	method As CogDisplayPanAnchorConstants
)

Public Overridable Sub SetScreenPanAnchor ( 
	x As Double,
	y As Double,
	method As CogDisplayPanAnchorConstants
)

public:
virtual void SetScreenPanAnchor(
	double x, 
	double y, 
	CogDisplayPanAnchorConstants method
)

public:
virtual void SetScreenPanAnchor(
	double x, 
	double y, 
	CogDisplayPanAnchorConstants method
)

Parameters

x: Type: System Double
The x-coordinate of the pan anchor.

y: Type: System Double
The y-coordinate of the pan anchor.

method: Type: Cognex.VisionPro.Display CogDisplayPanAnchorConstants
How the pan distance is computed.

Events

Event Type	Reason
CogDisplay Changed	Fires when the screen pan anchor point changes.

Exceptions

Exception	Condition
AxHost InvalidActiveXStateException	Thrown when the display control is invalid.

Remarks

The image pan anchor is the center of the display control's display area for the purposes of image panning. When you specify a value for PanX or PanY you are specifying a distance between the image pan anchor point and the screen pan anchor point.

When method is Relative, the values of x and y are in the range 0.0 to 1.0. The point (0,0) is the top left of the display and the point (1,1) is the bottom right of the display.

When method is Absolute, the values of x and y are absolute coordinate values.