ImageRegionToFloater Method

Summary

Converts the image region to a floater.

Syntax

C++

public virtual bool ImageRegionToFloater()

Public Overridable Function ImageRegionToFloater() As Boolean

public:  
   virtual bool ImageRegionToFloater()

Return Value

true if the floater was created successfully, otherwise; false.

Remarks

This method will return false if the value of Image is null or if the raster image does not have a valid region (the value of HasRegion is false).

Call this method to convert the current region inside RasterImage to a floater. FloaterTransform is automatically updated with values obtained from the region transformation after you call this method. The result image is set in Floater.

This method will not delete the region from Image. If you need to do that, call RasterImage.MakeRegionEmpty after you call this method.

ImageViewerAddRegionInteractiveMode will perform exactly that when the value of AutoRegionToFloater is true.

For more information, refer to Image Viewer Items.

Example

For an example, refer to Floater.

Requirements

Target Platforms