CImage:Shift

CImage:Shift

The Shift method moves the image in the x and y directions. This transformation preserves the world coordinate calibration of the image, if one exists.

Syntax

bResult = CImage:Shift( x, y )

x and y are the shifts and may be numbers or strings.
On success, this method returns true.
On failure, this method returns false.

Remarks

Shifts are considered positive if the image is moved toward increasing x or increasing y. If either of the shifts is a fractional pixel amount, the image is resampled. The image is not resampled if both x and y shifts are integral values.

Example

Suppose an image is displayed in a CImageView named V. The following script fragment shifts the displayed image 10 pixels in x and 20.52 pixels in y:

I = V:GetImage()	-- attach the current displayed image
I:Shift( 10, 20.52 )	-- perform the operation
V:Update()	-- update the display after the shift