NodeType.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of FRAPPER
research.animationsinstitut.de
sourceforge.net/projects/frapper

Copyright (c) 2008-2009 Filmakademie Baden-Wuerttemberg, Institute of Animation 

This program 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; version 2.1 of the License.

This program 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 program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
-----------------------------------------------------------------------------
*/


#ifndef NODETYPE_H
#define NODETYPE_H

#include "FrapperPrerequisites.h"
#include <QtCore/QString>
#include <QtGui/QColor>
#include "Node.h"
#include "ParameterGroup.h"
#include <QtXml/QDomElement>
#include "NodeTypeInterface.h"
#include "InstanceCounterMacros.h"

namespace Frapper {

    class FRAPPER_CORE_EXPORT NodeType
    {

        ADD_INSTANCE_COUNTER

    public: // type definitions

        typedef QMap<QString, NodeType *> Map;

        typedef QPair<QString, QString> Category;

        typedef QList<Category> CategoryList;

    public: // static data

        static Category CategorySeparator;

    private: // static data

        static QMap<QString, unsigned int> s_nodeIndex;

    public: // constructors and destructors

        NodeType ( const QString &filename );

        ~NodeType ();

    public: // functions

        QString getName () const;

        QString getCategoryName () const;

        QColor getColor () const;

        bool isAvailable () const;

        bool isInternal () const;

        bool isErroneous () const;

        Node * createNode ( const QString &name );

    private: // functions

        bool parseDescriptionFile ( const QString &filename );

        ParameterGroup * parseParameters ( QDomElement rootElement );

        void parseAffections ( QDomElement rootElement );

    private: // data

        NodeTypeInterface *m_nodeTypeInterface;

        ParameterGroup *m_parameterRoot;

        QString m_name;

        QString m_categoryName;

        QColor m_color;

        bool m_available;

        bool m_internal;

        bool m_erroneous;

        QMultiMap<QString, QString> m_affectionMap;


    };

} // end namespace Frapper

#endif