CogDisplay.SetImagePanAnchor Method

CogDisplay SetImagePanAnchor Method

Cognex VisionPro 9.8 SR1

Sets the image pan anchor position.

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

Syntax

C++

Copy to Clipboard Print

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

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

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

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

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

public:
virtual void SetImagePanAnchor(
	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 image pan anchor point changes.

Exceptions

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

Remarks

Describes the point in the image that should be moved to the screen anchor when PanX and PanY are set to zero. Stated another way, this is the point in the image from which the pan offsets to the screen anchor are measured.

Ifmethod is Relative, thenx, y are interpreted as percent of the screen size or, in a coordinate space where 0,0 is the upper-leftmost screen border of the display control's window, and 1,1 is the lower right extent of the window. For example, calling PanX=0, PanY=0, SetScreenPanAnchor(0.5, 0.5, VARIANT_TRUE) would always keep the image anchor point centered in the display window, even if the display window is resized.

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

Note: This method will cause the image to redraw.