DataTypes.hh

Go to the documentation of this file.

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           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.              *
*                                                                            *
\*===========================================================================*/

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

#pragma once

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


#include <OpenFlipper/common/GlobalDefines.hh>
#include <OpenFlipper/common/UpdateType.hh>

#include <ACG/Math/Matrix4x4T.hh>
#include <ACG/Math/VectorT.hh>
#include <climits>
#include <QIcon>
#include <QMetaType>

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

class DLLEXPORT DataType  {
  public:
    DataType();
    DataType(const unsigned int& _i);
    DataType(const DataType& _i ) = default;

    bool operator!=( const unsigned int& _i ) const;
    bool operator!=( const DataType& _i ) const;
    
    bool operator==( const unsigned int& _i ) const;
    bool operator==(  const DataType& _i ) const;
    
    DataType& operator=( const unsigned int& _i );

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

    bool operator<( const unsigned int& _i ) const;
    bool operator<( const DataType& _i ) const;
    
    DataType& operator|=( const unsigned int& _i );
    DataType& operator|=( const DataType& _i );    
    
    bool operator&( const unsigned int& _i ) const;
    bool operator&( const DataType& _i ) const;

    DataType operator!();
    
    bool contains( const DataType& _i ) const;
    
    DataType operator|( const DataType& _i ) const;

    DataType operator++(int _unused);

    DataType& operator++();

    unsigned int value() const;
      
    QString name() const;
 
  private:
    unsigned int field;
};

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

  DataType type;

  QString  name;

  QString  iconName;

  QIcon    icon;

  QString readableName;
};

const DataType DATA_ALL(UINT_MAX);

const DataType DATA_UNKNOWN(0);

const DataType DATA_GROUP(1);

std::ostream &operator<<(std::ostream &stream, DataType type);


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

typedef ACG::Vec3d Vector;

typedef ACG::Vec4d Vector4;
typedef std::vector< int > IdList;
typedef ACG::Matrix4x4d Matrix4x4;

Q_DECLARE_METATYPE(IdList)
Q_DECLARE_METATYPE(DataType)
Q_DECLARE_METATYPE(QVector< int >)
Q_DECLARE_METATYPE(Vector)
Q_DECLARE_METATYPE(Vector4)
Q_DECLARE_METATYPE(Matrix4x4)
Q_DECLARE_METATYPE(UpdateType)


DLLEXPORT
void registerTypes();

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

DLLEXPORT
DataType addDataType(QString _name, QString _readableName);

DLLEXPORT
DataType typeId(QString _name);

DLLEXPORT
QString typeName(DataType _id);

DLLEXPORT
bool typeExists( QString _name );

DLLEXPORT 
size_t typeCount();

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

DLLEXPORT
std::vector< TypeInfo >::const_iterator typesBegin();

DLLEXPORT
std::vector< TypeInfo >::const_iterator typesEnd();

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

DLLEXPORT
QString dataTypeName( DataType _id );

DLLEXPORT
QString dataTypeName( QString _typeName);

DLLEXPORT
void setDataTypeName( DataType _id, QString _name );

DLLEXPORT
void setDataTypeName( QString _typeName, QString _name );


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

DLLEXPORT
QString typeIconName(QString  _name);

DLLEXPORT
QString typeIconName(DataType _id);

DLLEXPORT
QIcon& typeIcon(DataType _id);

DLLEXPORT
void setTypeIcon( DataType _id   , QString _icon);

DLLEXPORT
void setTypeIcon( QString  _name , QString _icon );