ViewerAPI.h

Go to the documentation of this file.

#pragma once
 
#include "Geometry.h"
#include "OldTreeIcon.h"
 
#include "OTCore/Color.h"
#include "OTCore/CoreTypes.h"
#include "OTCore/GenericDataStructMatrix.h"
#include "OTGui/WidgetViewBase.h"
#include "OTGui/PropertyGridCfg.h"
#include "OTGui/Plot1DDataBaseCfg.h"
#include "OTGui/VisualisationTypes.h"
#include "OTGui/TableRange.h"
#include "ViewChangedStates.h"
 
#include <list>
#include <vector>
#include <string>
 
#include <qcolor.h>
 
class Model;
class QPen;
namespace ot { class Property; }
namespace ot { class WidgetView; }
 
namespace ViewerAPI
{
    class __declspec(dllexport) Notifier
    {
    public:
        Notifier() {};
        virtual ~Notifier() {};
 
        virtual void createTree(void) {};
        virtual void clearTree(void) {};
        virtual ot::UID addTreeItem(const std::string &treePath, bool editable, bool selectChildren) { return 0; };
        virtual void removeTreeItems(std::list<ot::UID> treeItemIDList) {};
        virtual void selectTreeItem(ot::UID treeItemID) {};
        virtual void selectSingleTreeItem(ot::UID treeItemID) {};
        virtual void expandSingleTreeItem(ot::UID treeItemID) {};
        virtual bool isTreeItemExpanded(ot::UID treeItemID) { return false; };
        virtual void toggleTreeItemSelection(ot::UID treeItemID, bool considerChilds) {};
        virtual void clearTreeSelection(void) {};
        virtual void setTreeItemIcon(ot::UID treeItemID, int iconSize, const std::string &iconName) {};
        virtual void setTreeItemText(ot::UID treeItemID, const std::string &text) {};
        virtual void refreshSelection(void) {};
        virtual void addKeyShortcut(const std::string &keySequence) {};
        virtual void fillPropertyGrid(const ot::PropertyGridCfg& _configuration) {};
        virtual void setDoublePropertyValue(const std::string& _groupName, const std::string& _itemName, double value) {};
        virtual double getDoublePropertyValue(const std::string& _groupName, const std::string& _itemName) { return 0.0; };
        virtual void lockSelectionAndModification(bool flag) {};
        virtual void removeViewer(ot::UID viewerID) {};
 
        virtual void closeView(const std::string& _entityName, ot::WidgetViewBase::ViewType _viewType) {};
 
        virtual unsigned long long addMenuPage(const std::string &pageName) { return 0; };
        virtual unsigned long long addMenuGroup(unsigned long long menuPageID, const std::string &groupName) { return 0; };
        virtual unsigned long long addMenuPushButton(unsigned long long menuGroupID, const std::string &buttonName, const std::string &iconName) { return 0; };
        virtual unsigned long long addMenuPushButton(unsigned long long menuGroupID, const std::string &buttonName, const std::string &iconName, const std::string &keySequence) { return 0; };
 
        virtual void removeUIElements(std::list<unsigned long long> &itemIDList) {};
        virtual void removeGraphicsElements(ot::UID _modelID) {};
 
        virtual void displayText(const std::string &text) { };
 
        virtual void setCurrentVisualizationTabFromEntityName(const std::string& _entityName, ot::WidgetViewBase::ViewType _viewType) {};
        virtual void setCurrentVisualizationTabFromTitle(const std::string& _tabTitle) {};
        virtual std::string getCurrentVisualizationTabTitle(void) { return ""; };
 
        virtual void enableDisableControls(const ot::UIDList& _enabledControls, const ot::UIDList& _disabledControls) {};
 
        virtual void entitiesSelected(ot::serviceID_t replyTo, const std::string &selectionAction, const std::string &selectionInfo, std::list<std::string> &optionNames, std::list<std::string> &optionValues) {};
 
        virtual void fatalError(const std::string &message) {};
 
        virtual void rubberbandFinished(ot::serviceID_t creatorId, const std::string &note, const std::string &pointJson, const std::vector<double> &transform) {}
 
        virtual void updateSettings(const ot::PropertyGridCfg& _config) {};
 
        virtual void loadSettings(ot::PropertyGridCfg& _config) {};
 
        virtual void saveSettings(const ot::PropertyGridCfg& _config) {};
 
        virtual void updateVTKEntity(unsigned long long modelEntityID) {};
 
        virtual void messageModelService(const std::string& _message) {};
    };
 
    __declspec(dllexport) void registerNotifier(Notifier *notifier);
 
    __declspec(dllexport) ot::UID createModel(void);
    __declspec(dllexport) void activateModel(ot::UID osgModelID);
    __declspec(dllexport) void deactivateCurrentlyActiveModel(void);
    __declspec(dllexport) void deleteModel(ot::UID osgModelID);
 
    __declspec(dllexport) ot::UID getActiveDataModel(void);
    __declspec(dllexport) ot::UID getActiveViewerModel(void);
 
    __declspec(dllexport) ot::UID createViewer(ot::UID osgModelID, double scaleWidth, double scaleHeight, int backgroundR, int backgroundG, int backgroundB, int overlayTextR, int overlayTextG, int overlayTextB);
    __declspec(dllexport) ot::WidgetView* getViewerWidget(ot::UID viewer);
 
    __declspec(dllexport) void resetAllViews1D(ot::UID osgModelID);
    __declspec(dllexport) void resetAllViews3D(ot::UID osgModelID);
    __declspec(dllexport) void refreshAllViews(ot::UID osgModelID);
    __declspec(dllexport) void clearSelection(ot::UID osgModelID);
    __declspec(dllexport) void refreshSelection(ot::UID osgModelID);
    __declspec(dllexport) void selectObject(ot::UID osgModelID, ot::UID entityID);
 
    __declspec(dllexport) void setTreeStateRecording(ot::UID osgModelID, bool flag);
 
    __declspec(dllexport) void setSelectedTreeItems(const std::list<ot::UID>& _selectedTreeItems, std::list<unsigned long long>& _selectedModelItems, std::list<unsigned long long>& _selectedVisibleModelItems, bool _selectionFromTree);
    __declspec(dllexport) void executeAction(unsigned long long buttonID);
 
    __declspec(dllexport) void setHoverTreeItem(ot::UID hoverItemID);
 
    __declspec(dllexport) void addNodeFromFacetData(ot::UID osgModelID, const std::string &treeName, double surfaceColorRGB[3], double edgeColorRGB[3], unsigned long long modelEntityID, const OldTreeIcon &treeIcons, bool backFaceCulling,
                                                    double offsetFactor, bool isEditable, std::vector<Geometry::Node> &nodes, std::list<Geometry::Triangle> &triangles, std::list<Geometry::Edge> &edges, std::map<ot::UID, std::string>& faceNameMap, std::string &errors,
                                                    bool selectChildren, bool manageParentVisibility, bool manageChildVisibility, bool showWhenSelected);
    __declspec(dllexport) void addNodeFromFacetDataBase(ot::UID osgModelID, const std::string &treeName, double surfaceColorRGB[3], double edgeColorRGB[3], const std::string &materialType, const std::string &textureType, bool reflective, unsigned long long modelEntityID, const OldTreeIcon &treeIcons, bool backFaceCulling,
                                                        double offsetFactor, bool isHidden, bool isEditable, const std::string &projectName, unsigned long long entityID, unsigned long long entityVersion,
                                                        bool selectChildren, bool manageParentVisibility, bool manageChildVisibility, bool showWhenSelected, std::vector<double> &transformation);
    __declspec(dllexport) void addMeshNodeFromDataBase(ot::UID osgModelID, const std::string &treeName, double surfaceColorRGB[3], double edgeColorRGB[3], unsigned long long modelEntityID, const OldTreeIcon &treeIcons,
                                                       bool isHidden, const std::string &projectName, unsigned long long entityID, unsigned long long entityVersion);
    __declspec(dllexport) void addMeshItemNodeFromDataBase(ot::UID osgModelID, const std::string &treeName, double surfaceColorRGB[3], double edgeColorRGB[3], unsigned long long modelEntityID, const OldTreeIcon &treeIcons,
                                                           bool isHidden, const std::string &projectName, unsigned long long entityID, unsigned long long entityVersion);
 
    __declspec(dllexport) void addVisualizationContainerNode(ot::UID osgModelID, const std::string &treeName, unsigned long long modelEntityID, const OldTreeIcon &treeIcons, bool editable);
    
    __declspec(dllexport) void addVisualizationNode(ot::UID osgModelID, const std::string &treeName, unsigned long long modelEntityID, const OldTreeIcon &treeIcons, bool editable, ot::VisualisationTypes _visualisationTypes);
    __declspec(dllexport) void addVTKNode(ot::UID osgModelID, const std::string &treeName, unsigned long long modelEntityID, const OldTreeIcon &treeIcons, bool isHidden, bool editable, const std::string &projectName, unsigned long long visualizationDataID, unsigned long long visualizationDataVersion);
    __declspec(dllexport) void updateVTKNode(ot::UID osgModelID, unsigned long long modelEntityID, const std::string &projectName, unsigned long long visualizationDataID, unsigned long long visualizationDataVersion);
 
    __declspec(dllexport) void addVisualizationAnnotationNode(ot::UID osgModelID, const std::string &name, unsigned long long modelEntityID,
                                                              const OldTreeIcon &treeIcons, bool isHidden,
                                                              const double edgeColorRGB[3],
                                                              const std::vector<std::array<double, 3>> &points,
                                                              const std::vector<std::array<double, 3>> &points_rgb,
                                                              const std::vector<std::array<double, 3>> &triangle_p1,
                                                              const std::vector<std::array<double, 3>> &triangle_p2,
                                                              const std::vector<std::array<double, 3>> &triangle_p3,
                                                              const std::vector<std::array<double, 3>> &triangle_rgb);
    __declspec(dllexport) void addVisualizationAnnotationNodeDataBase(ot::UID osgModelID, const std::string &name, unsigned long long modelEntityID, const OldTreeIcon &treeIcons, bool isHidden, const std::string &projectName, unsigned long long entityID, unsigned long long entityVersion);
    __declspec(dllexport) void addVisualizationMeshNodeFromFacetDataBase(ot::UID osgModelID, const std::string &name, unsigned long long modelEntityID, const OldTreeIcon &treeIcons, double edgeColorRGB[3], bool displayTetEdges, const std::string &projectName, unsigned long long entityID, unsigned long long entityVersion);
    __declspec(dllexport) void addVisualizationMeshItemNodeFromFacetDataBase(ot::UID osgModelID, const std::string &name, unsigned long long modelEntityID, const OldTreeIcon &treeIcons, bool isHidden, const std::string &projectName, unsigned long long entityID, unsigned long long entityVersion, long long tetEdgesID, long long tetEdgesVersion);
    __declspec(dllexport) void addVisualizationCartesianMeshNode(ot::UID osgModelID, const std::string &name, unsigned long long modelEntityID, const OldTreeIcon &treeIcons, bool isHidden, double edgeColorRGB[3], double meshLineColorRGB[3], bool showMeshLines, const std::vector<double> &meshCoordsX, const std::vector<double> &meshCoordsY, const std::vector<double> &meshCoordsZ,
                                                                 const std::string &projectName, unsigned long long faceListEntityID, unsigned long long faceListEntityVersion, unsigned long long nodeListEntityID, unsigned long long nodeListEntityVersion);
    __declspec(dllexport) void visualizationCartesianMeshNodeShowLines(ot::UID osgModelID, unsigned long long modelEntityID, bool showMeshLines);
    __declspec(dllexport) void addVisualizationCartesianMeshItemNode(ot::UID osgModelID, const std::string &name, unsigned long long modelEntityID, const OldTreeIcon &treeIcons, bool isHidden, std::vector<int> &facesList, double color[3]);
    __declspec(dllexport) void visualizationTetMeshNodeTetEdges(ot::UID osgModelID, unsigned long long modelEntityID, bool displayTetEdges);
    
    __declspec(dllexport) void notifySceneNodeAboutViewChange(ot::UID osgModelID, const std::string& _sceneNodeName, const ot::ViewChangedStates& _state, const ot::WidgetViewBase::ViewType& _viewType);
 
    __declspec(dllexport) std::list<std::string> getSelectedCurves(ot::UID osgModelID);
    __declspec(dllexport) void removeSelectedCurveNodes(ot::UID osgModelID);
 
    __declspec(dllexport) void addVisualizationPlot1DNode(ot::UID _osgModelID, const ot::Plot1DDataBaseCfg& _config);
 
    __declspec(dllexport) void visualizationResult1DPropertiesChanged(ot::UID _osgModelID, ot::UID _entityID, ot::UID _version);
    __declspec(dllexport) void visualizationPlot1DPropertiesChanged(ot::UID osgModelID, const ot::Plot1DCfg& _config);
 
    __declspec(dllexport) void setEntityName(ot::UID modelEntityID, const std::string &newName);
    __declspec(dllexport) void renameEntityPath(const std::string &oldPath, const std::string &newPath);
 
    __declspec(dllexport) void updateObjectColor(ot::UID osgModelID, unsigned long long modelEntityID, double surfaceColorRGB[3], double edgeColorRGB[3], const std::string& materialType, const std::string& textureType, bool reflective);
    __declspec(dllexport) void updateMeshColor(ot::UID osgModelID, unsigned long long modelEntityID, double colorRGB[3]);
    __declspec(dllexport) void updateObjectFacetsFromDataBase(ot::UID osgModelID, unsigned long long modelEntityID, unsigned long long entityID, unsigned long long entityVersion);
 
    __declspec(dllexport) void setClearColor(ot::UID viewrID, int backgroundR, int backgroundG, int backgroundB, int overlayTextR, int overlayTextG, int overlayTextB);
 
    __declspec(dllexport) void setDataModel(ot::UID osgModelID, ot::UID dataModelID);
 
    __declspec(dllexport) void getSelectedModelEntityIDs(std::list<unsigned long long> &selected);
    __declspec(dllexport) void getSelectedVisibleModelEntityIDs(std::list<unsigned long long> &selected);
    __declspec(dllexport) ot::UID getModelEntityIDFromTreeID(ot::UID treeID);
    __declspec(dllexport) ot::UID getTreeIDFromModelEntityID(ot::UID treeID);
 
    __declspec(dllexport) void removeShapes(ot::UID osgModelID, std::list<unsigned long long> modelEntityID);
    __declspec(dllexport) void setShapeVisibility(ot::UID osgModelID, std::list<unsigned long long> visibleID, std::list<unsigned long long> hiddenID);
    __declspec(dllexport) void hideEntities(ot::UID osgModelID, std::list<unsigned long long> hiddenID);
 
    __declspec(dllexport) void showBranch(ot::UID osgModelID, const std::string &branchName);
    __declspec(dllexport) void hideBranch(ot::UID osgModelID, const std::string &branchName);
 
    __declspec(dllexport) void enterEntitySelectionMode(ot::UID osgModelID, ot::serviceID_t replyTo, const std::string &selectionType, bool allowMultipleSelection, const std::string &selectionFilter, const std::string &selectionAction, const std::string &selectionMessage, std::list<std::string> &optionNames, std::list<std::string> &optionValues);
 
    __declspec(dllexport) void setFontPath(const std::string &fontPath);
 
    __declspec(dllexport) void setDataBaseConnection(const std::string &databaseURL, const std::string &userName, const std::string &password);
 
    __declspec(dllexport) void prefetchDocumentsFromStorage(const std::string &projectName, std::list<std::pair<unsigned long long, unsigned long long>> &prefetchIDs);
 
    __declspec(dllexport) void setTabNames(ot::UID _viewerID, const std::string & _osgViewTabName, const std::string & _plotTabName, const std::string & _versionGraphTabName);
 
    __declspec(dllexport) ot::WidgetView* getPlotWidget(ot::UID _viewerID);
    
    /********************************************************************************************/
 
    __declspec(dllexport) void viewerTabChanged(const std::string& _tabTitle, ot::WidgetViewBase::ViewType _type);
 
    __declspec(dllexport) void shortcutActivated(const std::string & _keySequence);
 
    __declspec(dllexport) void createRubberband(ot::UID _viewerID, ot::serviceID_t _senderId, std::string & _note, const std::string & _configurationJson);
 
    __declspec(dllexport) void settingsItemChanged(ot::UID _viewerID, const ot::Property* _property);
 
    __declspec(dllexport) bool propertyGridValueChanged(ot::UID _viewerID, const ot::Property* _property);
 
    __declspec(dllexport) void freeze3DView(unsigned long long osgModelID, bool flag);
 
    Model *getModelFromID(ot::UID osgModelID);
}