ParameterGroup.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 PARAMETERGROUP_H
#define PARAMETERGROUP_H

#include "AbstractParameter.h"
#include "Parameter.h"
#include "InstanceCounterMacros.h"

namespace Frapper {

    class FRAPPER_CORE_EXPORT ParameterGroup : public AbstractParameter
    {

        ADD_INSTANCE_COUNTER

    public: // constructors and destructors

        ParameterGroup ( const QString &name = "" );

        //   //! Copy Constructor of the ParameterGroup class.
        //   //!
        //   //! \param parameterGroup The parameter group to copy.
        //   //!
        //   ParameterGroup ( const ParameterGroup &parameterGroup );

        virtual ~ParameterGroup ();


    public: // value setter functions

        void setValue ( const QString &name, const QVariant &value, bool triggerDirtying = false );

        void setValue ( const QString &name, bool value, bool triggerDirtying = false );

        void setValue ( const QString &name, int value, bool triggerDirtying = false );

        void setValue ( const QString &name, unsigned int value, bool triggerDirtying = false );

        void setValue ( const QString &name, double value, bool triggerDirtying = false );

        void setValue ( const QString &name, char *value, bool triggerDirtying = false );

        void setValue ( const QString &name, const char *value, bool triggerDirtying = false );

        void setValue ( const QString &name, const QString &value, bool triggerDirtying = false );

        void setValue ( const QString &name, const QColor &value, bool triggerDirtying = false );

        void setValue ( const QString &name, const Ogre::Vector3 &value, bool triggerDirtying = false );

        void setValue ( const QString &name, Ogre::SceneNode *value, bool triggerDirtying = false );

        void setValue ( const QString &name, const Ogre::TexturePtr value, bool triggerDirtying = false );

        void setValue ( const QString &name, ParameterGroup *value, bool triggerDirtying = false );

        void setParameterEnabled ( const QString &name, bool enabled );

        virtual void setEnabled ( bool enabled, bool propagate = true );

        virtual void setEnabled ( bool enabled, bool propagate, bool diveInGroups );

        virtual void setNode ( Node *node );

    public: // functions

        virtual AbstractParameter * clone ();

        virtual bool isGroup () const;

        virtual void reset ();

        void disconnectParameters ( QObject *receiver );

        void clear ();

        void destroyAllParameters ();

        QList<Parameter *> filterParameters ( QString searchText, bool diveInChildGroups, bool getAll = false ) const;

        bool containsGroup ( const QString &name ) const;

        bool contains ( const QString &name ) const;

        bool contains ( Parameter *parameter ) const;

        bool contains ( Parameter::Type parameterType ) const;

        bool contains ( Parameter::PinType pinType ) const;

        bool contains ( Parameter::PinType pinType, bool connected ) const;

        bool isEmpty ( ) const;

        void addParameter ( AbstractParameter *parameter, bool prepend = false );

        Parameter * getParameter ( const QString &name ) const;

        Parameter * removeParameter ( const QString &name, bool diveInGroups = true );

        Parameter * removeParameter ( Parameter *parameter, bool diveInGroups = true );

        void removeParameterGroup (  const QString &name );

        ParameterGroup * getParameterGroup ( const QString &name, bool recursive = true ) const;

        AbstractParameter::List * getParameterList ();

        AbstractParameter::Map * getParameterMap ();


    private: // data

        AbstractParameter::List m_parameterList;

        AbstractParameter::Map m_parameterMap;
    };

} // end namespace Frapper


#endif