SVG.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/SVG.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_SVG_h
#define __PCL_SVG_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/ByteArray.h>
#include <pcl/Rectangle.h>
#include <pcl/UIObject.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SVG : public UIObject
{
public:
 
   SVG( const String& filePath, int width = 0, int height = 0 );
 
   SVG( int width = 0, int height = 0 );
 
   ~SVG() override
   {
   }
 
   static SVG& Null();
 
   void GetDimensions( int& width, int& height ) const;
 
   void SetDimensions( int width, int height ) const;
 
   int Width() const
   {
      int w, dum; GetDimensions( w, dum ); return w;
   }
 
   int Height() const
   {
      int dum, h; GetDimensions( dum, h ); return h;
   }
 
   Rect Bounds() const
   {
      int w, h; GetDimensions( w, h ); return Rect( w, h );
   }
 
   DRect ViewBox() const;
 
   void SetViewBox( double x0, double y0, double x1, double y1 );
 
   template <typename T>
   void SetViewBox( const GenericRectangle<T>& r )
   {
      SetViewBox( double( r.x0 ), double( r.y0 ), double( r.x1 ), double( r.y1 ) );
   }
 
   int Resolution() const;
 
   void SetResolution( int r );
 
   String FilePath() const;
 
   ByteArray Data() const;
 
   String Title() const;
 
   void SetTitle( const String& title );
 
   String Description() const;
 
   void SetDescription( const String& desc );
 
   bool IsPainting() const;
 
protected:
 
   SVG( void* h ) : UIObject( h )
   {
   }
 
   void* CloneHandle() const override;
 
   friend class GraphicsContextBase;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_SVG_h
 
// ----------------------------------------------------------------------------
// EOF pcl/SVG.h - Released 2024-06-18T15:48:54Z