perObjectData.hh 6.06 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
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.              *
Jan Möbius's avatar
Jan Möbius committed
39
*                                                                            *
40 41
\*===========================================================================*/

42 43 44 45 46 47 48 49 50 51 52
//=============================================================================
//
//  Types
//
//=============================================================================

/**
 * \file perObjectData.hh
 * This File contains a basic data class used to attach data to objects.
 */

Jan Möbius's avatar
Jan Möbius committed
53
#pragma once
54 55 56 57


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

Jan Möbius's avatar
Jan Möbius committed
58 59
#include <OpenFlipper/common/GlobalDefines.hh>

60 61 62 63 64
//== TYPEDEFS =================================================================


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

Jan Möbius's avatar
Jan Möbius committed
65 66 67 68 69 70 71 72
/** \brief Object Payload
 *
 * This class is used to add arbitrary data to objects
 * in OpenFlipper. You can derive any kind of class from
 * PerObjectData and attach it to an object. See
 * BaseObject::setObjectData() for more details.
 *
 * */
73 74 75 76 77
class DLLEXPORT PerObjectData {

  public :
    /// You have to provide your own constructor for your object
    PerObjectData();
78
    
79
    virtual ~PerObjectData();
80 81

    /** \brief Copy Function
82 83
     *
    * You have to reimplement this function to allow the core to create a copies of your Object.
84
    * By default it will return 0;
85 86 87 88
    *
    * The function has to create a deep copy of the object, as it will also be used to create backups.
    * If you use pointer inside your class, remember to not copy the pointer only but also the data!
    *
89 90 91
    */
    virtual PerObjectData* copyPerObjectData( );

92 93
};

94 95
//=============================================================================

96 97 98 99 100 101 102 103 104 105 106 107
#define PER_OBJECT_DATA(_CLASS, _VALUE)                                               \
class DLLEXPORT _CLASS : public PerObjectData {                                       \
                                                                                      \
  public:                                                                             \
    inline _CLASS()                 : data_( 0) { }                                   \
    inline explicit _CLASS(const _VALUE& _x) : data_(_x) { }                          \
    inline virtual ~_CLASS() { }                                                      \
    inline virtual _CLASS* copyPerObjectData() override { return new _CLASS(data_); } \
    inline       _VALUE& data()       { return data_; }                               \
    inline const _VALUE& data() const { return data_; }                               \
  private:                                                                            \
    _VALUE data_;                                                                     \
108 109 110 111 112 113
}

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

PER_OBJECT_DATA(BoolPerObjectData,   bool         );
PER_OBJECT_DATA(CharPerObjectData,   char         );
Jan Möbius's avatar
Jan Möbius committed
114
PER_OBJECT_DATA(UCharPerObjectData,  unsigned char);
115
PER_OBJECT_DATA(IntPerObjectData,    int          );
Jan Möbius's avatar
Jan Möbius committed
116
PER_OBJECT_DATA(UIntPerObjectData,   unsigned int );
117 118
PER_OBJECT_DATA(FloatPerObjectData,  float        );
PER_OBJECT_DATA(DoublePerObjectData, double       );
119