Brush.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/Brush.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_Brush_h
#define __PCL_Brush_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/Color.h>
#include <pcl/Rectangle.h>
#include <pcl/UIObject.h>
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace BrushStyle
{
   enum value_type
   {
      Empty,                  // empty brush (transparent brush)
      Solid,                  // solid brush
      Dense,                  // dense pattern brush
      HalfTone,               // 50% pattern brush
      Sparse,                 // sparse pattern brush
      HorzizontalHatch,       // -----
      VerticalHatch,          // |||||
      CrossHatch,             // +++++
      ForwardDiagonalHatch,   // /////
      BackwardDiagonalHatch,  // \\\\\. <--- why this dot? :)
      CrossDiagonalHatch,     // XXXXX
      Stipple,                // fill with a tiled Bitmap
      LinearGradient,         // fill with a linear gradient
      RadialGradient,         // fill with a radial gradient
      ConicalGradient,        // fill with a conical gradient
 
      NumberOfBrushStyles
   };
}
 
namespace GradientSpreadMode
{
   enum value_type
   {
      Pad,
      Reflect,
      Repeat,
 
      NumberOfGradientSpreadModes
   };
}
 
// ----------------------------------------------------------------------------
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
class PCL_CLASS Bitmap;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Brush : public UIObject
{
public:
 
   using style = BrushStyle::value_type;
 
   Brush( RGBA color = 0xff000000, style = BrushStyle::Solid );
 
   Brush( const Bitmap& bmp );
 
   Brush( const Brush& b )
      : UIObject( b )
   {
   }
 
   Brush( Brush&& x )
      : UIObject( std::move( x ) )
   {
   }
 
   ~Brush() override
   {
   }
 
   Brush& operator =( const Brush& b )
   {
      Assign( b );
      return *this;
   }
 
   Brush& operator =( Brush&& x )
   {
      Transfer( x );
      return *this;
   }
 
   static Brush& Null();
 
   RGBA Color() const;
 
   void SetColor( RGBA );
 
   style Style() const;
 
   bool IsSolid() const
   {
      return Style() == BrushStyle::Solid;
   }
 
   bool IsEmpty() const
   {
      return Style() == BrushStyle::Empty;
   }
 
   bool IsTransparent() const
   {
      return IsEmpty();
   }
 
   bool IsStippled() const
   {
      return Style() == BrushStyle::Stipple;
   }
 
   void SetStyle( style );
 
   Bitmap Stipple() const;
 
   void SetStipple( const Bitmap& );
 
   virtual bool IsGradient() const
   {
      return false;
   }
 
private:
 
   Brush( void* h ) : UIObject( h )
   {
   }
 
   void* CloneHandle() const override;
 
   friend class GraphicsContextBase;
   friend class Graphics;
   friend class VectorGraphics;
   friend class GradientBrush;
   friend class Pen;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS GradientBrush : public Brush
{
public:
 
   using spread_mode = GradientSpreadMode::value_type;
 
   struct Stop
   {
      double position = 0;       
      RGBA   color = 0xff000000; 
 
      Stop() = default;
 
      Stop( double p, RGBA c )
         : position( Range( p, 0.0, 1.0 ) )
         , color( c )
      {
      }
 
      Stop( const Stop& ) = default;
 
      bool operator ==( const Stop& x ) const
      {
         return position == x.position && color == x.color;
      }
 
      bool operator <( const Stop& x ) const
      {
         return position < x.position; // color is irrelevant to ordering of gradient stops
      }
   };
 
   using stop_list = Array<Stop>;
 
   stop_list Stops() const;
 
   spread_mode SpreadMode() const;
 
   bool IsGradient() const override
   {
      return true;
   }
 
protected:
 
   GradientBrush( void* h ) : Brush( h )
   {
   }
 
   GradientBrush( const GradientBrush& x ) : Brush( x )
   {
   }
 
   GradientBrush( GradientBrush&& x ) : Brush( std::move( x ) )
   {
   }
};
 
class PCL_CLASS LinearGradientBrush : public GradientBrush
{
public:
 
   using spread_mode = GradientBrush::spread_mode;
 
   using stop_list = GradientBrush::stop_list;
 
   LinearGradientBrush( double x1, double y1, double x2, double y2,
                        const stop_list& stops = stop_list(),
                        spread_mode spread = GradientSpreadMode::Pad );
 
   LinearGradientBrush( const DRect& r,
                        const stop_list& stops = stop_list(),
                        spread_mode spread = GradientSpreadMode::Pad );
 
   LinearGradientBrush( const Rect& r,
                        const stop_list& stops = stop_list(),
                        spread_mode spread = GradientSpreadMode::Pad );
 
   LinearGradientBrush( const LinearGradientBrush& b )
      : GradientBrush( b )
   {
   }
 
   LinearGradientBrush( LinearGradientBrush&& x )
      : GradientBrush( std::move( x ) )
   {
   }
 
   LinearGradientBrush& operator =( const LinearGradientBrush& b )
   {
      SetHandle( b.handle );
      return *this;
   }
 
   LinearGradientBrush& operator =( LinearGradientBrush&& x )
   {
      Transfer( x );
      return *this;
   }
 
   void GetParameters( double& x1, double& y1, double& x2, double& y2 ) const;
 
   DRect Parameters() const
   {
      DRect r;
      GetParameters( r.x0, r.y0, r.x1, r.y1 );
      return r;
   }
};
 
class PCL_CLASS RadialGradientBrush : public GradientBrush
{
public:
 
   using spread_mode = GradientBrush::spread_mode;
 
   using stop_list = GradientBrush::stop_list;
 
   RadialGradientBrush( double cx, double cy, double r, double fx = uint32_max, double fy = uint32_max,
                        const stop_list& stops = stop_list(),
                        spread_mode spread = GradientSpreadMode::Pad );
 
   RadialGradientBrush( const DPoint& c, double r, const DPoint& f = DPoint( uint32_max ),
                        const stop_list& stops = stop_list(),
                        spread_mode spread = GradientSpreadMode::Pad );
 
   RadialGradientBrush( const Point& c, double r, const Point& f = Point( uint32_max ),
                        const stop_list& stops = stop_list(),
                        spread_mode spread = GradientSpreadMode::Pad );
 
   RadialGradientBrush( const RadialGradientBrush& b )
      : GradientBrush( b )
   {
   }
 
   RadialGradientBrush( RadialGradientBrush&& x )
      : GradientBrush( std::move( x ) )
   {
   }
 
   RadialGradientBrush& operator =( const RadialGradientBrush& b )
   {
      SetHandle( b.handle );
      return *this;
   }
 
   RadialGradientBrush& operator =( RadialGradientBrush&& x )
   {
      Transfer( x );
      return *this;
   }
 
   void GetParameters( double& cx, double& cy, double& r, double& fx, double& fy ) const;
 
   void GetParameters( DPoint& c, double& r, DPoint& f ) const
   {
      GetParameters( c.x, c.y, r, f.x, f.y );
   }
};
 
class PCL_CLASS ConicalGradientBrush : public GradientBrush
{
public:
 
   using stop_list = GradientBrush::stop_list;
 
   ConicalGradientBrush( double cx, double cy, double a, const stop_list& stops = stop_list() );
 
   ConicalGradientBrush( const DPoint& c, double a, const stop_list& stops = stop_list() );
 
   ConicalGradientBrush( const Point& c, double a, const stop_list& stops = stop_list() );
 
   ConicalGradientBrush( const ConicalGradientBrush& b )
      : GradientBrush( b )
   {
   }
 
   ConicalGradientBrush( ConicalGradientBrush&& x )
      : GradientBrush( std::move( x ) )
   {
   }
 
   ConicalGradientBrush& operator =( const ConicalGradientBrush& b )
   {
      SetHandle( b.handle );
      return *this;
   }
 
   ConicalGradientBrush& operator =( ConicalGradientBrush&& x )
   {
      Transfer( x );
      return *this;
   }
 
   void GetParameters( double& cx, double& cy, double& a ) const;
 
   void GetParameters( DPoint& c, double& a ) const
   {
      GetParameters( c.x, c.y, a );
   }
};
 
// ----------------------------------------------------------------------------
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
} // pcl
 
#endif   // __PCL_Brush_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Brush.h - Released 2024-06-18T15:48:54Z