slicerjob.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright 2009 Stefan Majewsky <majewsky@gmx.net>
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Library General Public
 *   License as published by the Free Software Foundation; either
 *   version 2 of the License, or (at your option) any later version.
 *
 *   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 Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 ***************************************************************************/

#ifndef LIBPALA_SLICERJOB_H
#define LIBPALA_SLICERJOB_H

#if defined(MAKE_LIBPALA) || defined(USE_LOCAL_LIBPALA)
# include "libpalamacros.h"
#else
# include <libpala/libpalamacros.h>
#endif

#include <QtCore/QMap>
#include <QtCore/QPoint>
#include <QtCore/QVariant>
#include <QtGui/QImage>

namespace Pala
{
    class Slicer;
    class SlicerMode;

    class LIBPALA_EXPORT SlicerJob
    {
        public:
            explicit SlicerJob(const QImage& image, const QMap<QByteArray, QVariant>& args);
            virtual ~SlicerJob();

            QVariant argument(const QByteArray& key) const;
            QImage image() const;
            const Pala::SlicerMode* mode() const;

            //The following functions belong to the interface to the Palapeli application. They are not documented because the documentation is targeted at slicer developers.
            QMap<int, QImage> pieces() const;
            QMap<int, QPoint> pieceOffsets() const;
            QList<QPair<int, int> > relations() const;
            void setMode(const Pala::SlicerMode* mode);

            void addPiece(int pieceID, const QImage& image, const QPoint& offset = QPoint());
            void addPieceFromMask(int pieceID, const QImage& mask, const QPoint& offset = QPoint());
            void addRelation(int pieceID1, int pieceID2);
        protected:
            void respectSlicerFlags(int flags);
            friend class Slicer;
        private:
            class Private;
            Private* const p;
    };
}

#endif // LIBPALA_SLICERJOB_H