CombineFloater Method

Summary

Combines the floaters with the images for all items inside this ImageViewer

Syntax

C++

public virtual void CombineFloater( 
   bool deleteFloater 
)

Public Overridable Sub CombineFloater( 
   ByVal deleteFloater As Boolean 
)

public:  
   virtual void CombineFloater( 
      bool deleteFloater 
   )

Parameters

deleteFloater

true to automatically delete the floater image from the item after combining, otherwise; false.

Remarks

This method will loop through all the items inside this ImageViewer and check if any has a floater image (the value of ImageViewerItem.Floater is not null) that is visible (the value of ImageViewerItem.FloaterOpacity is not 0). If so, it will try to combine this floater with the item images using ImageViewerItem.CombineFloater.

The floater transformation (position, scale and rotation value) is stored in ImageViewerItem.FloaterTransform for each item and this method will use this value during the combine operation.

The floater transformation might result in it being layered on top of more than one item (its original or other) and this method will combine the floater with all the items that intersect with the final floater position and size.

Example

For an example, refer to ImageViewerItem.Floater.

Requirements

Target Platforms