PainterBase.h

/* Copyright (C) 2006-2015 Laurentiu-Gheorghe Crisan
   Copyright (C) 2006-2015 Marc Boris Duerner
   Copyright (C) 2010-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_PAINTERBASE_H
#define PT_GFX_PAINTERBASE_H
 
#include <Pt/Gfx/Api.h>
#include <Pt/Gfx/Size.h>
#include <Pt/Gfx/Point.h>
#include <Pt/Gfx/Rect.h>
#include <Pt/Gfx/Font.h>
#include <Pt/Gfx/FontMetrics.h>
#include <Pt/Gfx/TextMetrics.h>
#include <Pt/Gfx/Pen.h>
#include <Pt/Gfx/Brush.h>
#include <Pt/Gfx/Scaling.h>
#include <Pt/Gfx/Transform.h>
#include <Pt/Gfx/Path.h>
#include <Pt/Gfx/CompositionMode.h>
#include <Pt/Gfx/Paint.h>
 
#include <Pt/NonCopyable.h>
#include <Pt/String.h>
#include <Pt/Types.h>
 
#include <cstddef>
 
namespace Pt {
 
namespace Gfx {
 
class Canvas;
class Bitmap;
class PaintSurface;
class PaintContext;

class PT_GFX_API PainterBase : private NonCopyable
{
    friend class PaintSurface;
    friend class PaintContext;
 
    protected:
        PainterBase();
 
    public:
        virtual ~PainterBase();

        void finish();

        const ImageFormat& format() const;

        const Scaling& scaling() const;
 
    public:
        const CompositionMode& compositionMode() const;

        void setCompositionMode(const CompositionMode& mode);

        const Pen& pen() const;

        void setPen(const Pen& pen);

        const Brush& brush() const;

        void setBrush(const Brush& brush);

        const Font& font() const;

        void setFont(const Font& font);

        const Transform& transform() const;

        void setTransform(const Transform& tx);

        void resetTransform();

        const RectF* clip() const;

        void setClip(const RectF& clip);

        void resetClip();
 
    public:
        void drawLine(const PointF& from, const PointF& to);

        void drawPolyline(const PointF* points, const size_t pointCount);

        void fillPolygon(const PointF* points, const size_t pointCount);

        void drawRect(const RectF& rect);

        void fillRect(const RectF& rect);

        void drawCircle(const PointF& topLeft, double diameter);

        void fillCircle(const PointF& topLeft, double diameter);

        void drawEllipse(const PointF& topLeft, const SizeF& size);

        void fillEllipse(const PointF& topLeft, const SizeF& size);

        void drawArc(const PointF& topLeft, const SizeF& size,
                     float degBegin, float degEnd);

        void fillChord(const PointF& topLeft, const SizeF& size,
                       float degBegin, float degEnd);

        void fillPie(const PointF& topLeft, const SizeF& size,
                     float degBegin, float degEnd);
 
    public:
        const Gfx::Path& path() const;

        void setPath(const Path& path);

        void drawPath();

        void fillPath();

        void drawPath(const Path& path);

        void fillPath(const Path& path);
 
    public:
        const FontMetrics& fontMetrics() const;

        TextMetrics textMetrics(const Pt::String& text) const;

        void drawText(const PointF& to, const Pt::String& text);

        void drawText(const PointF& to, const Pt::String& text, const Transform& t);
 
    public:
        void drawImage(const PointF& to, const Image& im);

        void drawImage(const PointF& to, const Image& im, const RectF& rect);
 
    public:
        void drawBitmap(const PointF& to, const Bitmap& bm);

        void drawBitmap(const PointF& to, const Bitmap& bm, const RectF& rect);
 
    protected:
        void beginPaint(PaintSurface& surface);

        void beginPaint(PaintContext& context);

        const Paint& paint() const;

        Canvas* canvas() const;

        virtual void onDetachSurface(PaintSurface& surface);

        virtual void onDetachContext(PaintContext& context);
 
    private:
        void onBeginPaint(Canvas& canvas);
 
        void onSetContextClip(const RectF* clip);
 
        void updateClip(const RectF* painterClip, const RectF* contextClip);
 
    private:
        PaintSurface*        _surface;
        PaintContext*        _context;
        Canvas*              _canvas;
        Paint                _paint;
        Scaling              _scaling;
        Transform            _transform;
        RectF                _clip;
        bool                 _hasClip;
        Path                 _path;
};
 
} // namespace
 
} // namespace
 
#endif