Pen.h

/* Copyright (C) 2006-2015 Laurentiu-Gheorghe Crisan
   Copyright (C) 2006-2015 Marc Boris Duerner
   Copyright (C) 2017-2017 Aloysius Indrayanto

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  As a special exception, you may use this file as part of a free
  software library without restriction. Specifically, if other files
  instantiate templates or use macros or inline functions from this
  file, or you compile this file and link it with other files to
  produce an executable, this file does not by itself cause the
  resulting executable to be covered by the GNU General Public
  License. This exception does not however invalidate any other
  reasons why the executable file might be covered by the GNU Library
  General Public License.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  MA 02110-1301 USA
*/

#ifndef PT_GFX_PEN_H
#define PT_GFX_PEN_H

#include <Pt/Gfx/Api.h>
#include <Pt/Gfx/Color.h>
#include <Pt/SmartPtr.h>
#include <cstddef>

namespace Pt {

namespace Gfx {

class PenData;

class PT_GFX_API Pen
{
    public:
        enum Style { Solid       = 0,
                     Dot         = 1,
                     DoubleDot   = 2,
                     Dash        = 3,
                     DoubleDash  = 4,
                     DotDash     = 5,
                     UserDefined = 6
                   };

        enum CapStyle { ButtCap          = 0,
                        SquareCap        = 1,
                        RoundCap         = 2,
                        TriangularOutCap = 3,
                        TriangularInCap  = 4,
                        RoundHoleCap     = 5,
                        Arrow1Cap        = 6,
                        Arrow2Cap        = 7,
                        FlatCap          = 0, // FlatCap       and ButtCap          are the same
                        ProjectingCap    = 1, // ProjectingCap and SquareCap        are the same
                        TriangularCap    = 3, // TriangularCap and TriangularOutCap are the same
                        NotLastCap       = 9  // What is this ???
                      };

        enum JoinStyle { NoJoin         = 0,
                         BevelJoin      = 1,
                         MiterJoin      = 2,
                         RoundJoin      = 3,
                         TriangularJoin = 9  // What is this ???
                       };

        Pen();

        Pen(const Color& color);

        Pen(const Color& color, std::size_t width,
            Style style = Solid, CapStyle cap = FlatCap,
            JoinStyle join = BevelJoin);

        Pen(const Color& color, std::size_t width,
            Pt::uint64_t stylePattern, CapStyle cap = FlatCap,
            JoinStyle join = BevelJoin);

        void setSize(std::size_t size);

        std::size_t size() const;

        void setColor(const Color& color);

        const Color& color() const;

        void setStyle(Style style = Solid);

        void setStyle(Pt::uint64_t stylePattern);

        Style style() const;

        Pt::uint64_t styleUserPattern() const;

        void setCapStyle(CapStyle cap = FlatCap);

        CapStyle capStyle() const;

        void setJoinStyle(JoinStyle join = BevelJoin);

        JoinStyle joinStyle() const;

        bool isNull() const;

    private:
      SmartPtr<PenData> _penData;
};


class PT_GFX_API PenData
{
  public:
      PenData(const Color& color, std::size_t size,
              Pen::Style style, Pt::uint64_t userPattern, Pen::CapStyle cap, Pen::JoinStyle join)
      : _color(color)
      , _size(size)
      , _style(style )
      , _userPattern(userPattern)
      , _capStyle(cap)
      , _joinStyle(join)
      {}

      void setColor(const Color& color)
      { _color = color; }

      const Color& color() const
      { return _color; }

      void setSize(std::size_t size)
      { _size = size; }

      std::size_t size() const
      { return _size; }

      void setStyle(Pen::Style style, Pt::uint64_t userPattern)
      {
          _style       = style;
          _userPattern = userPattern;
      }

      Pen::Style style() const
      { return _style; }

      Pt::uint64_t styleUserPattern() const
      { return _userPattern; }

      void setCapStyle(Pen::CapStyle cap)
      { _capStyle = cap;}

      Pen::CapStyle capStyle() const
      { return _capStyle;}

      void setJoinStyle(Pen::JoinStyle join)
      { _joinStyle = join; }

      Pen::JoinStyle joinStyle() const
      { return _joinStyle; }

  private:
      Color          _color;
      std::size_t    _size;
      Pen::Style     _style;
      Pt::uint64_t   _userPattern;
      Pen::CapStyle  _capStyle;
      Pen::JoinStyle _joinStyle;
};

} // namespace

} // namespace

#endif