View.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/View.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// 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_View_h
#define __PCL_View_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/Array.h>
#include <pcl/Histogram.h>
#include <pcl/HistogramTransformation.h>
#include <pcl/ImageVariant.h>
#include <pcl/Property.h>
#include <pcl/UIObject.h>
#include <pcl/Variant.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ImageWindow;
 
// ----------------------------------------------------------------------------
 
// ----------------------------------------------------------------------------
 
namespace ViewPropertyAttribute
{
   enum mask_type
   {
      WriteProtected  = 0x00000001,
      ReadProtected   = 0x00000002,
      Volatile        = 0x00000010,
      Permanent       = 0x00000020,
      NotSerializable = 0x00000040,
      Storable        = 0x00000080,
      Reserved        = 0x10000000,
      Protected       = 0x20000000,
      NoChange        = 0x80000000
   };
}
 
using ViewPropertyAttributes = Flags<ViewPropertyAttribute::mask_type>;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS View : public UIObject
{
public:
 
   using stf_list = Array<HistogramTransformation>;
 
   View() = default;
 
   View( const View& v )
      : UIObject( v )
   {
   }
 
   ~View() override
   {
   }
 
   static View& Null();
 
   bool IsMainView() const;
 
   bool IsPreview() const;
 
   bool IsPartialPreview() const;
 
   bool IsCompletePreview() const;
 
   bool IsVolatilePreview() const;
 
   bool IsStoredPreview() const;
 
   ImageWindow Window() const;
 
   IsoString Id() const;
 
   IsoString FullId() const;
 
   void Rename( const IsoString& newId );
 
   void Rename( const IsoString::ustring_base& newId )
   {
      Rename( IsoString( newId ) );
   }
 
   bool CanRead() const;
 
   bool CanWrite() const;
 
   void Lock( bool notify = true ) const;
 
   void Unlock( bool notify = true ) const;
 
   void LockForWrite( bool notify = true ) const;
 
   /*
    * Unlocks this view for write operations only.
    * ### Undocumented (i.e., harmful) function.
    */
   void UnlockForWrite( bool notify = true ) const;
 
   void UnlockForRead( bool notify = true ) const;
 
   void RelockForRead( bool notify = true ) const;
 
   bool IsDynamicTarget() const;
 
   void AddToDynamicTargets();
 
   void RemoveFromDynamicTargets();
 
   ImageVariant Image() const;
 
   ImageVariant GetImage() const
   {
      return this->Image();
   }
 
   bool IsColor() const;
 
   void GetSize( int& width, int& height ) const;
 
   int Width() const
   {
      int w, dum; GetSize( w, dum ); return w;
   }
 
   int Height() const
   {
      int dum, h; GetSize( dum, h ); return h;
   }
 
   Rect Bounds() const
   {
      int w, h; GetSize( w, h ); return Rect( w, h );
   }
 
   void GetScreenTransferFunctions( stf_list& ) const;
 
   void SetScreenTransferFunctions( const stf_list&, bool notify = true );
 
   void DestroyScreenTransferFunctions( bool notify = true );
 
   bool AreScreenTransferFunctionsEnabled() const;
 
   void EnableScreenTransferFunctions( bool = true, bool notify = true );
 
   void DisableScreenTransferFunctions( bool disable = true, bool notify = true )
   {
      EnableScreenTransferFunctions( !disable, notify );
   }
 
   static bool IsReservedViewPropertyId( const IsoString& id );
 
   PropertyDescriptionArray PropertyDescriptions() const;
 
   PropertyArray Properties() const;
 
   PropertyArray StorableProperties() const;
 
   PropertyArray PermanentProperties() const;
 
   PropertyArray StorablePermanentProperties() const;
 
   void SetProperties( const PropertyArray& properties, bool notify = true,
                       ViewPropertyAttributes attributes = ViewPropertyAttribute::NoChange );
 
   void SetStorableProperties( const PropertyArray& properties, bool notify = true )
   {
      SetProperties( properties, notify,
                     ViewPropertyAttribute::Storable
                   | ViewPropertyAttribute::NoChange );
   }
 
   void SetStorablePermanentProperties( const PropertyArray& properties, bool notify = true )
   {
      SetProperties( properties, notify,
                     ViewPropertyAttribute::Storable
                   | ViewPropertyAttribute::Permanent
                   | ViewPropertyAttribute::NoChange );
   }
 
   Variant PropertyValue( const IsoString& property ) const;
 
   Variant PropertyValue( const IsoString::ustring_base& property ) const
   {
      return PropertyValue( IsoString( property ) );
   }
 
   Variant ComputeProperty( const IsoString& property, bool notify = true );
 
   Variant ComputeProperty( const IsoString::ustring_base& property, bool notify = true )
   {
      return ComputeProperty( IsoString( property ), notify );
   }
 
   template <class S>
   Variant ComputeOrFetchProperty( const S& property, bool notify = true )
   {
      IsoString propertyId( property );
      if ( HasProperty( propertyId ) )
         return PropertyValue( propertyId );
      return ComputeProperty( propertyId, notify );
   }
 
   void SetPropertyValue( const IsoString& property, const Variant& value, bool notify = true,
                          ViewPropertyAttributes attributes = ViewPropertyAttribute::NoChange );
 
   void SetPropertyValue( const IsoString::ustring_base& property, const Variant& value, bool notify = true,
                          ViewPropertyAttributes attributes = ViewPropertyAttribute::NoChange )
   {
      SetPropertyValue( IsoString( property ), value, notify, attributes );
   }
 
   void SetStorablePropertyValue( const IsoString& property, const Variant& value, bool notify = true )
   {
      SetPropertyValue( property, value, notify,
                        ViewPropertyAttribute::Storable
                      | ViewPropertyAttribute::NoChange );
   }
 
   void SetStorablePropertyValue( const IsoString::ustring_base& property, const Variant& value, bool notify = true )
   {
      SetStorablePropertyValue( IsoString( property ), value, notify );
   }
 
   void SetStorablePermanentPropertyValue( const IsoString& property, const Variant& value, bool notify = true )
   {
      SetPropertyValue( property, value, notify,
                        ViewPropertyAttribute::Storable
                      | ViewPropertyAttribute::Permanent
                      | ViewPropertyAttribute::NoChange );
   }
 
   void SetStorablePermanentPropertyValue( const IsoString::ustring_base& property, const Variant& value, bool notify = true )
   {
      SetStorablePropertyValue( IsoString( property ), value, notify );
   }
 
   Variant::data_type PropertyType( const IsoString& property ) const;
 
   Variant::data_type PropertyType( const IsoString::ustring_base& property ) const
   {
      return PropertyType( IsoString( property ) );
   }
 
   ViewPropertyAttributes PropertyAttributes( const IsoString& property ) const;
 
   ViewPropertyAttributes PropertyAttributes( const IsoString::ustring_base& property ) const
   {
      return PropertyAttributes( IsoString( property ) );
   }
 
   void SetPropertyAttributes( const IsoString& property, ViewPropertyAttributes attributes, bool notify = true );
 
   void SetPropertyAttributes( const IsoString::ustring_base& property, ViewPropertyAttributes attributes, bool notify = true )
   {
      SetPropertyAttributes( IsoString( property ), attributes, notify );
   }
 
   bool HasProperty( const IsoString& property ) const;
 
   bool HasProperty( const IsoString::ustring_base& property ) const
   {
      return HasProperty( IsoString( property ) );
   }
 
   void DeleteProperty( const IsoString& property, bool notify = true );
 
   void DeleteProperty( const IsoString::ustring_base& property, bool notify = true )
   {
      DeleteProperty( IsoString( property ), notify );
   }
 
   void DeletePropertyIfExists( const IsoString& property, bool notify = true )
   {
      if ( HasProperty( property ) )
         DeleteProperty( property, notify );
   }
 
   void DeletePropertyIfExists( const IsoString::ustring_base& property, bool notify = true )
   {
      DeletePropertyIfExists( IsoString( property ), notify );
   }
 
   template <class S>
   static bool IsValidViewId( const S& id )
   {
      size_type p = id.Find( "->" );
      if ( p == String::notFound )
         return id.IsValidIdentifier();
      return id.Left( p ).IsValidIdentifier() && id.Substring( p+2 ).IsValidIdentifier();
   }
 
   static View ViewById( const IsoString& fullId );
 
   static View ViewById( const IsoString::ustring_base& fullId )
   {
      return ViewById( IsoString( fullId ) );
   }
 
   static Array<View> AllViews( bool excludePreviews = false );
 
   static Array<View> AllPreviews();
 
protected:
 
   View( void* h ) : UIObject( h )
   {
   }
 
   View( const void* h ) : UIObject( h )
   {
   }
 
   View( std::nullptr_t ) : UIObject( nullptr )
   {
   }
 
   friend class ImageWindow;
   friend class ProcessImplementation; // for LaunchOn()
   friend class ProcessInterface;      // for event broadcasting functions
   friend class ProcessInstance;       // for ExecuteOn() and related functions
   friend class ViewList;
   friend class ViewListEventDispatcher;
   friend class ControlEventDispatcher;
   friend class ProcessContextDispatcher;
   friend class InterfaceDispatcher;
   friend class InternalViewEnumerator;
   friend class InternalPreviewEnumerator;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_View_h
 
// ----------------------------------------------------------------------------
// EOF pcl/View.h - Released 2024-06-18T15:48:54Z