TypeInterface.hh 4.48 KB
Newer Older
1 2 3 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
/*===========================================================================*\
 *                                                                           *
 *                              OpenFlipper                                  *
 *      Copyright (C) 2001-2009 by Computer Graphics Group, RWTH Aachen      *
 *                           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/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
37 38 39
 *   $Revision$                                                         *
 *   $Author$                                                      *
 *   $Date$                   *
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
 *                                                                           *
\*===========================================================================*/


#ifndef TYPEINTERFACE_HH
#define TYPEINTERFACE_HH

#include <OpenFlipper/common/Types.hh>

 /** \brief Interface class for type definitions
  *
  * This interface is used to register new types in OpenFlipper. The type plugins are loaded before all other plugins.
  * They have only the registerType function which registers the type to the core. The type itself has to be
  * defined in the ObjectTypes subdirectory.
 */

class TypeInterface {

58 59 60 61 62 63 64
  signals:
    
    /** \brief Emit this signal if an empty object has been created
       * @param _id Id of the added object
       */
      virtual void emptyObjectAdded( int /*_id*/ ) {};
  
65 66 67
  public:

    /// Destructor
68 69 70
    virtual ~TypeInterface() {};
    
  public slots:
71 72

    virtual bool registerType() = 0;
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
    
    /** \brief Create an empty object
       *
       * When this slot is called you have to create an object of your supported type.
       * @param _type Data type of object that will be created
       * @return Id of the new Object
       */
    virtual int addEmpty() = 0;
    
    /** \brief Return your supported object type( e.g. DATA_TRIANGLE_MESH )
    *
    * If you support multiple datatypes you can use the bitwise or to combine them here.
    * The function is used from addEmpty to check if your plugin can create an object of
    * a given dataType.
    */
    virtual DataType supportedType() = 0;
89 90 91 92 93
};

Q_DECLARE_INTERFACE(TypeInterface,"OpenFlipper.TypeInterface/1.0")

#endif // TYPEINTERFACE_HH