ImageWindow.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.11
// ----------------------------------------------------------------------------
// pcl/ImageWindow.h - Released 2024-05-07T15:27:32Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_ImageWindow_h
#define __PCL_ImageWindow_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Flags.h>
#include <pcl/ImageRenderingModes.h>
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Bitmap.h>
#include <pcl/ByteArray.h>
#include <pcl/FITSHeaderKeyword.h>
#include <pcl/ImageOptions.h>
#include <pcl/UIObject.h>
#include <pcl/View.h>
 
#endif   // !__PCL_BUILDING_PIXINSIGHT_APPLICATION
 
namespace pcl
{
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
class RGBColorSystem;
class ICCProfile;
class ProcessInterface;
 
#endif   // !__PCL_BUILDING_PIXINSIGHT_APPLICATION
 
// ----------------------------------------------------------------------------
 
namespace ImageMode
{
   enum value_type
   {
      Invalid  = -1,    // Represents an invalid or unsupported mode
      Readout  = 0,     // Default mode, click to get real-time readouts
      ZoomIn,           // Click to zoom in the current view
      ZoomOut,          // Click to zoom out the current view
      Pan,              // Click and drag to pan the current view
      Center,           // Click to center the view at the mouse position
      NewPreview,       // Click and drag to define a new preview
      EditPreview,      // Click and drag to change an existing preview
      DynamicOperation, // Module-defined dynamic operation
 
      NumberOfModes,
 
      Default = Readout
   };
 
   inline bool IsValidPreviewMode( value_type m )
   {
      return m != NewPreview && m != EditPreview;
   }
 
   inline bool IsValidMainViewMode( value_type m )
   {
      return !IsValidPreviewMode( m );
   }
}
 
// ----------------------------------------------------------------------------
 
namespace BackgroundBrush
{
   enum value_type
   {
      Small,               // Small chessboard pattern
      Medium,              // Medium chessboard pattern
      Large,               // Large chessboard pattern
      SmallCrossPattern,   // Small cross pattern
      MediumCrossPattern,  // Medium cross pattern
      LargeCrossPattern,   // Large cross pattern
      SmallDiagPattern,    // Small diagonal pattern
      MediumDiagPattern,   // Medium diagonal pattern
      LargeDiagPattern,    // Large diagonal pattern
      Solid,               // Solid brush with the foreground color
 
      NumberOfBrushes,
 
      Default = Small
   };
}
 
// ----------------------------------------------------------------------------
 
namespace TransparencyMode
{
   enum value_type
   {
      Hide,                // Don't show transparencies
      BackgroundBrush,     // Use the transparency background brush
      Color,               // Use an opaque background color
 
      NumberOfModes,
 
      Default = BackgroundBrush
   };
};
 
// ----------------------------------------------------------------------------
 
namespace UndoFlag
{
   /*
    * ### TODO: PCL 2.x: Get rid of all project depencies on UndoFlags.
    */
   enum mask_type
   {
      DefaultMode             = 0x00000000,  // Save pixel data, astrometric solution and previews
      PixelData               = 0x00000001,  // Save pixel data
      RGBWS                   = 0x00000002,  // RGB Working Space data
      ICCProfile              = 0x00000004,  // ICC profile
      Keywords                = 0x00000008,  // %FITS keywords
    //Metadata                = 0x00000010,  // ### DEPRECATED - Keep unused for now, for compatibility with existing projects
      FormatData              = 0x00000020,  // Format-specific data
      ImageId                 = 0x00000040,  // %Image identifier
      Resolution              = 0x00000080,  // %Image resolution
      AstrometricSolution     = 0x00000100,  // Save the current astrometric solution
      All                     = 0x000FFFFF,  // Save all data items
      DeletePropertiesOnEntry = 0x01000000,  // Destroy/delete non-permanent view properties before execution
      DeletePropertiesOnExit  = 0x02000000,  // Destroy/delete non-permanent view properties after execution
      ExcludePreviews         = 0x80000000,  // Don't save state of previews
      ExcludeMaskRelations    = 0x40000000   // Don't save masking dependencies
   };
}
 
using UndoFlags = Flags<UndoFlag::mask_type>;
 
// ----------------------------------------------------------------------------
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ImageWindow : public UIObject
{
public:
 
   using gui_mode = ImageMode::value_type;
 
   using display_channel = DisplayChannel::value_type;
 
   using mask_mode = MaskMode::value_type;
 
   using background_brush = BackgroundBrush::value_type;
 
   using transparency_mode = TransparencyMode::value_type;
 
   ImageWindow() = default;
 
   ImageWindow( int width, int height, int numberOfChannels = 1,
                int bitsPerSample = 32, bool floatSample = true, bool color = false,
                bool initialProcessing = true,
                const IsoString& id = IsoString() );
 
   ImageWindow( int width, int height, int numberOfChannels,
                int bitsPerSample, bool floatSample, bool color,
                bool initialProcessing,
                const IsoString::ustring_base& id )
      : ImageWindow( width, height, numberOfChannels,
                     bitsPerSample, floatSample, color,
                     initialProcessing,
                     IsoString( id ) )
   {
   }
 
   ImageWindow( const ImageWindow& w )
      : UIObject( w )
   {
   }
 
   ImageWindow( ImageWindow&& x )
      : UIObject( std::move( x ) )
   {
   }
 
   ~ImageWindow() override
   {
   }
 
   ImageWindow& operator =( const ImageWindow& window )
   {
      Assign( window );
      return *this;
   }
 
   ImageWindow& operator =( ImageWindow&& x )
   {
      Transfer( x );
      return *this;
   }
 
   static ImageWindow& Null();
 
   static Array<ImageWindow> Open( const String& url,
                                   const IsoString& id = IsoString(),
                                   const IsoString& formatHints = IsoString(),
                                   bool asCopy = false,
                                   bool allowMessages = true );
 
   template <class S1, class S2>
   static Array<ImageWindow> Open( const String& url,
                                   const S1& id,
                                   const S2& formatHints,
                                   bool asCopy = false,
                                   bool allowMessages = true )
   {
      return Open( url, IsoString( id ), IsoString( formatHints ), asCopy, allowMessages );
   }
 
   bool IsNew() const;
 
   bool IsACopy() const;
 
   String FilePath() const;
 
   String FileURL() const;
 
   bool HasURL() const
   {
      return !FileURL().IsEmpty();
   }
 
   ImageOptions FileInfo() const;
 
   size_type ModifyCount() const;
 
   bool IsModified() const
   {
      return ModifyCount() > 0;
   }
 
   bool Close();
 
   void ForceClose();
 
   View MainView() const;
 
   View CurrentView() const;
 
   void SelectView( View& );
 
   void SelectMainView()
   {
      View v( MainView() ); SelectView( v );
   }
 
   void PurgeProperties();
 
   bool IsValidView( const View& ) const;
 
   int NumberOfPreviews() const;
 
   bool HasPreviews() const
   {
      return NumberOfPreviews() > 0;
   }
 
   Array<View> Previews() const;
 
   View PreviewById( const IsoString& previewId ) const;
 
   View PreviewById( const IsoString::ustring_base& previewId ) const
   {
      return PreviewById( IsoString( previewId ) );
   }
 
   bool PreviewExists( const IsoString& previewId ) const
   {
      return !IsNull() && !PreviewById( previewId ).IsNull();
   }
 
   bool PreviewExists( const IsoString::ustring_base& previewId ) const
   {
      return PreviewExists( IsoString( previewId ) );
   }
 
   View SelectedPreview() const;
 
   void SelectPreview( View& );
 
   void SelectPreview( const IsoString& previewId )
   {
      View v( PreviewById( previewId ) ), SelectPreview( v );
   }
 
   void SelectPreview( const IsoString::ustring_base& previewId )
   {
      SelectPreview( IsoString( previewId ) );
   }
 
   View CreatePreview( const Rect& r, const IsoString& previewId = IsoString() )
   {
      return CreatePreview( r.x0, r.y0, r.x1, r.y1, previewId );
   }
 
   View CreatePreview( const Rect& r, const IsoString::ustring_base& previewId )
   {
      return CreatePreview( r, IsoString( previewId ) );
   }
 
   View CreatePreview( int x0, int y0, int x1, int y1, const IsoString& previewId = IsoString() );
 
   View CreatePreview( int x0, int y0, int x1, int y1, const IsoString::ustring_base& previewId )
   {
      return CreatePreview( x0, y0, x1, y1, IsoString( previewId ) );
   }
 
   void ModifyPreview( const IsoString& previewId, const Rect& r, const IsoString& newId = IsoString() )
   {
      ModifyPreview( previewId, r.x0, r.y0, r.x1, r.y1, newId );
   }
 
   void ModifyPreview( const IsoString::ustring_base& previewId, const Rect& r )
   {
      ModifyPreview( IsoString( previewId ), r );
   }
 
   void ModifyPreview( const IsoString::ustring_base& previewId, const Rect& r, const IsoString::ustring_base& newId )
   {
      ModifyPreview( IsoString( previewId ), r, IsoString( newId ) );
   }
 
   void ModifyPreview( const IsoString& previewId, int x0, int y0, int x1, int y1,
                       const IsoString& newId = IsoString() );
 
   void ModifyPreview( const IsoString::ustring_base& previewId, int x0, int y0, int x1, int y1 )
   {
      ModifyPreview( IsoString( previewId ), x0, y0, x1, y1 );
   }
 
   void ModifyPreview( const IsoString::ustring_base& previewId, int x0, int y0, int x1, int y1,
                       const IsoString::ustring_base& newId )
   {
      ModifyPreview( IsoString( previewId ), x0, y0, x1, y1, IsoString( newId ) );
   }
 
   Rect PreviewRect( const IsoString& previewId ) const;
 
   Rect PreviewRect( const IsoString::ustring_base& previewId ) const
   {
      return PreviewRect( IsoString( previewId ) );
   }
 
   void DeletePreview( const IsoString& previewId );
 
   void DeletePreview( const IsoString::ustring_base& previewId )
   {
      DeletePreview( IsoString( previewId ) );
   }
 
   void DeletePreviews();
 
   void GetSampleFormat( int& bitsPerSample, bool& floatSample ) const;
 
   void SetSampleFormat( int bitsPerSample, bool floatSample );
 
   ImageWindow Mask() const;
 
   void SetMask( ImageWindow& w, bool inverted = false );
 
   void RemoveMask()
   {
      SetMask( Null() );
   }
 
   bool IsMaskInverted() const;
 
   void InvertMask( bool invert = true )
   {
      ImageWindow mask = Mask();
      SetMask( mask, invert );
   }
 
   bool IsMaskEnabled() const;
 
   void EnableMask( bool = true );
 
   void DisableMask( bool disable = true )
   {
      EnableMask( !disable );
   }
 
   bool IsMaskVisible() const;
 
   void ShowMask( bool = true );
 
   void HideMask( bool hide = true )
   {
      ShowMask( !hide );
   }
 
   bool IsMaskCompatible( const ImageWindow& );
 
   bool HasMaskReferences() const;
 
   void RemoveMaskReferences();
 
   void UpdateMaskReferences();
 
   void GetRGBWS( RGBColorSystem& rgbws ) const;
 
   void SetRGBWS( const RGBColorSystem& rgbws );
 
   bool UsingGlobalRGBWS() const;
 
   void UseGlobalRGBWS();
 
   static void GetGlobalRGBWS( RGBColorSystem& rgbws );
 
   static void SetGlobalRGBWS( const RGBColorSystem& rgbws );
 
   bool IsColorManagementEnabled() const;
 
   void EnableColorManagement( bool = true );
 
   void DisableColorManagement( bool disable = true )
   {
      EnableColorManagement( !disable );
   }
 
   bool IsProofingEnabled() const;
 
   void EnableProofing( bool = true );
 
   void DisableProofing( bool disable = true )
   {
      EnableProofing( !disable );
   }
 
   bool IsGamutCheckEnabled() const;
 
   void EnableGamutCheck( bool = true );
 
   void DisableGamutCheck( bool disable = true )
   {
      EnableGamutCheck( !disable );
   }
 
   void SetColorManagementFeatures( bool cmEnabled, bool proofing, bool gamutCheck );
 
   bool GetICCProfile( ICCProfile& icc ) const;
 
   void SetICCProfile( const ICCProfile& icc );
 
   void SetICCProfile( const String& filePath );
 
   void DeleteICCProfile();
 
   FITSKeywordArray Keywords() const;
 
   bool GetKeywords( FITSKeywordArray& keywords ) const
   {
      keywords = Keywords();
      return !keywords.IsEmpty();
   }
 
   void SetKeywords( const FITSKeywordArray& keywords );
 
   void ResetKeywords();
 
   bool HasAstrometricSolution() const;
 
   bool RegenerateAstrometricSolution( bool allowGUIMessages = true, bool notify = true );
 
   bool CopyAstrometricSolution( const ImageWindow& source, bool notify = true );
 
   void ClearAstrometricSolution( bool notify = true );
 
   void UpdateAstrometryMetadata( bool notify = true );
 
   bool ImageToCelestial( double& x, double& y, bool rawRA = false ) const;
 
   template <typename T>
   bool ImageToCelestial( DPoint& pRD, const GenericPoint<T>& pI, bool rawRA = false ) const
   {
      DPoint qI( double( pI.x ), double( pI.y ) );
      if ( ImageToCelestial( qI.x, qI.y, rawRA ) )
      {
         pRD = qI;
         return true;
      }
      return false;
   }
 
   bool CelestialToImage( double& ra, double& dec ) const;
 
   bool CelestialToImage( DPoint& pI, const DPoint& pRD ) const
   {
      DPoint qI = pRD;
      if ( CelestialToImage( qI.x, qI.y ) )
      {
         pI = qI;
         return true;
      }
      return false;
   }
 
   void GetResolution( double& xRes, double& yRes, bool& metric ) const;
 
   void SetResolution( double xRes, double yRes, bool metric = false );
 
   void SetResolution( double r, bool metric = false )
   {
      SetResolution( r, r, metric );
   }
 
   static void GetDefaultResolution( double& xRes, double& yRes, bool& metric );
 
   static bool IsDefaultICCProfileEmbeddingEnabledForRGBImages();
 
   static bool IsDefaultICCProfileEmbeddingEnabledForGrayscaleImages();
 
   static bool IsDefaultThumbnailEmbeddingEnabled();
 
   static bool IsDefaultPropertiesEmbeddingEnabled();
 
   static StringList SwapDirectories();
 
   static bool SetSwapDirectories( const StringList& directories );
 
   static int CursorTolerance();
 
   static gui_mode CurrentMode();
 
   static void SelectMode( gui_mode mode );
 
   display_channel CurrentChannel() const;
 
   bool IsAlphaChannelDisplayed() const
   {
      return CurrentChannel() >= DisplayChannel::Alpha;
   }
 
   int CurrentAlphaChannel() const
   {
      return CurrentChannel() - DisplayChannel::Alpha;
   }
 
   void SelectChannel( display_channel c );
 
   mask_mode MaskMode() const;
 
   void SetMaskMode( mask_mode mode );
 
   static background_brush GetBackgroundBrush( uint32& fgColor, uint32& bgColor );
 
   static void SetBackgroundBrush( background_brush brush, uint32 fgColor = 0, uint32 bgColor = 0 );
 
   transparency_mode TransparencyMode() const;
 
   RGBA TransparencyColor() const;
 
   bool IsTransparencyVisible() const
   {
      return TransparencyMode() != pcl::TransparencyMode::Hide;
   }
 
   void SetTransparencyMode( transparency_mode mode, RGBA color = 0 );
 
   void HideTransparency()
   {
      SetTransparencyMode( pcl::TransparencyMode::Hide );
   }
 
   void SetViewport( double cx, double cy, int zoom = 0 );
 
   void SetViewport( const DPoint& center, int zoom = 0 )
   {
      SetViewport( center.x, center.y, zoom );
   }
 
   void FitWindow();
 
   void ZoomToFit( bool optimalFit = true,
                   bool allowMagnification = true,
                   bool allowAnimations = true,
                   bool noLimits = false );
 
   int ZoomFactor() const;
 
   void SetZoomFactor( int z );
 
   void ZoomIn()
   {
      int z = ZoomFactor() + 1;
      SetZoomFactor( (z > 0) ? z : +1 );
   }
 
   void ZoomOut()
   {
      int z = ZoomFactor() - 1;
      SetZoomFactor( (z > 0 || z < -1) ? z : -2 );
   }
 
   void GetViewportSize( int& width, int& height ) const;
 
   int ViewportWidth() const
   {
      int w, dum;
      GetViewportSize( w, dum );
      return w;
   }
 
   int ViewportHeight() const
   {
      int dum, h;
      GetViewportSize( dum, h );
      return h;
   }
 
   Point ViewportPosition() const;
 
   void SetViewportPosition( int x, int y );
 
   void SetViewportPosition( const Point& p )
   {
      SetViewportPosition( p.x, p.y );
   }
 
   Rect VisibleViewportRect() const;
 
   int VisibleViewportWidth() const
   {
      return VisibleViewportRect().Width();
   }
 
   int VisibleViewportHeight() const
   {
      return VisibleViewportRect().Height();
   }
 
   bool IsVisible() const;
 
   void Show( bool fitWindow = true );
 
   void Hide();
 
   bool IsIconic() const;
 
   void Iconize();
 
   void Deiconize();
 
   void BringToFront();
 
   void SendToBack();
 
   static bool IsDynamicSessionActive();
 
   static ProcessInterface* ActiveDynamicInterface();
 
   static bool TerminateDynamicSession( bool closeInterface = true );
 
   void SetDynamicCursor( const char** xpm, int hx = 0, int hy = 0 );
 
   void SetDynamicCursor( const char** xpm, const Point& p )
   {
      SetDynamicCursor( xpm, p.x, p.y );
   }
 
   void SetDynamicCursor( const Bitmap& bmp, int hx = 0, int hy = 0 );
 
   void SetDynamicCursor( const Bitmap& bmp, const Point& p )
   {
      SetDynamicCursor( bmp, p.x, p.y );
   }
 
   void ResetDynamicCursor()
   {
      SetDynamicCursor( Bitmap::Null() );
   }
 
   Bitmap DynamicCursorBitmap() const;
 
   Point DynamicCursorHotSpot() const;
 
   double DisplayPixelRatio() const;
 
   void ViewportToImage( int& x, int& y ) const;
 
   void ViewportToImage( double& x, double& y ) const;
 
   template <typename T>
   DPoint ViewportToImage( const GenericPoint<T>& p ) const
   {
      DPoint p1 = p;
      ViewportToImage( p1.x, p1.y );
      return p1;
   }
 
   template <typename T>
   DRect ViewportToImage( const GenericRectangle<T>& r ) const
   {
      DRect r1 = r;
      ViewportToImage( r1.x0, r1.y0 );
      ViewportToImage( r1.x1, r1.y1 );
      return r1;
   }
 
   void ViewportToImage( Point* p, size_type n ) const;
 
   void ViewportToImage( DPoint* p, size_type n ) const;
 
   template <typename T>
   void ViewportToImage( Array<GenericPoint<T> >& a ) const
   {
      ViewportToImage( a.Begin(), a.Length() );
   }
 
   void ViewportScalarToImage( int* d, size_type n ) const;
 
   void ViewportScalarToImage( double* d, size_type n ) const;
 
   double ViewportScalarToImage( double d ) const;
 
   template <typename T>
   double ViewportScalarToImage( T d ) const
   {
      return ViewportScalarToImage( double( d ) );
   }
 
   void ImageToViewport( int& x, int& y ) const;
 
   void ImageToViewport( double& x, double& y ) const;
 
   template <typename T>
   GenericPoint<T> ImageToViewport( const GenericPoint<T>& p ) const
   {
      GenericPoint<T> p1 = p;
      ImageToViewport( p1.x, p1.y );
      return p1;
   }
 
   template <typename T>
   GenericRectangle<T> ImageToViewport( const GenericRectangle<T>& r ) const
   {
      GenericRectangle<T> r1 = r;
      ImageToViewport( r1.x0, r1.y0 );
      ImageToViewport( r1.x1, r1.y1 );
      return r1;
   }
 
   void ImageToViewport( Point* p, size_type n ) const;
 
   void ImageToViewport( DPoint* p, size_type n ) const;
 
   template <typename T>
   void ImageToViewport( Array<GenericPoint<T> >& a ) const
   {
      ImageToViewport( a.Begin(), a.Length() );
   }
 
   void ImageScalarToViewport( int* d, size_type n ) const;
 
   void ImageScalarToViewport( double* d, size_type n ) const;
 
   int ImageScalarToViewport( int ) const;
 
   double ImageScalarToViewport( double ) const;
 
   void ViewportToGlobal( int& x, int& y ) const;
 
   Point ViewportToGlobal( const Point& p ) const
   {
      Point p1 = p;
      ViewportToGlobal( p1.x, p1.y );
      return p1;
   }
 
   Rect ViewportToGlobal( const Rect& r ) const
   {
      Rect r1 = r;
      ViewportToGlobal( r1.x0, r1.y0 );
      ViewportToGlobal( r1.x1, r1.y1 );
      return r1;
   }
 
   void GlobalToViewport( int& x, int& y ) const;
 
   Point GlobalToViewport( const Point& p ) const
   {
      Point p1 = p;
      GlobalToViewport( p1.x, p1.y );
      return p1;
   }
 
   Rect GlobalToViewport( const Rect& r ) const
   {
      Rect r1 = r;
      GlobalToViewport( r1.x0, r1.y0 );
      GlobalToViewport( r1.x1, r1.y1 );
      return r1;
   }
 
   void Reset()
   {
      SetZoomFactor( ZoomFactor() );
   }
 
   void Regenerate();
 
   void RegenerateViewportRect( const Rect& r )
   {
      RegenerateViewportRect( r.x0, r.y0, r.x1, r.y1 );
   }
 
   void RegenerateViewportRect( int x0, int y0, int x1, int y1 );
 
   void RegenerateImageRect( const pcl::DRect& r )
   {
      RegenerateImageRect( r.x0, r.y0, r.x1, r.y1 );
   }
 
   void RegenerateImageRect( double x0, double y0, double x1, double y1 );
 
   void UpdateViewport();
 
   void UpdateViewportRect( const Rect& r )
   {
      UpdateViewportRect( r.x0, r.y0, r.x1, r.y1 );
   }
 
   void UpdateViewportRect( int x0, int y0, int x1, int y1 );
 
   void UpdateImageRect( const pcl::DRect& r )
   {
      UpdateImageRect( r.x0, r.y0, r.x1, r.y1 );
   }
 
   void UpdateImageRect( double x0, double y0, double x1, double y1 );
 
   bool HasPendingUpdates() const;
 
   void CommitPendingUpdates();
 
   Rect ViewportUpdateRect() const;
 
   Bitmap ViewportBitmap( const Rect& r, uint32 flags = 0 ) const
   {
      return ViewportBitmap( r.x0, r.y0, r.x1, r.y1, flags );
   }
 
   Bitmap ViewportBitmap( int x0, int y0, int x1, int y1, uint32 flags = 0 ) const;
 
   void BeginSelection( const Point& p, uint32 flags = 0 )
   {
      BeginSelection( p.x, p.y, flags );
   }
 
   void BeginSelection( int x, int y, uint32 flags = 0 );
 
   void ModifySelection( const Point& p, uint32 flags = 0 )
   {
      ModifySelection( p.x, p.y, flags );
   }
 
   void ModifySelection( int x, int y, uint32 flags = 0 );
 
   void UpdateSelection();
 
   void CancelSelection();
 
   void EndSelection();
 
   Rect SelectionRect( uint32* flags = nullptr ) const;
 
   bool IsSelection() const;
 
   static ImageWindow WindowById( const IsoString& id );
 
   static ImageWindow WindowById( const IsoString::ustring_base& id )
   {
      return WindowById( IsoString( id ) );
   }
 
   static ImageWindow WindowByFilePath( const String& filePath );
 
   static ImageWindow ActiveWindow();
 
   static Array<ImageWindow> AllWindows( bool includeIconicWindows = true );
 
private:
 
   ImageWindow( void* h ) : UIObject( h )
   {
   }
 
   friend class View;
   friend class ProcessInstance; // for IsMaskable()
   friend class ProcessContextDispatcher;
   friend class InternalWindowEnumerator;
};
 
// ----------------------------------------------------------------------------
 
#endif   // !__PCL_BUILDING_PIXINSIGHT_APPLICATION
 
} // pcl
 
#endif   // __PCL_ImageWindow_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ImageWindow.h - Released 2024-05-07T15:27:32Z