slicer.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright 2009, 2010 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_SLICER_H
#define LIBPALA_SLICER_H

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

#include <QtCore/QObject>
#include <QtCore/QVariant>

namespace Pala
{
    class SlicerJob;
    class SlicerMode;
    class SlicerProperty;
    class SlicerPropertySet;

    class LIBPALA_EXPORT Slicer : public QObject
    {
        Q_OBJECT
        public:
            enum SlicerFlag
            {
                NoFlags = 0x0,
                AllowFullTransparency = 0x1 
            };
            Q_DECLARE_FLAGS(SlicerFlags, SlicerFlag)

            
            explicit Slicer(QObject* parent = 0, const QVariantList& args = QVariantList());
            virtual ~Slicer();

            //The following function belongs to the interface to the Palapeli application. It is not documented because the documentation is targeted at slicer developers.
            QList<const Pala::SlicerMode*> modes() const;
            QMap<QByteArray, const Pala::SlicerProperty*> properties() const;
            QList<const Pala::SlicerProperty*> propertyList() const; //BIC: rename to properties()
            SlicerFlags flags() const;
            bool process(Pala::SlicerJob* job); //a wrapper function for Pala::Slicer::run
            //BIC: constify method

            //This class is the only interface that slicers can use to communicate with Palapeli, and it is only instantiated very few times (one instance per slicer plugin), so it should be reasonable to reserve some space in the virtual table for future additions.
            RESERVE_VIRTUAL_5
        protected:
            void addProperty(const QByteArray& key, Pala::SlicerProperty* property);
            //BIC: make interface similar to setMode()
            void addMode(Pala::SlicerMode* mode);

            friend class SlicerPropertySet;
            void setFlags(SlicerFlags flags);

            virtual bool run(Pala::SlicerJob* job) = 0;
            //BIC: constify method
        private:
            class Private;
            Private* const p;
    };
}

Q_DECLARE_OPERATORS_FOR_FLAGS(Pala::Slicer::SlicerFlags)

#endif // LIBPALA_SLICER_H