BaseObject.hh

Go to the documentation of this file.

/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           www.openflipper.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenFlipper.                                        *
 *                                                                           *
 *  OpenFlipper 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, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenFlipper 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 LesserGeneral Public          *
 *  License along with OpenFlipper. If not,                                  *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision: 6727 $                                                         *
 *   $Author: moebius $                                                      *
 *   $Date: 2009-08-05 08:03:50 +0200 (Mi, 05. Aug 2009) $                   *
 *                                                                           *
\*===========================================================================*/




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

#ifndef BASEOBJECT_HH
#define BASEOBJECT_HH

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

#include <OpenFlipper/common/GlobalDefines.hh>
#include <QString>
#include <QList>
#include <QStringList>
#include <vector>
#include <QMap>
#include "perObjectData.hh"

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


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

class DLLEXPORTONLY BaseObject {
  friend class BaseObjectData;

  public :

    BaseObject(const BaseObject& _object);

    BaseObject( BaseObject *_parent = 0);

    virtual ~BaseObject();

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

    int persistentId();

    void persistentId( int _id );

  private:
    int id_;

    int persistentId_;

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

  public:
    bool dataType(DataType _type);

    DataType dataType();

    void setDataType(DataType _type);

  private:
    DataType objectType_;

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

  public:
    virtual void cleanup();

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

    virtual void printObjectInfo();

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

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


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

  public :
    virtual bool visible();

    virtual void visible(bool _visible);

  private :
    bool visible_;

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

  public:
    virtual void update();

    void dumpTree();

    virtual BaseObject* copy();

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

  public:

    BaseObject* last();

    BaseObject* next();

    int level();

  private:
    BaseObject *parentItem_;

    QList<BaseObject*> childItems_;

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

    int row() const;

    BaseObject *parent();

    void setParent(BaseObject* _parent);

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

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

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

    int group();

    bool isGroup();

    bool isInGroup( int _id );

    bool isInGroup( QString _name );

    std::vector< int > getGroupIds();

    QStringList getGroupNames();


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

    QString name( );

    virtual void setName( QString _name );


  private:

    QString name_;


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

  public:

    void setObjectData( QString _dataName , PerObjectData* _data );

    void clearObjectData( QString _dataName );

    bool hasObjectData( QString _dataName );

    PerObjectData* objectData( QString _dataName );

    void deleteData();

  private:

    QMap<QString, PerObjectData* > dataMap_;

};


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