MainPage   Related pages 
ProjectAPI.h
1 
2 //
3 // $Id: ProjectAPI.h 4129 2020-10-27 11:15:57Z ansgar.horstmann $
4 // (c) ceapoint aec technologies GmbH
5 //
6 
7 
8 #pragma once
9 
10 
11 #include <domainBim/AutomationAPI.h>
12 #include <xqtgl/xQGLView.h>
13 
14 
15 
16 namespace desiteCore
17 {
18  class NavigatorProject;
19 
20  enum eElementVisibilityMode {
21  evMode_show,
22  evMode_showExclusively,
23  evMode_hide
24  };
25 
40  {
41  Q_OBJECT
42 
43  public:
44 
45 
47  explicit ProjectAPI(NavigatorProject* np, QObject* parent = 0);
48  virtual ~ProjectAPI();
50 
51 
52  public slots:
53 
67  int message(QString);
68 
77  bool sendRemoteMessage(QString message);
78 
79 
80 #pragma region TOOLS
81 
93  void startEXE(QString prg, QString args);
94 
100  void showOnScreenKeyboard();
101 
117  void openLink( QString url, bool useDesktopService );
118 
141  QString showOpenFileDialog( QString caption = "", QString directory = "", QString filter = "" );
142 
157  QString showSaveFileDialog( QString caption = "", QString directory = "", QString filter = "" );
158 
159 
161 #pragma endregion
162 
163 
164 #pragma region PROJECT
165 
174  void openProject( QString url, bool useSessionData );
175 
185  int saveProject();
186 
200  int saveCPA( QString cpa_filename, QString pack_bookmark );
201 
202  // ah: hidden until documented and properly implemented
203  // since, supported domains, error codes
205  int saveDomain( QString domainName );
221  QVariant importModel( QString filename, bool showDialog = true, QVariantMap options = QVariantMap() );
222 
244  QString exportBCF(QStringList sourceIds, QString targetPath, QString targetFileBaseName, QString bcfVersion = "2.1");
245 
255  bool importBCF(QString sourceFilePath);
256 
258 #pragma endregion
259 
260 
261 #pragma region FILTER OBJECTS
262 
268  void filterElements(QString pName, QString pType, QString pattern, bool checkInh = true, QString domainCombination = "geometry" );
269 
271 #pragma endregion
272 
273 
274 #pragma region MATERIALS
275 
287  int showColorSchema(QString name);
288 
290 #pragma endregion
291 
292 
293 #pragma region VISIBILITY, SELECTION
294 
301  void showAll(bool repaint, QString domainCombination = "geometry" );
302 
309  void hideAll(bool repaint, QString domainCombination = "geometry" );
310 
319  void showElements( QString idList, bool includeBlocked = false, QString domainCombination = "geometry" );
320 
328  void showElementsOnly( QString idList, QString domainCombination = "geometry");
329 
338  void hideElements( QString idList, bool ignoreObjectLocking = false, QString domainCombination = "geometry" );
339 
348  void clearSelection( bool repaint, QString domainCombination = "geometry" );
349 
354  void selectVisible();
355 
360  void selectVisibleGeometric();
361 
370  void selectElements( QString idList, bool flag, QString domainCombination = "geometry" );
371 
380  void zoomToSelected();
381 
390  void zoomToVisible();
391 
402  void zoomToObjects( QString objIDs );
403 
408  void zoomToAllDocuments();
409 
415 
420  void zoomToVisibleDocuments();
421 
429  void zoomToDocuments( QStringList idList );
430 
435  void zoomToAllResources();
436 
442 
446  void zoomToVisibleResources();
447 
452  void zoomToResources( QStringList idList );
453 
458  void zoomToLocationGK( double rw, double hw, double h);
459 
464  void zoomToLocationGps( double lat, double lon );
465 
470  void moveToLocationGps( double lat, double lon );
471 
476  void zoomTopView();
477 
489  QString getAll( QString domainFilter = "geometry" );
490 
502  QStringList getAllElements( QString domainFilter = "geometry" );
503 
515  QString getVisible( QString domainFilter = "geometry" );
516 
528  QStringList getVisibleElements( QString domainFilter = "geometry" );
529 
539  bool hasVisible( QString domainFilter = "all" );
540 
549  int countVisible( QString domainFilter = "geometry" );
550 
562  QString getSelected( QString domainFilter = "geometry" );
563 
575  QStringList getSelectedElements( QString domainFilter = "geometry" );
576 
577 
587  bool hasSelected( QString domainFilter = "all" );
588 
598  int countSelected( QString domainFilter = "geometry" );
599 
609  void setVisualisationMode(int mode, bool repaint = true );
610 
614  int getVisualisationMode();
615 
632  QVariantMap showElementsOOBBSide( QString IDList, double prec = 1.e-2 );
633 
644  QVariantMap showElementsOOBBTop( QString IDList, double prec = 1.e-2 );
645 
656  QVariantMap showElementsOOBBFront( QString idList, double prec = 1.e-2 );
657 
667  void showDimensionsPainter( bool showAABB, bool showOOBB );
668 
673  void hideDimensionsPainter();
674 
679  void repaint3DView();
680 
682 #pragma endregion
683 
684 
685 #pragma region VIEWPOINTS
686 
698  int showViewpoint(QString name);
699 
710  int showViewpointByID(QString id);
711 
737  QVariantMap getViewpointList();
738 
759  QVariantMap getViewpointMetadata( QString id );
760 
766  void addToViewPoint( QString vpID, QString objIdList );
767 
773  void removeFromViewPoint( QString vpID, QString objIdList );
774 
788  QString saveViewpoint(QString name, bool saveVisible = true, bool saveSelected = false, QString desc = QString(), bool saveRedlining = false, bool copyMeasureItems = false );
789 
794  bool deleteViewpointByID( QString id );
795 
800  bool deleteAllViewpoints();
801 
829  QString getCurrentViewAsImage();
830 
846  bool saveCurrentViewToFile( QString filename );
847 
928  QVariantMap getViewpointAsJsonObject( const QString& vpID, const QStringList& blacklist = QStringList() );
929 
936  QString createViewpointFromJsonObject( const QVariantMap& vm );
937 
944  QVariantMap getViewpointObjectDataAsJsonObject( const QString& vpID );
945 
955  int setViewpointObjectDataFromJsonObject( const QString& vpID, const QVariantMap& vm );
956 
963  QVariantMap getViewpointMeasureItemsAsJsonObject( const QString& vpID );
964 
974  int addMeasureItemsToViewpointFromJsonObject( const QString& vpID, const QVariantMap& vm );
975 
982  void applyViewByJsonObject( const QVariantMap& vm );
983 
988  void applyMeasureItemsFromJsonObject( const QVariantMap& vm );
989 
991 #pragma endregion
992 
993 
994 #pragma region CAMERA / LIGHT SOURCES
995 
1023  QVariantMap getClipping(int i);
1024 
1037  void setClipping(int i, QVariantMap clp);
1038 
1062  QVariantMap getCamera();
1063 
1096  QVariantMap getCameraAsJsonObject();
1097 
1124  void setCamera(QVariantMap cam);
1125 
1134  void setCameraFromJsonObject(QVariantMap camJSON);
1135 
1158  QList<QVariant> getLightSources();
1159 
1165  void setLightSources( QList<QVariant> lList );
1166 
1207  QVariantMap getVisualizationOptions();
1208 
1223  void setVisualizationOptions(QVariantMap opt);
1224 
1273  QVariantMap getPainterOptions();
1274 
1289  void setPainterOptions(QVariantMap opt);
1290 
1292 #pragma endregion
1293 
1294 
1295 #pragma region OBJECT TOOLTIPS, DOCUMENTS TOOLTIPS, RESOURCES TOOLTIPS
1296 
1305  int activateObjTooltip(QString name);
1306 
1311  void deactivateObjTooltip();
1312 
1318  QString getActiveTooltipName() const;
1319 
1323  void setDocumentsTooltipsVisible( bool v );
1324 
1329 
1334  void setResourcesTooltipsVisible( bool v );
1335 
1341 
1342 
1344 #pragma endregion
1345 
1346 
1347 #pragma region _4D_SIMULATION
1348 
1350 
1355  void set4dIsActive( bool active );
1356 
1361  bool get4dIsActive();
1362 
1368  bool set4dDateTime( QDateTime dt );
1369 
1374  QDateTime get4dDateTime();
1375 
1401  QVariantMap get4dOptions();
1402 
1411  void set4dOptions( QVariantMap opt );
1412 
1417  QDateTime get4dProjectStart();
1418 
1423  QDateTime get4dProjectFinish();
1424 
1429  QStringList get4dActiveTaskList( QDateTime dt, bool linkedToObjectsOnly = false );
1430 
1435  QStringList get4dActiveTaskListByInterval( QDateTime dtStart, QDateTime dtEnd, bool linkedToObjectsOnly = false );
1436 
1441  QStringList get4dFinishedTaskList( QDateTime, bool linkedToObjectsOnly = false );
1442 
1447  QStringList get4dProspectiveTaskList( QDateTime, bool linkedToObjectsOnly = false );
1448 
1453  QString get4dTaskColor( QString taskID, QDateTime dt, QString defaultColorName = "#000" );
1454 
1456 
1457 #pragma endregion
1458 
1459 
1460 #pragma region BUILDING STRUCTURE
1461 
1473  void setBsPlanUnderlayActive(bool active);
1474 
1480  bool getBsPlanUnderlayActive();
1481 
1483 #pragma endregion
1484 
1485 
1486 #pragma region NAVIGATION MODES
1487 
1489 
1501  QString getNavigationMode();
1502 
1515  void setNavigationMode( QString mode, QString pinModeContainerID = QString() );
1516 
1517 
1525  QVariantMap getHandlerMode();
1526 
1604  bool setHandlerMode( QVariantMap handlerInfo );
1605 
1610  QStringList getCreatedPins();
1611 
1613 #pragma endregion
1614 
1615 
1616 #pragma region PICK POINTS, MEASURE
1617 
1636  QVariantMap getPickedPoint();
1637 
1666  QVariantMap getAllPickedPoints();
1667 
1684  QVariantMap getPickedPointGPS();
1685 
1703  QVariantMap getPickedPointGK();
1704 
1709  void clearMeasureItems();
1710 
1712 #pragma endregion
1713 
1714 
1715 #pragma region CLASH_DETECTION
1716 
1722  void showClashList( QString clashIdList );
1723 
1725 #pragma endregion
1726 
1727 
1728 #pragma region WEBFORMS
1729 
1753  QVariantMap getWebFormLocations();
1754 
1759  void createWebFormBookmark(QString url, QString name);
1760 
1769  int removeWebFormBookmark(QString url );
1770 
1772 #pragma endregion
1773 
1774 
1775 //#pragma region SURVEYPOINTS
1776 // ///@{ \name SURVEY POINTS
1777 //
1778 // /*
1779 // Import survey points from file and create model with object points.
1780 //
1781 // \param fileName Full file name with path
1782 // \param propName Name of property which will store value of survey point
1783 // \param delimiter Column delimiter (default: Tab)
1784 //
1785 // \return number of survey points imported if import was successful<br>
1786 // -1 file not found / file could not be opened<br>
1787 // -2 model could not be created
1788 // \since 2.2.1, 21 jun 2018, sl
1789 // */
1790 // int importSurveyPoints( QString fileName, QString propName = "spValue", QChar delimiter = '\t' );
1791 //
1792 // ///@}
1793 //#pragma endregion
1794 
1795  private:
1796 
1797  void _setElementVisibility( const QString& idListStr, eElementVisibilityMode mode, const QString& domainCombination = "geometry" );
1798 
1799  void zoomToDocumentsByList( QList<model::Element*> eleList );
1800  void zoomToResourcesByList( QList<model::Element*> eleList );
1801 
1805  NavigatorProject* getNavigatorProject();
1806 
1807  int _isPainting_;
1808 
1809  xqtgl::xQGLView* _redliningView;
1810 
1811  };
1812 
1813 }
void filterElements(QString pName, QString pType, QString pattern, bool checkInh=true, QString domainCombination="geometry")
QStringList getCreatedPins()
QStringList get4dActiveTaskListByInterval(QDateTime dtStart, QDateTime dtEnd, bool linkedToObjectsOnly=false)
QString exportBCF(QStringList sourceIds, QString targetPath, QString targetFileBaseName, QString bcfVersion="2.1")
QVariantMap getViewpointAsJsonObject(const QString &vpID, const QStringList &blacklist=QStringList())
void showElementsOnly(QString idList, QString domainCombination="geometry")
QString getAll(QString domainFilter="geometry")
void setCamera(QVariantMap cam)
void zoomToResources(QStringList idList)
QString showSaveFileDialog(QString caption="", QString directory="", QString filter="")
QVariantMap getClipping(int i)
int addMeasureItemsToViewpointFromJsonObject(const QString &vpID, const QVariantMap &vm)
void setNavigationMode(QString mode, QString pinModeContainerID=QString())
void showDimensionsPainter(bool showAABB, bool showOOBB)
bool getDocumentsTooltipsVisible()
QStringList getAllElements(QString domainFilter="geometry")
void setVisualisationMode(int mode, bool repaint=true)
void moveToLocationGps(double lat, double lon)
QVariantMap getPickedPoint()
void hideElements(QString idList, bool ignoreObjectLocking=false, QString domainCombination="geometry")
QStringList get4dActiveTaskList(QDateTime dt, bool linkedToObjectsOnly=false)
void set4dIsActive(bool active)
int showViewpoint(QString name)
void addToViewPoint(QString vpID, QString objIdList)
int setViewpointObjectDataFromJsonObject(const QString &vpID, const QVariantMap &vm)
QString saveViewpoint(QString name, bool saveVisible=true, bool saveSelected=false, QString desc=QString(), bool saveRedlining=false, bool copyMeasureItems=false)
void selectElements(QString idList, bool flag, QString domainCombination="geometry")
Definition: ProjectAPI.h:39
QDateTime get4dDateTime()
int showViewpointByID(QString id)
void showAll(bool repaint, QString domainCombination="geometry")
bool hasVisible(QString domainFilter="all")
QVariantMap getVisualizationOptions()
QVariantMap showElementsOOBBSide(QString IDList, double prec=1.e-2)
void setDocumentsTooltipsVisible(bool v)
QVariantMap showElementsOOBBTop(QString IDList, double prec=1.e-2)
QStringList get4dProspectiveTaskList(QDateTime, bool linkedToObjectsOnly=false)
QStringList getSelectedElements(QString domainFilter="geometry")
void setLightSources(QList< QVariant > lList)
QVariantMap getViewpointMetadata(QString id)
void setClipping(int i, QVariantMap clp)
QString getCurrentViewAsImage()
int removeWebFormBookmark(QString url)
QList< QVariant > getLightSources()
bool saveCurrentViewToFile(QString filename)
QString getSelected(QString domainFilter="geometry")
void removeFromViewPoint(QString vpID, QString objIdList)
QStringList getVisibleElements(QString domainFilter="geometry")
QVariantMap getPickedPointGPS()
QString getActiveTooltipName() const
bool hasSelected(QString domainFilter="all")
void zoomToLocationGK(double rw, double hw, double h)
void openLink(QString url, bool useDesktopService)
QVariantMap getCameraAsJsonObject()
QVariantMap getViewpointMeasureItemsAsJsonObject(const QString &vpID)
QVariantMap get4dOptions()
QVariantMap getPainterOptions()
int showColorSchema(QString name)
void setCameraFromJsonObject(QVariantMap camJSON)
void openProject(QString url, bool useSessionData)
QVariantMap getHandlerMode()
bool getResourcesTooltipsVisible()
QString createViewpointFromJsonObject(const QVariantMap &vm)
QVariantMap getCamera()
QString get4dTaskColor(QString taskID, QDateTime dt, QString defaultColorName="#000")
Definition: AutomationAPI.h:30
bool deleteViewpointByID(QString id)
bool setHandlerMode(QVariantMap handlerInfo)
void zoomToObjects(QString objIDs)
QVariantMap getPickedPointGK()
void zoomToLocationGps(double lat, double lon)
QVariantMap getWebFormLocations()
QString showOpenFileDialog(QString caption="", QString directory="", QString filter="")
int activateObjTooltip(QString name)
void showClashList(QString clashIdList)
void hideAll(bool repaint, QString domainCombination="geometry")
QVariantMap showElementsOOBBFront(QString idList, double prec=1.e-2)
QVariant importModel(QString filename, bool showDialog=true, QVariantMap options=QVariantMap())
Definition: ProjectAPI.h:16
QDateTime get4dProjectFinish()
bool importBCF(QString sourceFilePath)
void showElements(QString idList, bool includeBlocked=false, QString domainCombination="geometry")
void zoomToDocuments(QStringList idList)
QVariantMap getAllPickedPoints()
void setVisualizationOptions(QVariantMap opt)
int countSelected(QString domainFilter="geometry")
int countVisible(QString domainFilter="geometry")
int saveCPA(QString cpa_filename, QString pack_bookmark)
QStringList get4dFinishedTaskList(QDateTime, bool linkedToObjectsOnly=false)
QVariantMap getViewpointObjectDataAsJsonObject(const QString &vpID)
bool set4dDateTime(QDateTime dt)
void startEXE(QString prg, QString args)
QString getVisible(QString domainFilter="geometry")
void createWebFormBookmark(QString url, QString name)
void setBsPlanUnderlayActive(bool active)
QVariantMap getViewpointList()
void setResourcesTooltipsVisible(bool v)
bool sendRemoteMessage(QString message)
void applyViewByJsonObject(const QVariantMap &vm)
void clearSelection(bool repaint, QString domainCombination="geometry")
void set4dOptions(QVariantMap opt)
void setPainterOptions(QVariantMap opt)
void applyMeasureItemsFromJsonObject(const QVariantMap &vm)
QDateTime get4dProjectStart()

Created: Fri Feb 5 2021 09:33:06