BaseObject.hh

Go to the documentation of this file.

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/




//=============================================================================
//
//  Types
//
//=============================================================================

#ifndef BASEOBJECT_HH
#define BASEOBJECT_HH

//== INCLUDES =================================================================

#include <OpenFlipper/common/GlobalDefines.hh>
#include <OpenFlipper/common/DataTypes.hh>
#include <OpenFlipper/common/UpdateType.hh>
#include <QObject>
#include <QString>
#include <QList>
#include <QStringList>
#include <vector>
#include <QMap>
#include "perObjectData.hh"
#if QT_VERSION >= 0x050000
#include <QJsonDocument>
#include <QJsonObject>
#endif

//== TYPEDEFS =================================================================


//== CLASS DEFINITION =========================================================

class DLLEXPORTONLY BaseObject : public QObject {
  
  Q_OBJECT 
  
  friend class BaseObjectData;
  friend class Core;

  public :

    BaseObject(const BaseObject& _object);

    BaseObject( BaseObject *_parent = 0);

    virtual ~BaseObject();

    static int NOOBJECT;

  //===========================================================================
  //===========================================================================
  public:
    int id() const;

    int persistentId() const;

    void persistentId( int _id );

  private:
    int id_;

    int persistentId_;

  //===========================================================================
  //===========================================================================

  public:
    bool dataType(DataType _type) const;

    DataType dataType() const;

    void setDataType(DataType _type);

  private:
    DataType objectType_;

  //===========================================================================
  //===========================================================================

  public:
    virtual void cleanup();

  //===========================================================================
  //===========================================================================
  public:
    virtual QString getObjectinfo();

    virtual void printObjectInfo();

  //===========================================================================
  //===========================================================================

  signals:
    void objectSelectionChanged(int _objectId);
    
  public:
    bool target();

    void target(bool _target);

    bool source();

    void source(bool _source);

    bool flag(QString _flag);

    void setFlag(QString _flag, bool _set);

    QStringList flags();

  private:

    QStringList flags_;


  //===========================================================================
  //===========================================================================
  
  signals:
    void visibilityChanged(int _objectId);


  public :
    virtual bool visible();

    virtual void visible(bool _visible);

  protected :
    bool visible_;

  //===========================================================================
  //===========================================================================

  public:


    void dumpTree();

    virtual BaseObject* copy();

  //===========================================================================
  //===========================================================================

  protected:
    virtual void update(UpdateType _type = UPDATE_ALL);

  //===========================================================================
  //===========================================================================

  public:

    BaseObject* last();

    BaseObject* next();

    int level();

  private:
    BaseObject *parentItem_;

    QList<BaseObject*> childItems_;

  public:
    //===========================================================================
    //===========================================================================

  public:
    
    int row() const;

    BaseObject *parent();
    const BaseObject *parent() const;

    void setParent(BaseObject* _parent);

    //===========================================================================
    //===========================================================================
    
  public:
    
    BaseObject* childExists(int _objectId);

    BaseObject* childExists(QString _name);

    void appendChild(BaseObject *child);

    BaseObject *child(int row);

    int childCount() const;

    void removeChild( BaseObject* _item );

    QList< BaseObject* > getLeafs();

    void deleteSubtree();

    //===========================================================================
    //===========================================================================

  public:
    
    int group() const;

    bool isGroup() const;

    bool isInGroup( int _id ) const;

    bool isInGroup( QString _name ) const;

    std::vector< int > getGroupIds();

    QStringList getGroupNames();


    //===========================================================================
    //===========================================================================

    void setFromFileName(const QString &_filename);


    QString path() const;

    void setPath(const QString &_path);

    QString name( ) const;


     /* set the name of the object. ( If you overwrite it, call BaseObject::setName(_name ) it in your funtion first)
     * this is may not the filename of the given object, because one file can have multiple objects
     */
    virtual void setName(QString _name );

    QString filename() const;

    void setFileName(const QString &_filename);

  private:

    QString path_;
    QString filename_;

  signals:
    void objectPropertiesChanged(int _objectId);

  private:

    QString name_;


  //===========================================================================
  //===========================================================================

  public:

    void setObjectData( QString _dataName , PerObjectData* _data );

    void clearObjectData( QString _dataName );

    bool hasObjectData( QString _dataName );

    PerObjectData* objectData( QString _dataName );

    void deleteData();
    
    //===========================================================================
    //===========================================================================
    
    QMap<QString, PerObjectData*>& getPerObjectDataMap();
    
    
  private:

    QMap<QString, PerObjectData* > dataMap_;

    //===========================================================================
    //===========================================================================

  public:
    QString &getCommentByKey(const QString &key) {
        return commentsByKey_[key];
    }

    const QString getCommentByKey(const QString &key) const {
        return commentsByKey_.value(key);
    }

    bool hasCommentForKey(const QString &key) const {
        return commentsByKey_.contains(key);
    }

    bool hasComments() const {
        return !commentsByKey_.empty();
    }

    void clearComment(const QString &key) {
        commentsByKey_.remove(key);
    }

    void clearAllComments() {
        commentsByKey_.clear();
    }

    const QMap<QString, QString> &getAllComments() const {
        return commentsByKey_;
    }

    const QString getAllCommentsFlat() const {
        QStringList result;

        result.append(QString("BEGIN Comments for object \"%1\"").arg(name()));

        /*
         * Compose JSON parsable object.
         */
#if QT_VERSION >= 0x050000
        QJsonObject comment_obj;
        for (QMap<QString, QString>::const_iterator it = commentsByKey_.begin(), it_end = commentsByKey_.end();
                it != it_end; ++it) {

            QJsonParseError json_error;
            QString test_json_str = QString::fromUtf8("{\"test\": %1}").arg(it.value());
            QByteArray test_json_ba = test_json_str.toUtf8();
            QJsonDocument test_json = QJsonDocument::fromJson(test_json_ba, &json_error);
            if (json_error.error != QJsonParseError::NoError) {
                comment_obj[it.key()] = it.value();
            } else {
                comment_obj[it.key()] = test_json.object().value("test");
            }
        }
        result.append(QString::fromUtf8(QJsonDocument(comment_obj).toJson(QJsonDocument::Indented)));
#else
        for (QMap<QString, QString>::const_iterator it = commentsByKey_.begin(), it_end = commentsByKey_.end();
                it != it_end; ++it) {
            result.append(QString("%1: %2").arg(it.key(), it.value()));
        }
#endif

        result.append(QString("END Comments for object \"%1\"\n").arg(name()));

        return result.join("\n");
    }

  private:
    QMap<QString, QString> commentsByKey_;

};


//=============================================================================
#endif // BASEOBJECT_HH defined
//=============================================================================