Node.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 NODE_H
#define NODE_H

#include "FrapperPrerequisites.h"
#include "ParameterGroup.h"
#include "Parameter.h"
#include "NumberParameter.h"
#include "FilenameParameter.h"
#include "EnumerationParameter.h"
#include "SceneNodeParameter.h"
#include "Connection.h"
#include "InstanceCounterMacros.h"
#include <QtCore/QObject>
#include <QtCore/QThread>
#include <QtCore/QStringList>
#include "OgreVector3.h"

namespace Frapper {

class FRAPPER_CORE_EXPORT Node : public QThread
{

    Q_OBJECT

public:
#pragma data_seg(".shared")
    static int s_numberOfInstances;
    static int s_totalNumberOfInstances;
#pragma data_seg()

public: // constructors and destructors

    Node ( const QString &name, ParameterGroup *parameterRoot );

    virtual ~Node ();


public: // functions

    virtual void run ( const QString &parameterName );

    //########### obsolete - just for performance testing
    virtual bool process ( const QString &parameterName );

    bool getTypeUnknown () const;

    Parameter *getTimeParameter () const;

    QString getName () const;

    void setName ( const QString &name );

    QString getTypeName () const;

    void setTypeName ( const QString &typeName );

    bool isTypeUnknown () const;

    void setTypeUnknown ( bool typeUnknown = true );

    bool isEvaluated () const;

    bool isSelected () const;

    virtual void setSelected ( bool selected );

    bool isSelfEvaluating () const;

    bool isSaveable () const;

    void setSelfEvaluating ( bool selfEvaluating );

    void setSaveable ( bool saveable );

    QString getSearchText () const;

    void setSearchText ( const QString &searchText );

public: // parameter group functions

    ParameterGroup * getParameterRoot () const;

    ParameterGroup * getParameterGroup ( const QString &name ) const;

    void fillParameterLists ( AbstractParameter::List *inputParameters, AbstractParameter::List *outputParameters );

    void fillParameterLists ( AbstractParameter::List *connectedInputParameters, AbstractParameter::List *connectedOutputParameters, bool *unconnectedInputParametersAvailable, bool *unconnectedOutputParametersAvailable );

    AbstractParameter::List getParameters ( Parameter::PinType pinType, bool connected, ParameterGroup *parameterGroup = 0 );

public: // parameter functions

    bool hasParameter ( const QString &name ) const;

    Parameter * getParameter ( const QString &name ) const;

    NumberParameter * getNumberParameter ( const QString &name ) const;

    FilenameParameter * getFilenameParameter ( const QString &name ) const;

    EnumerationParameter * getEnumerationParameter ( const QString &name ) const;

    GeometryParameter * getGeometryParameter ( const QString &name ) const;

    LightParameter * getLightParameter ( const QString &name ) const;

    CameraParameter * getCameraParameter ( const QString &name ) const;

    void setDirty ( const QString &name, bool dirty );

    void setDirty ( bool dirty );

    void setNodeDirty ( bool dirty );

    bool isNodeDirty ();

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

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

    void addAffection ( const QString &parameterName, const QString &affectedParameterName );

public: // value getter functions

    QVariant getValue ( const QString &name, bool triggerEvaluation = false );

    bool getBoolValue ( const QString &name, bool triggerEvaluation = false );

    int getIntValue ( const QString &name, bool triggerEvaluation = false );

    unsigned int getUnsignedIntValue ( const QString &name, bool triggerEvaluation = false );

        float getFloatValue ( const QString &name, bool triggerEvaluation = false );

    double getDoubleValue ( const QString &name, bool triggerEvaluation = false );

    QString getStringValue ( const QString &name, bool triggerEvaluation = false );

    QColor getColorValue ( const QString &name, bool triggerEvaluation = false );

    Ogre::Vector3 getVectorValue ( const QString &name, bool triggerEvaluation = false );

    Ogre::SceneNode * getSceneNodeValue ( const QString &name, bool triggerEvaluation = false );

    Ogre::TexturePtr getTextureValue ( const QString &name, bool triggerEvaluation = false );

    ParameterGroup * getGroupValue ( const QString &name, bool triggerEvaluation = false );

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 );

public: // callback setter functions

    void setChangeFunction ( const QString &name, const char *changeFunction );

    void setProcessingFunction ( const QString &name, const char *processingFunction );

    void setAuxProcessingFunction ( const QString &name, const char *processingFunction );

    void setCommandFunction ( const QString &name, const char *commandFunction );

        void setOnConnectFunction ( const QString &name, const char *onConnectFunction );

        void setOnDisconnectFunction ( const QString &name, const char *onDisconnectFunction );

public: // misc functions

    void notifyChange ();

    virtual void setUpTimeDependencies ( Parameter *timeParameter );

    virtual void evaluateConnection ( Connection *connection );

    void deleteConnection ( Connection *connection);

    void renderSingleFrame ();

    public slots: //

        virtual void setEvaluate ( bool evaluate );

        virtual void loadReady();

        virtual void saveStart();

signals: //

        void frameChanged (int);

        void nodeChanged ();

        void nodeNameChanged (const QString &name);

        void selectedChanged ( bool selected );

        void sendDeleteConnection ( Connection *connection);

        void updateFrame ();

        void selectDeselectObject ( const QString &name );

                void loadSceneElementsReady();

protected: // methods

    Ogre::String createUniqueName ( const QString &objectName );

    virtual void finalize(); // only virtual for solver release !!!

protected: // data

    QString m_name;

    QString m_typeName;

    bool m_dirty;

    Parameter *m_timeParameter;

    bool m_typeUnknown;

    bool m_evaluate;

    bool m_selected;

    bool m_selfEvaluating;

    QString m_searchText;

    bool m_saveable;

private: // data

    ParameterGroup *m_parameterRoot;

};

} // end namespace Frapper

#endif