RefreshIfCast Method

Description

Refreshes the image if it is based on another image and that image has changed.

Return Type

None

Syntax

object.RefreshIfCast [lLeft], [lTop], [lRight], [lBottom]

The RefreshIfCast Method syntax has these parts:

Part	Description
object	An expression evaluating to an object of type McRegionAccess.
lLeft	Optional. A Long value. long : Optional. Left side of the block in region-relative coordinates (between 0 and Width-1). The default value of -1 is the same as 0. Out of bounds values are clipped to the bounds.
lTop	Optional. A Long value. long : Optional. Top side of the block in region-relative coordinates (between 0 and Height-1). The default value of -1 is the same as 0. Out of bounds values are clipped to the bounds.
lRight	Optional. A Long value. long : Optional. Right side of the block in region-relative coordinates (between 0 and Width-1). The default value of -1 is the same as Width-1. Out of bounds values are clipped to the bounds.
lBottom	Optional. A Long value. long : Optional. Bottom side of the block in region-relative coordinates (between 0 and Height-1). The default value of -1 is the same as Height-1. Out of bounds values are clipped to the bounds.

Remarks

The coordinate arguments are relative to the McRegionAccess ROI, not the image.

Allows a client to respond to the Image Changed Notification to update this McRegionAccess instance to reflect the changes in the image. This is necessary, because McRegionAccess instances which are cast from the underlying image type (that is, they have a different McImageType) are not automatically refreshed when their base image is changed.

This method has no effect if the McRegionAccess object is directly accessing the base image. If the image being accessed has been cast to an McImageType that is different from the base image, then this method will re-translate the base image pixels.

CAUTION: The Image Changed Notification coordinates are relative to the base image. But methods within McRegionAccess, including this one, take coordinate arguments relative to the sub-region defined in the Initialize method.