Floater Property

Summary

Floater image of this item.

Syntax

C++/CLI

public RasterImage Floater { get; set; }

public:  
   property RasterImage^ Floater 
   { 
      RasterImage^ get() 
      void set(RasterImage^ value) 
   }

Property Value

The floater image of this item. Default value is null.

Remarks

The image viewer supports a floater image that can be dragged with the mouse or touch when ImageViewerFloaterInteractiveMode is used.

The floater outline can be rendered or animated using FloaterRegionRenderMode.

The position, scale and rotation of the floater can be manipulated with the FloaterTransform property.

FloaterOpacity can be used to set any opacity value for the floater from completely transparent to fully opaque and in between.

Changing the value of this property will fire the ItemChanged event with ImageViewerItemChangedReason.Floater.

The viewer will subscribe to RasterImage.Changed and automatically perform the necessary updates when the floater image changes externally by other parts of the application.

Floater property of ImageViewer will update this member if this is the active item when the viewer is used in single item mode.

For more information, refer to Image Viewer Items.

Example

using Leadtools; 
using Leadtools.Controls; 
using Leadtools.Codecs; 
using Leadtools.Drawing; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
 
 
public ImageViewerForm _form = new ImageViewerForm(); 
public ImageViewer _imageViewer; 
 
public void ImageViewerFloaterExample() 
{ 
   // Get the Form's ImageViewer control 
   _imageViewer = _form.ImageViewer; 
 
   // Load an image 
   using (var codecs = new RasterCodecs()) 
      _imageViewer.Image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp")); 
 
   ImageViewerItem item = null; 
   RasterImage image = null; 
 
   if (_imageViewer.Items.Count > 0) 
   { 
      item = _imageViewer.Items[0]; 
      image = item.Image; 
   } 
 
   if (image == null) 
   { 
      item.ImageRegionToFloater(); 
      if (item == null) 
         item = _imageViewer.Items.AddFromImage(RasterImage.Create(400, 400, 24, 96, RasterColor.White), 1); 
      else 
         item.Image = RasterImage.Create(400, 400, 24, 96, RasterColor.White); 
   } 
 
   var xForm = RasterRegionXForm.Default; 
   image.AddRectangleToRegion(xForm, new LeadRect(10, 10, 400, 200), RasterRegionCombineMode.Set); 
 
   xForm = RasterRegionXForm.Default; 
   xForm.ViewPerspective = image.ViewPerspective; 
   var rc = image.GetRegionBounds(xForm); 
   var command = new CopyRectangleCommand(rc, RasterMemoryFlags.Conventional); 
   command.Run(image); 
 
   var floater = command.DestinationImage; 
 
   rc = image.RectangleFromImage(RasterViewPerspective.TopLeft, rc); 
 
   if (floater != null) 
   { 
      xForm.ViewPerspective = RasterViewPerspective.TopLeft; 
      xForm.ViewPerspective = RasterViewPerspective.TopLeft; 
      xForm.XOffset = -rc.Left; 
      xForm.YOffset = -rc.Top; 
      _imageViewer.FloaterOpacity = 1.0; 
   } 
 
   item.CombineFloater(null, true); 
   _imageViewer.CombineFloater(false); 
   image.MakeRegionEmpty(); 
   floater.MakeRegionEmpty(); 
 
   item.Floater = floater; 
   var transform = item.FloaterTransform; 
   transform.RotateAt(45, floater.ImageWidth / 2, floater.ImageHeight / 2); 
 
   item.FloaterTransform = transform; 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

Requirements

Target Platforms

Reference

ImageViewerItem Class

ImageViewerItem Members

Leadtools.Controls Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29