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

#pragma once

#include <OpenFlipper/common/Types.hh>


class BaseInterface {

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

  private slots:
      virtual void initializePlugin() {};

      virtual void pluginsInitialized() {};

      virtual void pluginsInitialized(QVector<QPair<QString, QString>> const& _pluginOptions) {};


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

  signals :
    virtual void updateView() {};

    virtual void blockScenegraphUpdates(bool _block) {};

    virtual void updatedObject(int _objectId) {};

    virtual void updatedObject(int _identifier, const UpdateType& _type) {};
    
    virtual void nodeVisibilityChanged( int _identifier ) {};

  private slots:

    virtual void slotObjectUpdated( int _identifier ) {};

    virtual void slotObjectUpdated( int _identifier, const UpdateType& _type ) {};

    virtual void slotAllCleared( ) {};

    virtual void slotObjectSelectionChanged( int _identifier ) {};

    virtual void slotVisibilityChanged( int _identifier ) {};

    virtual void slotObjectPropertiesChanged( int _identifier ) {};
    
    virtual void slotViewChanged() {};

    virtual void slotSceneDrawn() {};

    virtual void slotDrawModeChanged(int _viewerId) {};
  //===========================================================================
  //===========================================================================
  public :

    virtual QString name() = 0;

    virtual QString description() = 0;

  public slots:
      virtual QString version() { return QString("-1"); };

  signals:

      virtual void setSlotDescription(QString     _slotName    ,   QString     _slotDescription,
                                      QStringList _parameters  , QStringList _descriptions) {};

  //===========================================================================
  //===========================================================================
  signals:

     virtual void setRenderer(unsigned int _viewer, QString _rendererName) {};

     virtual void getCurrentRenderer(unsigned int _viewer, QString& _rendererName) {};

  public slots :

    virtual void exit(){};

    virtual void noguiSupported( ) {} ;

  public :

    virtual ~BaseInterface() {};

};


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