Pen.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/Pen.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// 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_Pen_h
#define __PCL_Pen_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/Brush.h>
#include <pcl/Color.h>
#include <pcl/UIObject.h>
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace PenStyle
{
   enum value_type
   {
      Empty,      // Nothing drawn
      Solid,      // _____________
      Dash,       // _ _ _ _ _ _ _
      Dot,        // .............
      DashDot,    // _._._._._._._
      DashDotDot, // _.._.._.._.._
 
      NumberOfPenStyles
   };
}
 
// ----------------------------------------------------------------------------
 
namespace PenCap
{
   enum value_type
   {
      Flat,    // Square caps not reaching the end points of lines
      Square,  // Square caps extending beyond end points by half the line width
      Round,   // Round caps centered at the line end points
 
      NumberOfPenCaps
   };
}
 
// ----------------------------------------------------------------------------
 
namespace PenJoin
{
   enum value_type
   {
      Miter,   // Lines are joined by sharp corners
      Bevel,   // Lines are joined by flat corners
      Round,   // Circular arcs are drawn between lines
 
      NumberOfPenJoins
   };
}
 
// ----------------------------------------------------------------------------
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
class PCL_CLASS Brush;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Pen : public UIObject
{
public:
 
   using style = PenStyle::value_type;
 
   using cap = PenCap::value_type;
 
   using join = PenJoin::value_type;
 
   Pen( RGBA color = 0xff000000, float width = 0, style s = PenStyle::Solid,
        cap c = PenCap::Square, join j = PenJoin::Miter );
 
   Pen( const Pen& p ) : UIObject( p )
   {
   }
 
   ~Pen() override
   {
   }
 
   Pen& operator =( const Pen& p )
   {
      SetHandle( p.handle );
      return *this;
   }
 
   static Pen& Null();
 
   float Width() const;
 
   void SetWidth( float w );
 
   RGBA Color() const;
 
   void SetColor( RGBA color );
 
   style Style() const;
 
   bool IsSolid() const
   {
      return Style() == PenStyle::Solid;
   }
 
   bool IsEmpty() const
   {
      return Style() == PenStyle::Empty;
   }
 
   void SetStyle( style );
 
   cap Cap() const;
 
   void SetCap( cap c );
 
   join Join() const;
 
   void SetJoin( join j );
 
   pcl::Brush Brush() const;
 
   pcl::Brush GetBrush() const
   {
      return this->Brush();
   }
 
   void SetBrush( const pcl::Brush& brush );
 
private:
 
   Pen( void* h ) : UIObject( h )
   {
   }
 
   void* CloneHandle() const override;
 
   friend class GraphicsContextBase;
   friend class Graphics;
   friend class VectorGraphics;
};
 
// ----------------------------------------------------------------------------
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
} // pcl
 
#endif   // __PCL_Pen_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Pen.h - Released 2024-01-13T15:47:58Z