BaseBackup.hh 5.15 KB
Newer Older
Dirk Wilden's avatar
Dirk Wilden committed
1 2 3
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
 *           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.              *
Dirk Wilden's avatar
Dirk Wilden committed
39 40 41
*                                                                            *
\*===========================================================================*/

Jan Möbius's avatar
Jan Möbius committed
42
#pragma once
Dirk Wilden's avatar
Dirk Wilden committed
43 44 45 46 47

#include <QString>
#include <OpenFlipper/common/BaseObjectData.hh>
#include <OpenFlipper/common/UpdateType.hh>
#include <OpenFlipper/common/perObjectData.hh>
Jan Möbius's avatar
Jan Möbius committed
48
#include <OpenFlipper/common/GlobalDefines.hh>
Dirk Wilden's avatar
Dirk Wilden committed
49 50 51 52

/**
 * @brief Class that encapsulates a backup
 */
Jan Möbius's avatar
Jan Möbius committed
53
class DLLEXPORT BaseBackup
Dirk Wilden's avatar
Dirk Wilden committed
54 55 56
{

  public:
57
    explicit BaseBackup(QString _name);
Jan Möbius's avatar
Jan Möbius committed
58 59 60 61 62 63 64 65

    /** \brief constructor
     *
     * @param _object Pointer to the object, this backup will belong to
     * @param _name   Name of the object
     * @param _type   Type of change which can be used to create more specific backups (e.g. selection only)
     *
     */
Dirk Wilden's avatar
Dirk Wilden committed
66
    BaseBackup(BaseObjectData* _object, QString _name, UpdateType _type);
Jan Möbius's avatar
Jan Möbius committed
67

Dirk Wilden's avatar
Dirk Wilden committed
68 69 70
    virtual ~BaseBackup();

  public:
Jan Möbius's avatar
Jan Möbius committed
71 72 73 74 75 76 77 78 79

    /** \brief Revert this backup
     *
     * This function has to be implemented. It will be called when the backup should be restored.
     *
     * \note You have to call the BaseBackup::apply() first in your implementation of this function.
     *
     * You have to restore your backup to the corresponding object when this function gets called.
     */
Dirk Wilden's avatar
Dirk Wilden committed
80
    virtual void apply();
Jan Möbius's avatar
Jan Möbius committed
81 82 83 84

    /** \brief Get the backups name)
     *
     */
Dirk Wilden's avatar
Dirk Wilden committed
85
    QString name();
Jan Möbius's avatar
Jan Möbius committed
86 87 88 89 90 91 92


    /** \brief Set links to corresponding backups
     *
     * Backups can be grouped together. The backups store the links to their group members via
     * this function.
     */
Dirk Wilden's avatar
Dirk Wilden committed
93
    void setLinks(IdList _objectIDs);
Jan Möbius's avatar
Jan Möbius committed
94 95 96 97 98

    /** \brief get id of this backup
     *
     * Automatically generated id for this backup.
     */
Dirk Wilden's avatar
Dirk Wilden committed
99 100
    int id();

Jan Möbius's avatar
Jan Möbius committed
101 102 103 104 105 106
    /** \brief Returns if this backup is blocked
     *
     * When Backups are grouped together, they can not be reversed o their own but
     * oly together with the others in that backup group. This flag indicates, that
     * the backup is part of a group and can not be reversed on its own.
     */
Dirk Wilden's avatar
Dirk Wilden committed
107 108 109
    bool blocked();
    
  protected:
Jan Möbius's avatar
Jan Möbius committed
110
    /// Backup of the perObjectData objects
Dirk Wilden's avatar
Dirk Wilden committed
111 112 113 114 115 116 117 118 119
    std::vector< std::pair<QString, PerObjectData*> > objectDatas_;

    BaseObjectData*  object_;
    QString          name_;
    IdList           links_;

    int              id_;
};