DataTypes.hh 10.5 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
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 DataTypes.hh
 * This File contains the basic type informations
 */

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

//== includes =================================================================


#include <OpenFlipper/common/GlobalDefines.hh>
59
#include <OpenFlipper/common/UpdateType.hh>
60 61 62

#include <ACG/Math/Matrix4x4T.hh>
#include <ACG/Math/VectorT.hh>
63
#include <climits>
64 65 66 67 68 69 70 71 72 73 74
#include <QIcon>
#include <QMetaType>

//== Global Typedefs  =================================================================

/** \brief Predefined datatypes
*
* Here are several datatypes which have predefined ids. This might be changed to runtime added
* datatypes in the future.
*/

75 76
/** \brief the internal DataType class
*
77
* Normally we could use an unsigned int here. But QT can't register an
78 79
* typedef unsigned int DataType as DataType and will recognize it as unsigned int and
* therefore DataType will still be unknown to QtScript.
Jan Möbius's avatar
Jan Möbius committed
80
* To overcome this Problem, we reimplement a wrapper around the int and provide additional
81 82
* functionality such as returning the name of the type directly
*/ 
Jan Möbius's avatar
Jan Möbius committed
83
class DLLEXPORT DataType  {
84 85 86
  public:
    DataType();
    DataType(const unsigned int& _i);
87 88
    DataType(const DataType& _i ) = default;

89 90
    bool operator!=( const unsigned int& _i ) const;
    bool operator!=( const DataType& _i ) const;
91
    
92 93
    bool operator==( const unsigned int& _i ) const;
    bool operator==(  const DataType& _i ) const;
94
    
95
    DataType& operator=( const unsigned int& _i );
96 97 98

    DataType& operator=( const DataType& _i ) = default;

99
    bool operator<( const unsigned int& _i ) const;
100 101
    bool operator<( const DataType& _i ) const;
    
Jan Möbius's avatar
Jan Möbius committed
102 103
    DataType& operator|=( const unsigned int& _i );
    DataType& operator|=( const DataType& _i );    
Jan Möbius's avatar
Jan Möbius committed
104
    
105
    bool operator&( const unsigned int& _i ) const;
106
    bool operator&( const DataType& _i ) const;
107 108 109

    DataType operator!();
    
110
    bool contains( const DataType& _i ) const;
111
    
112 113
    DataType operator|( const DataType& _i ) const;

114 115 116 117
    DataType operator++(int _unused);

    DataType& operator++();

118 119 120 121 122 123 124
    /** return the internal representation of the type which is an unsigned int at the moment.
    *
    * You should avoid using this directly as the internal representation might change in the future
    */
    unsigned int value() const;
      
    /// Return the name of this type as text
125
    QString name() const;
126 127 128 129 130
 
  private:
    unsigned int field;
};

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
class TypeInfo {

  public:

  TypeInfo(DataType _type, QString _name, QString _iconName, QString _readableName ) :
    type(_type),
    name(_name),
    iconName(_iconName),
    readableName(_readableName)
  {
    // Use internal name if no external name is given
    if ( _readableName == "" )
      readableName = _name;
  }

  /// The id of the datatype
  DataType type;

  /// The name of the datatype
  QString  name;

  /// The icon of the datatype
  QString  iconName;

  QIcon    icon;

  /// Human readable name
  QString readableName;
};

161 162 163
/// Identifier for all available objects
const DataType DATA_ALL(UINT_MAX);

164
/// None of the other Objects
165
const DataType DATA_UNKNOWN(0);
166 167

/// Items used for Grouping
168
const DataType DATA_GROUP(1);
169

170
std::ostream &operator<<(std::ostream &stream, DataType type);
171 172 173 174 175 176


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

/// Standard Type for 3d Vector used for scripting
typedef ACG::Vec3d Vector;
177 178 179

/// Standard Type for 4d Vector used for scripting
typedef ACG::Vec4d Vector4;
180
/// Standard Type for id Lists used for scripting
Jan Möbius's avatar
Jan Möbius committed
181
typedef std::vector< int > IdList;
182 183 184
/// Standard Type for a 4x4 Matrix used for scripting
typedef ACG::Matrix4x4d Matrix4x4;

Mike Kremer's avatar
Mike Kremer committed
185 186 187 188
Q_DECLARE_METATYPE(IdList)
Q_DECLARE_METATYPE(DataType)
Q_DECLARE_METATYPE(QVector< int >)
Q_DECLARE_METATYPE(Vector)
189
Q_DECLARE_METATYPE(Vector4)
Mike Kremer's avatar
Mike Kremer committed
190
Q_DECLARE_METATYPE(Matrix4x4)
191 192 193 194 195 196 197
Q_DECLARE_METATYPE(UpdateType)

/** Registers datatypes on runtime for signal/slots
 *
 */
DLLEXPORT
void registerTypes();
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

//================================================================================================
/** @name Functions for adding dataTypes
* @{ */
//================================================================================================

/** Adds a datatype and returns the id for the new type
*
* @param _name Internal name for the new DataType
* @param _readableName Human readable Name for this type ( Use tr to make it translatable )
*/
DLLEXPORT
DataType addDataType(QString _name, QString _readableName);

/// Given a dataType Identifier string this function will return the id of the datatype
DLLEXPORT
DataType typeId(QString _name);

/** \brief Get the name of a type with given id
*
* The ids are organized in a bitfield. So use either the macro for getting the type id or
* use the id directly (they have to be power of 2! ... Bitfield)
*/
DLLEXPORT
QString typeName(DataType _id);

224 225 226 227 228 229
/** \brief Check if a type with the given name exists
*
*/
DLLEXPORT
bool typeExists( QString _name );

230 231 232 233 234
/** \brief Get the number of registered types
*
* This function will return the number of types registered to the core. You can use it to
* iterate over all types. 
*
Jan Möbius's avatar
Jan Möbius committed
235
* \note Remember that the types are organized in a bitfield!
236 237
*/
DLLEXPORT 
238
size_t typeCount();
239 240 241

/** @} */

242 243 244 245 246
//================================================================================================
/** @name Type iterators
* @{ */
//================================================================================================

247
/// Get iterator pointing to the first element in the types list
248 249 250
DLLEXPORT
std::vector< TypeInfo >::const_iterator typesBegin();

251
/// Get iterator pointing to the last element in the types list
252 253 254 255 256
DLLEXPORT
std::vector< TypeInfo >::const_iterator typesEnd();

/** @} */

257 258 259 260 261
//================================================================================================
/** @name Datatype Name handling
* @{ */
//================================================================================================

262
/// Get DataType Human readable name ( this name might change. Use the typeName instead! )
263 264 265
DLLEXPORT
QString dataTypeName( DataType _id );

266
/// Get DataType Human readable name ( this name might change. Use the typeName instead! )
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
DLLEXPORT
QString dataTypeName( QString _typeName);

/// Set DataType Human readable name
DLLEXPORT
void setDataTypeName( DataType _id, QString _name );

/// Set DataType Human readable name
DLLEXPORT
void setDataTypeName( QString _typeName, QString _name );


/** @} */

//================================================================================================
/** @name Datatype Icons
* @{ */
//================================================================================================

/// Get a string with the filename of the icon for the DataType name
DLLEXPORT
QString typeIconName(QString  _name);

/// Get a string with the filename of the icon for the DataType
DLLEXPORT
QString typeIconName(DataType _id);

294
/** \brief Get an QIcon associated with the given DataType
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
* 
* The icons are loaded once when set and then the reference is returned here.
* This reduces the time when frequently requesting the icons (e.g. DataControl)
*/
DLLEXPORT
QIcon& typeIcon(DataType _id);

/// Set an Icon for a given DataType
DLLEXPORT
void setTypeIcon( DataType _id   , QString _icon);

/// Set an Icon for a given DataType
DLLEXPORT
void setTypeIcon( QString  _name , QString _icon );

/** @} */