PluginFunctions.hh

Go to the documentation of this file.

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

/*===========================================================================*\
 *                                                                           *
 *   $Revision: 7323 $                                                         *
 *   $Author: moebius $                                                      *
 *   $Date: 2009-10-06 14:46:06 +0200 (Di, 06. Okt 2009) $                   *
 *                                                                           *
\*===========================================================================*/




//=============================================================================
//
//  Standard Functions
//
//=============================================================================

//
#ifndef PLUGINFUNCTIONS_HH
#define PLUGINFUNCTIONS_HH

#include <QPair>

#include <OpenFlipper/common/Types.hh>

#include <ACG/Scenegraph/SceneGraph.hh>
#include <OpenFlipper/BasePlugin/PluginFunctionsViewControls.hh>

//== FORWARDDECLARATIONS ======================================================
class ViewObjectMarker;
class QGLWidget;

namespace PluginFunctions {

//=======================================
// Get Source/Target objects
//=======================================

DLLEXPORT
bool getPickedObject(const unsigned int _node_idx , BaseObjectData*& _object);

//=======================================
// Get Objects by their identifier
//=======================================

DLLEXPORT
bool getSourceIdentifiers( std::vector<int>& _identifiers  );

DLLEXPORT
bool getTargetIdentifiers( std::vector<int>& _identifiers  );

DLLEXPORT
bool getAllMeshes( std::vector<int>& _identifiers  );

DLLEXPORT
bool getAllObjectIdentifiers( std::vector<int>& _identifiers  );


DLLEXPORT
bool getObject(  const int _identifier , BaseObject*& _object );

DLLEXPORT
bool getObject(  const int _identifier , BaseObjectData*& _object );

DLLEXPORT
int getObjectId( const QString _name );

DLLEXPORT
bool objectExists(  const int _identifier );

DLLEXPORT
int objectCount();

DLLEXPORT
int targetCount();

DLLEXPORT
int sourceCount();

DLLEXPORT
int visibleCount();

//=======================================
// Get/set status of examiner
//=======================================


DLLEXPORT
int viewers( );

DLLEXPORT
void setActiveExaminer( const unsigned int _id );

DLLEXPORT
unsigned int activeExaminer();

DLLEXPORT
QString getEncodedExaminerView();

DLLEXPORT
QString getEncodedExaminerView(int _viewerId);

DLLEXPORT
void setEncodedExaminerView( QString _view );

DLLEXPORT
void setEncodedExaminerView(int _viewerId , QString _view );

DLLEXPORT
void setSceneCenter(const ACG::Vec3d& _center, int _viewer );

DLLEXPORT
const ACG::Vec3d& sceneCenter( int _viewer );

DLLEXPORT
bool scenegraphPick( ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, unsigned int &_nodeIdx, unsigned int &_targetIdx, ACG::Vec3d *_hitPointPtr );

DLLEXPORT
bool scenegraphPick( const unsigned int _examiner ,ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, unsigned int &_nodeIdx, unsigned int &_targetIdx, ACG::Vec3d *_hitPointPtr );

DLLEXPORT
bool scenegraphRegionPick( ACG::SceneGraph::PickTarget                _pickTarget,
                           const QRegion&                             _region,
                           QList<QPair<unsigned int, unsigned int> >& _list);

DLLEXPORT
bool scenegraphRegionPick( const unsigned int                         _examiner,
                           ACG::SceneGraph::PickTarget                _pickTarget,
                           const QRegion&                             _region,
                           QList<QPair<unsigned int, unsigned int> >& _list);


DLLEXPORT
void traverse( ACG::SceneGraph::MouseEventAction  &_action );

void traverse(  const unsigned int _examiner, ACG::SceneGraph::MouseEventAction  &_action );

DLLEXPORT
const std::string pickMode ();

DLLEXPORT
void pickMode ( std::string _mode);

DLLEXPORT
void getCurrentViewImage(QImage& _image);

DLLEXPORT
ACG::SceneGraph::BaseNode* getSceneGraphRootNode();

DLLEXPORT
ACG::SceneGraph::BaseNode* getRootNode();

DLLEXPORT
void addGlobalNode(ACG::SceneGraph::BaseNode* _node);

DLLEXPORT
void addObjectRenderingNode(ACG::SceneGraph::BaseNode* _node);

DLLEXPORT
void actionMode ( Viewer::ActionMode _mode);

DLLEXPORT
Viewer::ActionMode actionMode();

DLLEXPORT
void shareGLWidget (QGLWidget* _widget);

DLLEXPORT
QGLWidget* shareGLWidget ();

DLLEXPORT
void allowRotation(bool _mode);

DLLEXPORT
QPoint mapToGlobal( const QPoint _point );

DLLEXPORT
QPoint mapToLocal( const QPoint _point );

DLLEXPORT
void setViewObjectMarker (ViewObjectMarker *_marker);

DLLEXPORT
void setDefaultViewObjectMarker (ViewObjectMarker *_marker);

DLLEXPORT
ViewObjectMarker* defaultViewObjectMarker ();

//=======================================
// Iterators for object Access
//=======================================

typedef QStringList IteratorRestriction;

const QStringList ALL_OBJECTS;
const QStringList TARGET_OBJECTS ("target");
const QStringList SOURCE_OBJECTS ("source");

class DLLEXPORT ObjectIterator {

   public :

      typedef BaseObjectData  value_type;

      typedef BaseObjectData* value_handle;

      typedef value_type&     reference;

      typedef value_type*     pointer;

   ObjectIterator(IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );

   ObjectIterator(BaseObjectData* pos, IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );

   operator value_handle() { return pos_;  };

   bool operator==( const ObjectIterator& _rhs);

   bool operator!=( const ObjectIterator& _rhs);

   ObjectIterator& operator=( const ObjectIterator& _rhs);

   pointer operator->();

   ObjectIterator& operator++();

   ObjectIterator& operator--();

   BaseObjectData* operator*();

   BaseObjectData* index() { return pos_; };

   private :
      BaseObjectData* pos_;

      DataType dataType_;

      IteratorRestriction restriction_;

      inline void proceedToNextBaseObjectData(BaseObject*& _object);

};

class DLLEXPORT BaseObjectIterator {

   public :

      typedef BaseObject  value_type;

      typedef BaseObject* value_handle;

      typedef value_type&     reference;

      typedef value_type*     pointer;

   BaseObjectIterator(IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );

   BaseObjectIterator(BaseObject* pos, IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );

   operator value_handle() { return pos_;  };

   bool operator==( const BaseObjectIterator& _rhs);

   bool operator!=( const BaseObjectIterator& _rhs);

   BaseObjectIterator& operator=( const BaseObjectIterator& _rhs);

   pointer operator->();

   BaseObjectIterator& operator++();

   BaseObjectIterator& operator--();

   BaseObject* operator*();

   BaseObject* index() { return pos_; };

   private :
      BaseObject* pos_;

      DataType dataType_;

      IteratorRestriction restriction_;

};

// /// Return Iterator to Mesh End
// MeshIterator meshes_end();

DLLEXPORT
ObjectIterator objectsEnd();

DLLEXPORT
BaseObjectIterator baseObjectsEnd();

//=======================================
// Dont Use functions below!!!
//=======================================

DLLEXPORT
void setDataRoot( BaseObject* _root );

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

DLLEXPORT
BaseObjectData* baseObjectData( BaseObject* _object );

DLLEXPORT
int viewerId();

DLLEXPORT
BaseObject*& objectRoot();

}

#endif //PLUGINFUNCTIONS_HH