PluginFunctions.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.              *
*                                                                            *
\*===========================================================================*/
 
//=============================================================================
//
//  Standard Functions
//
//=============================================================================
 
#pragma once
 
 
#include <QPair>
#include <QFileDialog>
 
#include <OpenFlipper/common/Types.hh>
#include <OpenFlipper/common/OFGLWidget.hh>
 
#include <ACG/Scenegraph/SceneGraph.hh>
#include <OpenFlipper/BasePlugin/PluginFunctionsViewControls.hh>
 
//== FORWARDDECLARATIONS ======================================================
class ViewObjectMarker;
 
namespace PluginFunctions {
 
//=======================================
// Get Source/Target objects
//=======================================
 
DLLEXPORT
bool getPickedObject(const size_t _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 getAllObjectIdentifiers( std::vector<int>& _identifiers  );
 
DLLEXPORT
bool getAllMeshes( 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 disableExaminerLightHandling();
 
DLLEXPORT
bool examinerLightHandling();
 
DLLEXPORT
void setActiveExaminer( const unsigned int _id );
 
DLLEXPORT
unsigned int activeExaminer();
 
DLLEXPORT
QString getEncodedExaminerView();
 
DLLEXPORT
QString getEncodedExaminerView(int _viewerId);
 
DLLEXPORT
void setEncodedExaminerView(const QString &_view );
 
DLLEXPORT
void setEncodedExaminerView(int _viewerId , QString _view );
 
DLLEXPORT
void setSceneCenter(const ACG::Vec3d& _center, int _viewer );
 
DLLEXPORT
bool scenegraphPick( ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, size_t &_nodeIdx, size_t &_targetIdx, ACG::Vec3d *_hitPointPtr );
 
DLLEXPORT
bool scenegraphPick( const unsigned int _examiner ,ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, size_t &_nodeIdx, size_t &_targetIdx, ACG::Vec3d *_hitPointPtr );
 
DLLEXPORT
bool scenegraphPick( const unsigned int _examiner ,ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, BaseObjectData*& _object, size_t &_targetIdx, const bool _refine ,ACG::Vec3d *_hitPointPtr );
 
DLLEXPORT
bool scenegraphPick( ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, BaseObjectData*& _object, size_t &_targetIdx, const bool _refine, ACG::Vec3d *_hitPointPtr );
 
 
DLLEXPORT
bool scenegraphRegionPick( ACG::SceneGraph::PickTarget                _pickTarget,
                           const QRegion&                             _region,
                           QList<QPair<size_t, size_t> >&             _list,
                           QVector<float>*                            _depths = 0,
                           QVector<ACG::Vec3d>*                       _points = 0);
 
DLLEXPORT
bool scenegraphRegionPick( const unsigned int                         _examiner,
                           ACG::SceneGraph::PickTarget                _pickTarget,
                           const QRegion&                             _region,
                           QList<QPair<size_t, size_t> >&             _list,
                           QVector<float>*                            _depths = 0,
                           QVector<ACG::Vec3d>*                       _points = 0);
 
DLLEXPORT
void traverse( ACG::SceneGraph::MouseEventAction  &_action );
 
DLLEXPORT
const std::string pickMode ();
 
DLLEXPORT
void pickMode ( const 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 addGlobalStatusNode(ACG::SceneGraph::BaseNode* _node);
 
DLLEXPORT
void addObjectRenderingNode(ACG::SceneGraph::BaseNode* _node);
 
DLLEXPORT
void actionMode ( Viewer::ActionMode _mode);
 
DLLEXPORT
Viewer::ActionMode actionMode();
 
DLLEXPORT
void shareGLWidget(OFGLWidget* _widget);
 
DLLEXPORT
OFGLWidget* 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
QStringList collectObjectComments(bool visibleOnly, bool targetedOnly);
 
DLLEXPORT
QStringList collectObjectMaterials(bool visibleOnly, bool targetedOnly);
 
DLLEXPORT
ViewObjectMarker* defaultViewObjectMarker ();
 
DLLEXPORT
QPoint adjustForDevicePixelRatio(QPoint const & point);
DLLEXPORT
QPointF adjustForDevicePixelRatio(QPointF const & point);
 
//=======================================
// 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(const IteratorRestriction &_restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );
 
   ObjectIterator(BaseObjectData* pos, const IteratorRestriction &_restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );
 
   ObjectIterator(const ObjectIterator &) = default;
 
   operator value_handle() { return pos_;  };
 
   bool operator==( const ObjectIterator& _rhs) const;
 
   bool operator!=( const ObjectIterator& _rhs) const;
 
   ObjectIterator& operator=( const ObjectIterator&) = default;
 
   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 ObjectReferenceIterator
{
public:
    using iterator_category = std::forward_iterator_tag;
    using value_type = BaseObjectData;
    using difference_type = std::ptrdiff_t;
    using pointer = BaseObjectData*;
    using reference = BaseObjectData&;
 
    explicit ObjectReferenceIterator(IteratorRestriction _restriction = ALL_OBJECTS, DataType _dataType = DATA_ALL) :
        it_(_restriction, _dataType)
    {
    }
 
    explicit ObjectReferenceIterator(BaseObjectData* _pos, IteratorRestriction _restriction = ALL_OBJECTS, DataType _dataType = DATA_ALL) :
        it_(_pos, _restriction, _dataType)
    {
    }
 
    ObjectReferenceIterator(const ObjectReferenceIterator& _rhs) :
        it_(_rhs.it_)
    {
    }
 
    ObjectReferenceIterator& operator=(const ObjectReferenceIterator& _rhs)
    {
        if (this != &_rhs) {
            it_ = _rhs.it_;
        }
        return *this;
    }
 
    ObjectReferenceIterator& operator++() {
        ++it_;
        return *this;
    }
 
    ObjectReferenceIterator operator++(int) {
        ObjectReferenceIterator copy(*this);
        operator++();
        return copy;
    }
 
    bool operator==(const ObjectReferenceIterator& _rhs) const {
        return it_ == _rhs.it_;
    }
 
    bool operator!=(const ObjectReferenceIterator& _rhs) const {
        return it_ != _rhs.it_;
    }
 
    BaseObjectData& operator*() {
        return **it_;
    }
 
    BaseObjectData* operator->() {
        return *it_;
    }
 
private:
    ObjectIterator it_;
};
 
 
class DLLEXPORT ObjectRange {
public:
    explicit ObjectRange(IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL) :
        restriction_(_restriction),
        dataType_(_dataType)
    {
    }
 
    ObjectIterator begin() const {
        return ObjectIterator(restriction_, dataType_);
    }
 
    ObjectIterator end() const {
        return ObjectIterator(0);
    }
 
private:
    IteratorRestriction restriction_;
    DataType dataType_;
};
 
 
class DLLEXPORT ObjectReferenceRange {
public:
    explicit ObjectReferenceRange(IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL) :
        restriction_(_restriction),
        dataType_(_dataType)
    {
    }
 
    ObjectReferenceIterator begin() const {
        return ObjectReferenceIterator(restriction_, dataType_);
    }
 
    ObjectReferenceIterator end() const {
        return ObjectReferenceIterator(0);
    }
 
private:
    IteratorRestriction restriction_;
    DataType dataType_;
};
 
 
DLLEXPORT
ObjectReferenceRange objectReferences(IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL);
 
 
DLLEXPORT
ObjectRange objects(IteratorRestriction _restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL);
 
 
class DLLEXPORT BaseObjectIterator {
 
   public :
 
      typedef BaseObject  value_type;
 
      typedef BaseObject* value_handle;
 
      typedef value_type&     reference;
 
      typedef value_type*     pointer;
 
   BaseObjectIterator(const IteratorRestriction &_restriction = ALL_OBJECTS , DataType _dataType = DATA_ALL );
 
   BaseObjectIterator(BaseObject* pos, const 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();
 
DLLEXPORT
#if QT_VERSION < QT_VERSION_CHECK(5, 15, 0)
QString getOpenFileName(const QString &configProperty,
                        QWidget * parent = nullptr, const QString & caption = QString(),
                        const QString & defaultDir = QString(), const QString & filter = QString(),
                        QString * selectedFilter = nullptr, QFileDialog::Options options = 0);
#else
QString getOpenFileName(const QString &configProperty,
                        QWidget * parent = nullptr, const QString & caption = QString(),
                        const QString & defaultDir = QString(), const QString & filter = QString(),
                        QString * selectedFilter = nullptr, QFileDialog::Options options = QFileDialog::Options() );
#endif
 
 
DLLEXPORT
#if QT_VERSION < QT_VERSION_CHECK(5, 15, 0)
QString getSaveFileName(const QString &configProperty,
                        QWidget * parent = nullptr, const QString & caption = QString(),
                        const QString & defaultDir = QString(), const QString & filter = QString(),
                        QString * selectedFilter = nullptr, QFileDialog::Options options = 0,
                        const QString & defaultSuffix = QString() );
#else
QString getSaveFileName(const QString &configProperty,
                        QWidget * parent = nullptr, const QString & caption = QString(),
                        const QString & defaultDir = QString(), const QString & filter = QString(),
                        QString * selectedFilter = nullptr, QFileDialog::Options options = QFileDialog::Options(),
                        const QString & defaultSuffix = QString() );
#endif
 
 
} /* namespace PluginFunctions */