DataTypes.hh 10.4 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2
3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
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
*                           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/>.                                       *
*                                                                            *
33
34
35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36
37
38
39
40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
\*===========================================================================*/




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

/**
 * \file DataTypes.hh
 * This File contains the basic type informations
 */


#ifndef DATATYPES_HH
#define DATATYPES_HH

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


#include <OpenFlipper/common/GlobalDefines.hh>

#include <ACG/Math/Matrix4x4T.hh>
#include <ACG/Math/VectorT.hh>
68
#include <climits>
69
70
71
72
73
74
75
76
77
78
79
#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.
*/

80
81
/** \brief the internal DataType class
*
82
* Normally we could use an unsigned int here. But QT can't register an
83
84
* 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
85
* To overcome this Problem, we reimplement a wrapper around the int and provide additional
86
87
* functionality such as returning the name of the type directly
*/ 
Jan Möbius's avatar
Jan Möbius committed
88
class DLLEXPORT DataType  {
89
90
91
92
  public:
    DataType();
    DataType(const unsigned int& _i);
    
Matthias Möller's avatar
Matthias Möller committed
93
94
    bool operator!=( const unsigned int& _i ) const;
    bool operator!=( const DataType& _i ) const;
95
    
Matthias Möller's avatar
Matthias Möller committed
96
97
    bool operator==( const unsigned int& _i ) const;
    bool operator==(  const DataType& _i ) const;
98
    
99
100
    DataType& operator=( const unsigned int& _i );
    DataType& operator=( const DataType& _i );
101
    
Matthias Möller's avatar
Matthias Möller committed
102
    bool operator<( const unsigned int& _i ) const;
103
104
    bool operator<( const DataType& _i ) const;
    
Jan Möbius's avatar
Jan Möbius committed
105
106
    DataType& operator|=( const unsigned int& _i );
    DataType& operator|=( const DataType& _i );    
Jan Möbius's avatar
Jan Möbius committed
107
    
Matthias Möller's avatar
Matthias Möller committed
108
    bool operator&( const unsigned int& _i ) const;
109
    bool operator&( const DataType& _i ) const;
110
111
112

    DataType operator!();
    
Matthias Möller's avatar
Matthias Möller committed
113
    bool contains( const DataType& _i ) const;
114
    
115
116
    DataType operator|( const DataType& _i ) const;

117
118
119
120
    DataType operator++(int _unused);

    DataType& operator++();

121
122
123
124
125
126
127
    /** 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
Matthias Möller's avatar
Matthias Möller committed
128
    QString name() const;
129
130
131
132
133
 
  private:
    unsigned int field;
};

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
161
162
163
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;
};

164
165
166
/// Identifier for all available objects
const DataType DATA_ALL(UINT_MAX);

167
/// None of the other Objects
168
const DataType DATA_UNKNOWN(0);
169
170

/// Items used for Grouping
171
const DataType DATA_GROUP(1);
172

173
std::ostream &operator<<(std::ostream &stream, DataType type);
174
175
176
177
178
179


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

/// Standard Type for 3d Vector used for scripting
typedef ACG::Vec3d Vector;
Jan Möbius's avatar
Jan Möbius committed
180
181
182

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

Mike Kremer's avatar
Mike Kremer committed
188
189
190
191
Q_DECLARE_METATYPE(IdList)
Q_DECLARE_METATYPE(DataType)
Q_DECLARE_METATYPE(QVector< int >)
Q_DECLARE_METATYPE(Vector)
Jan Möbius's avatar
Jan Möbius committed
192
Q_DECLARE_METATYPE(Vector4)
Mike Kremer's avatar
Mike Kremer committed
193
Q_DECLARE_METATYPE(Matrix4x4)
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

//================================================================================================
/** @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);

220
221
222
223
224
225
/** \brief Check if a type with the given name exists
*
*/
DLLEXPORT
bool typeExists( QString _name );

226
227
228
229
230
/** \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
231
* \note Remember that the types are organized in a bitfield!
232
233
*/
DLLEXPORT 
234
size_t typeCount();
235
236
237

/** @} */

238
239
240
241
242
//================================================================================================
/** @name Type iterators
* @{ */
//================================================================================================

243
/// Get iterator pointing to the first element in the types list
244
245
246
DLLEXPORT
std::vector< TypeInfo >::const_iterator typesBegin();

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

/** @} */

253
254
255
256
257
//================================================================================================
/** @name Datatype Name handling
* @{ */
//================================================================================================

258
/// Get DataType Human readable name ( this name might change. Use the typeName instead! )
259
260
261
DLLEXPORT
QString dataTypeName( DataType _id );

262
/// Get DataType Human readable name ( this name might change. Use the typeName instead! )
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
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);

290
/** \brief Get an QIcon associated with the given DataType
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
* 
* 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 );

/** @} */





//=============================================================================
#endif // DATATYPES_HH defined
//=============================================================================