MainPage   Related pages 
Public Slots | List of all members
desiteCore::ProjectAPI Class Reference

#include <desiteCore/ProjectAPI.h>

Inheritance diagram for desiteCore::ProjectAPI:
domainBim::AutomationAPI domainBim::CoreAPI desiteCore::NavigatorProjectAPI

Public Slots

int message (QString)
 
bool sendRemoteMessage (QString message)
 
QVariantMap getClipping (int i)
 
void setClipping (int i, QVariantMap clp)
 
QVariantMap getCamera ()
 
QVariantMap getCameraAsJsonObject ()
 
void setCamera (QVariantMap cam)
 
void setCameraFromJsonObject (QVariantMap camJSON)
 
QList< QVariant > getLightSources ()
 
void setLightSources (QList< QVariant > lList)
 
QVariantMap getVisualizationOptions ()
 
void setVisualizationOptions (QVariantMap opt)
 
QVariantMap getPainterOptions ()
 
void setPainterOptions (QVariantMap opt)
 
TOOLS
void startEXE (QString prg, QString args)
 
void showOnScreenKeyboard ()
 
void openLink (QString url, bool useDesktopService)
 
QString showOpenFileDialog (QString caption="", QString directory="", QString filter="")
 
QString showSaveFileDialog (QString caption="", QString directory="", QString filter="")
 
PROJECT
void openProject (QString url, bool useSessionData)
 
int saveProject ()
 
int saveCPA (QString cpa_filename, QString pack_bookmark)
 
QVariant importModel (QString filename, bool showDialog=true, QVariantMap options=QVariantMap())
 
QString exportBCF (QStringList sourceIds, QString targetPath, QString targetFileBaseName, QString bcfVersion="2.1")
 
bool importBCF (QString sourceFilePath)
 
int redirectDocument (QString modelId, QString newSourceFilePath)
 
Objects
void filterElements (QString pName, QString pType, QString pattern, bool checkInh=true, QString domainCombination="geometry")
 
Materials
int showColorSchema (QString name)
 
Visibility, Selection
void showAll (bool repaint, QString domainCombination="geometry")
 
void hideAll (bool repaint, QString domainCombination="geometry")
 
void showElements (QString idList, bool includeBlocked=false, QString domainCombination="geometry")
 
void showElementsOnly (QString idList, QString domainCombination="geometry")
 
void hideElements (QString idList, bool ignoreObjectLocking=false, QString domainCombination="geometry")
 
void clearSelection (bool repaint, QString domainCombination="geometry")
 
void selectVisible ()
 
void selectVisibleGeometric ()
 
void selectElements (QString idList, bool flag, QString domainCombination="geometry")
 
void zoomToSelected ()
 
void zoomToVisible ()
 
void zoomToObjects (QString objIDs)
 
void zoomToAllDocuments ()
 
void zoomToSelectedDocuments ()
 
void zoomToVisibleDocuments ()
 
void zoomToDocuments (QStringList idList)
 
void zoomToAllResources ()
 
void zoomToSelectedResources ()
 
void zoomToVisibleResources ()
 
void zoomToResources (QStringList idList)
 
void zoomToLocationGK (double rw, double hw, double h)
 
void zoomToLocationGps (double lat, double lon)
 
void moveToLocationGps (double lat, double lon)
 
void zoomTopView ()
 
QString getAll (QString domainFilter="geometry")
 
QStringList getAllElements (QString domainFilter="geometry")
 
QString getVisible (QString domainFilter="geometry")
 
QStringList getVisibleElements (QString domainFilter="geometry")
 
bool hasVisible (QString domainFilter="all")
 
int countVisible (QString domainFilter="geometry")
 
QString getSelected (QString domainFilter="geometry")
 
QStringList getSelectedElements (QString domainFilter="geometry")
 
bool hasSelected (QString domainFilter="all")
 
int countSelected (QString domainFilter="geometry")
 
void setVisualisationMode (int mode, bool repaint=true)
 
int getVisualisationMode ()
 
QVariantMap showElementsOOBBSide (QString IDList, double prec=1.e-2)
 
QVariantMap showElementsOOBBTop (QString IDList, double prec=1.e-2)
 
QVariantMap showElementsOOBBFront (QString idList, double prec=1.e-2)
 
void showDimensionsPainter (bool showAABB, bool showOOBB)
 
void hideDimensionsPainter ()
 
void repaint3DView ()
 
Viewpoints, Clipping, Camera, Light Sources
int showViewpoint (QString name)
 
int showViewpointByID (QString id)
 
QVariantMap getViewpointList ()
 
QVariantMap getViewpointMetadata (QString id)
 
void addToViewPoint (QString vpID, QString objIdList)
 
void removeFromViewPoint (QString vpID, QString objIdList)
 
QString saveViewpoint (QString name, bool saveVisible=true, bool saveSelected=false, QString desc=QString(), bool saveRedlining=false, bool copyMeasureItems=false)
 
bool deleteViewpointByID (QString id)
 
bool deleteAllViewpoints ()
 
QString getCurrentViewAsImage ()
 
bool saveCurrentViewToFile (QString filename)
 
QVariantMap getViewpointAsJsonObject (const QString &vpID, const QStringList &blacklist=QStringList())
 
QString createViewpointFromJsonObject (const QVariantMap &vm)
 
QVariantMap getViewpointObjectDataAsJsonObject (const QString &vpID)
 
int setViewpointObjectDataFromJsonObject (const QString &vpID, const QVariantMap &vm)
 
QVariantMap getViewpointMeasureItemsAsJsonObject (const QString &vpID)
 
int addMeasureItemsToViewpointFromJsonObject (const QString &vpID, const QVariantMap &vm)
 
void applyViewByJsonObject (const QVariantMap &vm)
 
void applyMeasureItemsFromJsonObject (const QVariantMap &vm)
 
TOOLTIPS
int activateObjTooltip (QString name)
 
void deactivateObjTooltip ()
 
QString getActiveTooltipName () const
 
void setDocumentsTooltipsVisible (bool v)
 
bool getDocumentsTooltipsVisible ()
 
void setResourcesTooltipsVisible (bool v)
 
bool getResourcesTooltipsVisible ()
 
4D SIMULATION
void set4dIsActive (bool active)
 
bool get4dIsActive ()
 
bool set4dDateTime (QDateTime dt)
 
QDateTime get4dDateTime ()
 
QVariantMap get4dOptions ()
 
void set4dOptions (QVariantMap opt)
 
QDateTime get4dProjectStart ()
 
QDateTime get4dProjectFinish ()
 
QStringList get4dActiveTaskList (QDateTime dt, bool linkedToObjectsOnly=false)
 
QStringList get4dActiveTaskListByInterval (QDateTime dtStart, QDateTime dtEnd, bool linkedToObjectsOnly=false)
 
QStringList get4dFinishedTaskList (QDateTime, bool linkedToObjectsOnly=false)
 
QStringList get4dProspectiveTaskList (QDateTime, bool linkedToObjectsOnly=false)
 
QString get4dTaskColor (QString taskID, QDateTime dt, QString defaultColorName="#000")
 
BUILDING STRUCTURE
void setBsPlanUnderlayActive (bool active)
 
bool getBsPlanUnderlayActive ()
 
Navigation Modes
QString getNavigationMode ()
 
void setNavigationMode (QString mode, QString pinModeContainerID=QString())
 
QVariantMap getHandlerMode ()
 
bool setHandlerMode (QVariantMap handlerInfo)
 
QStringList getCreatedPins ()
 
PICK POINTS, MEASURE
QVariantMap getPickedPoint ()
 
QVariantMap getAllPickedPoints ()
 
QVariantMap getPickedPointGPS ()
 
QVariantMap getPickedPointGK ()
 
QVariantMap getPickedFaces ()
 
void clearMeasureItems ()
 
CLASH DETECTION
void showClashList (QString clashIdList)
 
WebForms
QVariantMap getWebFormLocations ()
 
void createWebFormBookmark (QString url, QString name)
 
int removeWebFormBookmark (QString url)
 
- Public Slots inherited from domainBim::AutomationAPI
bool hasElement (QString id)
 
QStringList getRootContainerList (QString modelName)
 
QString findContainerByName (const QString &parentId, const QString &name, const QString &lookupDomain="all")
 
QString getContainerByName (QString parentId, QString name)
 
bool isContainer (QString id)
 
QVariantList findDocumentsByLocationGps (double lat, double lon, double distance, QStringList idList=QStringList())
 
QVariantList findDocumentsByLocationRangeGps (QStringList gpsCoordinates, double distance, QStringList idList=QStringList())
 
QVariantList findDocumentsByLocationGk (double rw, double hw, double distance, QStringList idList=QStringList())
 
QStringList findDocumentsByDate (QDateTime start, QDateTime end, QStringList idList=QStringList(), bool useRef=false)
 
int synchronizeDocumentContainer (QString containerId, QScriptValue callback=QScriptValue(), bool blockExecution=false)
 
void resetDocumentMetaData (QString objId)
 
QVariantMap getVisualisationList ()
 
int setVisualisationByID (QString taskIDList, QString visID)
 
int removeVisualisation (QString taskIDList)
 
int setTaskMode (QString taskID, int mode)
 
int recalculateActivityProject (QString taskID=QString(), bool visibleOnly=false)
 
QVariantMap calcPropertyValuesOverTime (QString propName, QString propType, QVariantMap options)
 
QStringList getCalendarList ()
 
QString getCalendarByName (QString name)
 
QString getCalendarByTask (QString taskID, bool checkInh=true)
 
int setCalendar (QString taskID, QString calendarID)
 
int removeCalendarFromTask (QString taskID)
 
int setCalendarOptions (QString calendarID, QVariantMap options)
 
QVariantMap getCalendarOptions (QString calendarID)
 
int calcWorkInMinutes (QDateTime start, QDateTime finish, QString calendarID=QString())
 
QStringList getTaskRestrictionsList ()
 
QString getTaskRestrictionsByName (QString name)
 
int setTaskRestrictions (QString taskID, QString restrictionsID)
 
int removeTaskRestrictions (QString taskID)
 
int setBoQBreakdownStructure (QString boqModelID, QString templateStr)
 
int hasContact (QString objId1, QString objId2, QVariantMap options=QVariantMap())
 
QString createContactObject (QString parentId, QString objId1, QString objId2, QString matId, QVariantMap options=QVariantMap())
 
QStringList cutObject (QString parentId, QString objId, QVariantMap plane=QVariantMap(), bool closeCuts=true, bool splitUnconnectedParts=true)
 
- Public Slots inherited from domainBim::CoreAPI
QString addDays (QString dateStr, int nrDays)
 
QString timeStamp (QString format=QString())
 
int getCalendarWeek (QDateTime dt)
 
QString format (double v, int dec=2, QString frmt="%L1", int fieldWidth=10, QChar fillChar=QChar::Nbsp)
 
QString formatDateTime (QDateTime dt, QString formatstr="iso")
 
QString createID ()
 
long calcHashcode (QString str)
 
QString compressToIfcGuid (QString id)
 
QString uncompressFromIfcGuid (QString ifcGuid)
 
bool checkRegExp (QString value, QString pattern)
 
double calcSlantedArea (QString objId, double angleMin=0.0, double angleMax=45.0)
 
QVariantMap calcGpsCoordsByStation (QString objId, double station)
 
QVariantMap calcGpsCoordsByModelCoords (double x, double y)
 
QVariantMap calcModelCoordsByGpsCoords (double lat, double lon)
 
QVariantMap calcGkCoordsByGpsCoords (double lat, double lon)
 
QVariantMap calcGpsCoordsByGkCoords (double rw, double hw)
 
QString idListToStr (QStringList idList)
 
QStringList strToIdList (QString strIDList)
 
QVariantMap getFileInfo (QString filePath)
 
QString getAbsolutePath (QString filePath)
 
QString getBaseName (QString filePath)
 
QString getFileName (QString filePath)
 
QString getApplicationDirectory ()
 
QString getApplicationFilename ()
 
virtual QString getApplicationLanguage ()
 
QString getVersionAsString ()
 
int getVersionMAJOR ()
 
int getVersionMINOR ()
 
int getVersionBUILD ()
 
QVariantMap getVersion ()
 
bool requireVersion (int major, int minor, int patch)
 
QString getUserName ()
 
QString getProjectID ()
 
int getProjectVariantNumber ()
 
int getProjectVersionNumber ()
 
QString getProjectNumber ()
 
int setProjectNumber (QString s, bool overwriteExisting=false)
 
QString getProjectName ()
 
QString getProjectShortDescription ()
 
int setProjectShortDescription (QString s, bool overwriteExisting=false)
 
QString getProjectLongDescription ()
 
int setProjectLongDescription (QString s, bool overwriteExisting=false)
 
QString getProjectDirectory ()
 
QString getLocation ()
 
QVariantMap getProjectLocation () const
 
QVariantMap getCloudSettings ()
 
QVariantMap getProjectInfo ()
 
QString getDomainByElement (QString objId)
 
QVariant getPropertyValue (QString objId, QString propName, QString propType, bool inh=true)
 
QList< QVariant > getPropertyValuesByObject (QString objId, QString filterpattern="*")
 
QVariant getPropertySource (QString objId, QString propName, QString propType, bool inh=true)
 
QString getPropertyUnit (QString objId, QString propName, QString propType, bool inh=true)
 
QString getPropertyUnit (QString propName, QString propType)
 
QVariant getPropertyValueByDate (QString objId, QString propName, QString propType, bool inh=true)
 
QDateTime getPropertyLastDate (QString objId, QString propName, QString propType, bool inh=true)
 
QDateTime getPropertyFirstDate (QString objId, QString propName, QString propType, bool inh)
 
QVariantMap getPropertyDateListAsJSON (QString objId, QString propName, QString propType, bool inh=true)
 
QVariantList getPropertyDateList (QString objectId, QString propertyBaseName, QString propertyType)
 
QVariantMap getPropertyTypesByObject (QString objId, QString filterPattern="*")
 
QVariantMap getPropertyTypesByDomain (QString domainName, QString filterPattern="*")
 
QVariantMap getPropertyTypeMetaData (QString propName, QString propType)
 
QList< QVariant > getPropertyTypeList (QString domain="all", QString filterPattern="*", bool activeOnly=false)
 
QList< QVariant > getPropertyTypeListByObject (QString objId, QString filterPattern="*")
 
bool isPropertyInherited (QString objId, QString propName, QString propType)
 
QString getPropertyValueRange (QString idList, QString propName, QString propType, QString domainFilter="geometry")
 
QStringList getPropertyValueList (QString propName, QString propType, int maxValues)
 
QString getPropertyValueAsString (QString objId, QString propName, QString propType, bool inh=true)
 
QVariant evaluateFormula (QString code, QString id, QString id_otherdomain=QString())
 
QString prepareJsCode (QString code, QString id, int dec=-1, QString frmt="%L1", int fieldWidth=10, QChar fillChar=QChar())
 
QStringList extractPropertyNames (const QString &code, const QString &startTag="[[", const QString &endTag="]]")
 
QStringList getLinkedObjects (QString objectIDList, QString resultDomains="all", QString objectLookupDomains="all")
 
QStringList getTasksByObjectList (QString idList)
 
QStringList getObjectsByTaskList (QString idList)
 
QStringList getDocumentsByObjectList (QString idList)
 
QStringList getObjectsByDocumentList (QString idList)
 
QStringList getSectionsByObjectList (QString idList)
 
QStringList getObjectsBySectionList (QString idList)
 
QStringList getTypesByObjectList (QString idList)
 
QStringList getObjectsByTypeList (QString idList)
 
QStringList getResourcesByObjectList (QString idList)
 
QStringList getObjectsByResourcesList (QString idList)
 
QStringList getBoQItemsByObjectList (QString idList)
 
QStringList getObjectsByBoQItemList (QString idList)
 
QStringList getPcItemsByObjectList (QString idList)
 
QStringList getObjectsByPcItemList (QString idList)
 
QStringList getContainedElements (QString containerId, int maxDepth, bool loadExternal=true)
 
int countContainedElements (QString containerId, int maxDepth, bool loadExternal=true)
 
QString getParent (QString objId)
 
QStringList getOpenings (QString objId)
 
QStringList getParts (QString objId)
 
bool isVisible (QString objId)
 
bool isSelected (QString objId)
 
bool isLocked (QString objId)
 
bool isWired (QString objId)
 
QVariantList getPointList (QString objId)
 
QVariantMap getPointOnAlignmentAtStation (QString alignmentId, double d)
 
double getStationOfProjectedPoint (QString alignmentId, double x, double y, double z=0.0)
 
QStringList getRegionsOfAlignment (QString alignmentId)
 
QVariantList getRangesOfRegion (QString alignmentID, QString regionID)
 
double getValueOfAlignmentRegion (QString alignmentID, QString regionID)
 
int getTaskMode (QString taskID)
 
QString getTaskVisualisation (QString taskID)
 
QString getTaskRestrictionsByTask (QString taskID)
 
int updateRuleBasedLinks (QString domainName, bool visibleOnly=false)
 
int removeRuleBasedLinks (QString domainName)
 

Public Member Functions

Constructors
 ProjectAPI (NavigatorProject *np, QObject *parent=0)
 
virtual ~ProjectAPI ()
 
- Public Member Functions inherited from domainBim::AutomationAPI
QString createSelectionSets (QString propertyTypes, QString rootName, QVariantMap config=QVariantMap())
 
QStringList getRootNodeListSelectionSets (QString domainFilter="all")
 
int addToSelectionSetGeometry (QString setId, QString objectIDList)
 
int removeFromSelectionSetGeometry (QString setId, QString objectIDs)
 
QString createSelectionSet (QString name, QString parentID=QString())
 
bool removeSelectionSet (QString selsetID)
 
int updateSmartSets (QStringList smartSetIDs=QStringList())
 
QString getModelByName (QString name, QString domainFilter="geometry")
 
QString getModelByElement (QString id, QString domainFilter="all")
 
QString getRootContainerByName (QString modelName, QString rootContainerName)
 
QStringList getModelListByName (QString name, QString domain="geometry")
 
QStringList getModelListByDomain (QString domainFilter="all")
 
QString getRootNodeByModel (QString modelId)
 
QStringList getRootNodeListByDomain (QString domainFilter="all")
 
QString createModel (QString name, bool createRootC=true, QString domain="geometry")
 
QVariantMap getModelMetaData (QString modelId)
 
int deleteModel (const QString &id)
 
void setCloudSettings (QVariantMap vm)
 
void setTempValue (QString name, QVariant value)
 
QVariant getTempValue (QString name)
 
QStringList getListOfTempValues ()
 
void clearListOfTempValues ()
 
int setLinkedObjects (const QString &elementID, const QString &IDList)
 
int removeAllLinkedObjects (QString id)
 
int removeLinkedObjects (QString id, QString linkedIdList)
 
int createPropertyType (const QString &propName, const QString &propDatatype, const QString &uomCode, bool isInh, int target, const QString &domainName="all")
 
int setPropertyTypeMetaData (QString pName, QString ptype, QVariantMap metadata)
 
int deletePropertyType (QString propName, QString propDatatype, QString domainName="all")
 
QList< QVariant > getPropertyTypeBookmarkList ()
 
QVariantMap getPropertyTypeBookmarkByID (QString bookmarkId)
 
int activatePropertyTypeBookmark (QString bkmId)
 
bool setPropertyTypeActive (QString pName, QString ptype, QString domain, bool active)
 
int setAllPropertyTypesActive ()
 
int removePropertyTypeBookmarkByID (QString bkmId)
 
QString addPropertyTypeBookmark (QVariantMap bookmarkConfig)
 
int setPropertyValue (QString objId, QString propName, QString propDataType, QVariant value)
 
int setPropertyValueRepository (QString objId, QString propName, QString propDataType, QVariant value, bool createType=true)
 
int deleteProperty (QString objId, QString propName, QString propDatatype)
 
QList< QVariant > getAvailablePropertyValues (QString propName, QString propDatatype, int maxValues, QString domainName="geometry")
 
QList< QVariant > getPropertyValues (QString propName, QString propDatatype, int maxValues=0, QString domainName="all", bool getNullValues=false)
 
QList< QVariant > getPropertyValuesByObjectList (QString propName, QString propDatatype, bool checkInh, QString objIdList, int maxValues=0, QString domainName="all", bool getNullValues=false)
 
QVariantMap getPropertyListAsJSON (QVariantMap options)
 
void setPropertyListAsJSON (QVariantMap propmap, QVariantMap opt)
 
QVariantMap getPropertyScriptList () const
 
QString getPropertyScriptCode (QString domain, QString pname, QString datatype) const
 
QString getPropertyScriptFgColor (QString domain, QString pname, QString datatype) const
 
QString getPropertyScriptBgColor (QString domain, QString pname, QString datatype) const
 
int setPropertyScriptCode (QString domain, QString pname, QString datatype, QString code)
 
int setPropertyScriptFgColor (QString domain, QString pname, QString datatype, QString code)
 
int setPropertyScriptBgColor (QString domain, QString pname, QString datatype, QString code)
 
QVariantMap addPropertyScript (QString domain, QString pname, QString datatype, QString code=QString())
 
int removePropertyScript (QString domain, QString pname, QString datatype)
 
void propertyScriptClearCache ()
 
void propertyScriptClearCache (QString domain, QString pname, QString datatype)
 
QVariantMap getPropertyScriptOptions (QString domain, QString pname, QString datatype)
 
int setPropertyScriptOptions (QString domain, QString pname, QString datatype, QVariantMap opt)
 
QString createMaterial (QString matXml, QString modelId=QString())
 
int deleteMaterial (QString matId)
 
QStringList getMaterialList ()
 
QString getMaterialAsXmlByID (QString matId)
 
QVariantMap getMaterial (const QString &matId)
 
QString getMaterialIDByName (QString matName)
 
void updateMaterial (QString matId, QString xmlMat)
 
int setMaterialToObjects (QString matId, QString objectIds)
 
int setTransparency (QString objectIds, float defaultTransparency=0.95)
 
void resetMaterials (bool updateUI=true)
 
void reorderElements ()
 
QString createColorSchema (QString setContainerId, QString name)
 
QString createColorSchemaFromCurrentMaterials (QString name, bool updateExisting, QVariantMap options=QVariantMap())
 
int deleteColorSchema (QString namePattern)
 
QStringList getColorSchemaList ()
 
QString getCurrentColorSchema ()
 
bool activateColorSchemaByName (QString name)
 
void showWireModeSchema (QString name)
 
void clearWireMode ()
 
void setObjectsToWireMode (QString ids, bool wired)
 
QString createWireModeSchema (QString ids, QString wmName, bool overwrite=false)
 
QString getWired ()
 
int countWired ()
 
double getBBoxMinX ()
 
double getBBoxMaxX ()
 
double getBBoxMinY ()
 
double getBBoxMaxY ()
 
double getBBoxMinZ ()
 
double getBBoxMaxZ ()
 
void updateBoundingBox3DView ()
 
int calcOOBB (QString objIdList, double eps=0.001)
 
int updateOOBB (QString obIDList, double eps=0.001)
 
int calcOOBBxy (QString objIdList, double eps=0.001)
 
int updateOOBBxy (QString objIdList, double eps=0.001)
 
QVariantMap getBoundingBoxCommon (QString objIdList)
 
QVariantMap getOOBBCommon (QString objIdList)
 
QVariantMap getOOBBxyCommon (QString objIdList)
 
double checkOverlapOBB (QString id1, QString id2, double eps=0.001)
 
int startProjectTransaction (const QString &domain="geometry")
 
int endProjectTransaction (const QString &domain="geometry")
 
QString createObjectFromXml (const QString &parentId, const QString &objectXML)
 
int deleteObjects (QString idList)
 
void setName (QString objIdList, QString name)
 
QString createObject (QString parentId, QString name)
 
QVariantMap getAsJSON (QString objId)
 
int setAsComposite (const QString &id, bool composite)
 
QString addRegionToAlignment (QString alignmentId, QVariantMap setting)
 
int removeAllRegionsFromAlignment (QString alignmentId)
 
int addRangeToRegion (QString regionId, double fromStation, double toStation, QString alignmentId=QString())
 
int removeRangeFromRegion (QString regionId, double fromStation, double toStation, QString alignmentId=QString())
 
int removeAllRangesFromRegion (QString regionId, QString alignmentId=QString())
 
int createDirectory (QString path, QString dirName)
 
bool writeFile (QString filePath, const QString &content, const QString &encoding=QString())
 
bool writeBinaryFile (QString filePath, const QByteArray &data)
 
bool appendToFile (QString filePath, const QString &content, const QString &encoding=QString())
 
bool removeFile (QString filePath)
 
bool copyFile (QString fnFrom, QString fnTo)
 
bool moveFile (QString fnFrom, QString fnTo)
 
bool checkIfFileExists (QString filePath)
 
bool openFile (QString filePath, const QString &encoding=QString())
 
bool writeToFile (QString content)
 
bool closeFile ()
 
QStringList readTextFile (QString filename, bool ignoreLineBreakesInDoubleQuotes=false, QString codec=QString())
 
QString readTextFileAsString (QString filename, QString codec=QString())
 
QByteArray readBinaryFile (QString filePath)
 
QVariantMap readCsvFile (QString filename, QString delimiter=";", QString quoteSign="\)
 
int csvOpen (QString filename, QString delimiter=";", QString quoteSign="\)
 
QStringList csvNextLine ()
 
bool csvHasNextLine ()
 
bool csvClose ()
 
QString readImageFile (QString filename, QString targetFormat="", bool applyExifRotation=false)
 
QVariantList getDirectoryEntryList (QString dirPath, bool filesOnly=false, QString orderBy="Name")
 
bool dbIsLocalCopy ()
 
QString dbGetFilepath () const
 
int dbOpen (const QVariant connectionData=QVariant())
 
bool dbClose ()
 
void dbCheckIn ()
 
void dbCheckOut (const QStringList &propList)
 
bool dbQueryExec (const QString &sqlQuery)
 
QVariantMap dbQueryRecordset (const QString &sqlQuery, const QString &key, int maxNumberOfRows=0)
 
bool dbEndQueryExec ()
 
bool dbQueryNext ()
 
QVariant dbQueryValue (int column)
 
QString dbQueryLastError ()
 
int setPropertyValueDB (const QString &objIdList, const QString &propName, const QString &propDataType, const QString &propDomain, const QVariant &value, bool createType=true)
 
int writePropertyValueDB (const QString &objIdList, const QString &propName, const QString &propDataType, const QString &propDomain, const QVariant &value, bool createType=true)
 
bool startTransaction ()
 
bool endTransaction ()
 
bool dbGetImmediateUpdate ()
 
void dbSetImmediateUpdate (bool)
 
int dbClearCache (const QString &propName, const QString &propType)
 
void dbClearCacheAll ()
 
int dbDeleteProperty (const QString &objIdList, const QString &propName, const QString &propType)
 
int dbAssertTable (const QString &tableName, const QStringList &columnsList)
 
QStringList getListOfObjTooltips ()
 
void addObjectListToTooltip (QString idList, QString tooltipname)
 
void removeObjectListFromTooltip (QString idList, QString tooltipname)
 
void lockObjects (QString idList)
 
void unlockObjects (QString idList)
 
void unlockAllObjects ()
 
QString getLocked ()
 
int countLocked ()
 
void itClear ()
 
int itByFilter (QString propName, QString propDatatype, QString filterPattern, bool checkInh=true, QString domain="geometry")
 
int itFilterByStatus (QString status, bool enabled=true, QString domain="geometry")
 
int itByObjectList (QString idList)
 
QString itGetObjectList ()
 
bool itHasNext ()
 
QString itNext ()
 
int itCount ()
 
void itToFront ()
 
QList< QVariant > itGetAvailablePropertyValues (QString propName, QString propDatatype, int maxValues)
 
void itSetupDbCache (QString propName, QString propType)
 
void itSetMaterial (QString matId)
 
void itColorCode (QString propName, QString propDT)
 
void itColorCodeNumber (QString propName, QString propDT, double intervalSize)
 
void itCalcOOBB (double eps)
 
void itUpdateOOBB (double eps)
 
void itCalcOOBBxy (double eps)
 
void itUpdateOOBBxy (double eps)
 
QString mergeObjects (QString parentContainerId, QString idList, bool skipClosed=false, bool keepTransparency=false, bool keepCommonProperties=false, bool replaceParent=false)
 
bool isIncludedIn (QString objId1, QString objId2)
 
int isPointIncludedIn (double x, double y, double z, QString objId, double tol=1.e-5)
 
int checkIntersection (QString objId1, QString objId2, double tolerance=-0.00001)
 
int transformObject (QString objId, QString transformation)
 
int setAsOpening (QString objId, QString openingIDList)
 
QString getProjectionAsSvg (QString idList, QVariantMap options=QVariantMap())
 
double calcDistance (QString objId1, QString objId2)
 
int swapOrientationOfTriangles (QVariantList idList)
 

Additional Inherited Members

- Static Public Attributes inherited from domainBim::CoreAPI
static bool BLOCK_UNSAFE
 

Detailed Description

DESITE API for scripting.

Object on JavaScript stack: desiteAPI

Since
1.0.17, 15 jun 2012 by jh
Id
ProjectAPI.h 6275 2022-05-12 09:32:51Z ansgar.horstmann

(c) ceapoint aec technologies GmbH

Member Function Documentation

◆ activateObjTooltip

int desiteCore::ProjectAPI::activateObjTooltip ( QString  name)
slot

Activate object tooltip.

Parameters
nameName of tooltip to be activated.
Returns
Index of activated Object-Tooltip.
Since
1.3.2, 28 mar 2014, jh

◆ addMeasureItemsToViewpointFromJsonObject

int desiteCore::ProjectAPI::addMeasureItemsToViewpointFromJsonObject ( const QString &  vpID,
const QVariantMap &  vm 
)
slot

Set Measure Items from an object map.

Returns
1 ok
0 no changes
-1 failed to look up ID
Since
2.2.4, 26 oct 2018, jh

◆ addToViewPoint

void desiteCore::ProjectAPI::addToViewPoint ( QString  vpID,
QString  objIdList 
)
slot

Add a list of objects to an existing Viewpoint's visible objects

Since
2.0.16, 2017-09-04, ah (port from 1.4)

◆ applyMeasureItemsFromJsonObject

void desiteCore::ProjectAPI::applyMeasureItemsFromJsonObject ( const QVariantMap &  vm)
slot

Add to measure items painter.

Since
28 nov 2018, 2.2.6, jh

◆ applyViewByJsonObject

void desiteCore::ProjectAPI::applyViewByJsonObject ( const QVariantMap &  vm)
slot

Apply viewpoint to current 3D-view. The viewpoint is not stored in the viewpoint model, just the viewpoint parameters (camera, clipping,..) are applied.

Since
2.2.4, 24 nov 2018, jh

◆ clearMeasureItems

void desiteCore::ProjectAPI::clearMeasureItems ( )
slot

Remove all measure items (current items and those sticked to 3d view).

Since
1.9.0, aug 2016, mm

◆ clearSelection

void desiteCore::ProjectAPI::clearSelection ( bool  repaint,
QString  domainCombination = "geometry" 
)
slot

Unselect all objects.

Parameters
repainttrue: Refresh 3D-view
Since
1.0.16

◆ countSelected

int desiteCore::ProjectAPI::countSelected ( QString  domainFilter = "geometry")
slot

Get number of selected elements.

Parameters
domainFilterCount only visible of given domains
Since
1.0.16

◆ countVisible

int desiteCore::ProjectAPI::countVisible ( QString  domainFilter = "geometry")
slot

Get number of visible elements.

Parameters
domainFilterCount only visible of given domains
Since
1.0.16

◆ createViewpointFromJsonObject

QString desiteCore::ProjectAPI::createViewpointFromJsonObject ( const QVariantMap &  vm)
slot

Create a new Viewpoint.

See also
getViewpointAsJsonObject()
Returns
ID of new viewpoint. "-1" if no name was passed or name wasn't unique, "-2" if ID was passed and it was already taken.
Since
2.2.4, 26 oct 2018, jh

◆ createWebFormBookmark

void desiteCore::ProjectAPI::createWebFormBookmark ( QString  url,
QString  name 
)
slot

Create a WebForm bookmark by URL and name. Note that if a bookmark for the URL pre-exists, the name of the existing bookmark will be changed.

Since
2.5.3, 2019-12-03, ah

◆ deactivateObjTooltip

void desiteCore::ProjectAPI::deactivateObjTooltip ( )
slot

Deactivate object tooltip.

Since
1.3.2, 28 mar 2014, jh

◆ deleteAllViewpoints

bool desiteCore::ProjectAPI::deleteAllViewpoints ( )
slot

Delete all viewpoints in project.

Since
2.2.1, 18 jun 2018, jh

◆ deleteViewpointByID

bool desiteCore::ProjectAPI::deleteViewpointByID ( QString  id)
slot

Delete viewpoint by ID.

Since
2.2.1, 18 jun 2018, jh

◆ exportBCF

QString desiteCore::ProjectAPI::exportBCF ( QStringList  sourceIds,
QString  targetPath,
QString  targetFileBaseName,
QString  bcfVersion = "2.1" 
)
slot

Export a list of Viewpoints to BCFZIP.

Parameters
sourceIdsList of Viewpoint IDs to be exported
targePathLocation where the resulting combined BCFZIP file is stored
targetFileBaseNameThe file name given here will be extended by .bcfzip or .bcf, respectively.
bcfVersionOne of "1.0", "2.0", "2.1" (default).
Returns
Filename (including path) of the resulting BCFZIP file. Empty string on error.

Example:

var vpIdList = ['f039aada-0f3e-4b34-931a-f64500576516','d716d3ee-5c84-4d8f-949c-7fc26a9130df'];
desiteAPI.exportBCF(vpIdList, 'C:/test/', 'output', '2.1');
C:/test/output.bcf
Since
2.5.2, 2019-08-01, ah

◆ filterElements

void desiteCore::ProjectAPI::filterElements ( QString  pName,
QString  pType,
QString  pattern,
bool  checkInh = true,
QString  domainCombination = "geometry" 
)
slot

Filter elements and show matching objects only.

Since
1.0.16

◆ get4dActiveTaskList

QStringList desiteCore::ProjectAPI::get4dActiveTaskList ( QDateTime  dt,
bool  linkedToObjectsOnly = false 
)
slot

Get list of tasks active on date 'dt';

Since
1.5.0, 01 dec 2015, jh

◆ get4dActiveTaskListByInterval

QStringList desiteCore::ProjectAPI::get4dActiveTaskListByInterval ( QDateTime  dtStart,
QDateTime  dtEnd,
bool  linkedToObjectsOnly = false 
)
slot

Get list of tasks which are active between dtStart and dtEnd.

Since
1.5.0, 01 dec 2015, jh

◆ get4dDateTime

QDateTime desiteCore::ProjectAPI::get4dDateTime ( )
slot

Get current date/time of simulation.

Since
1.5.0, 14 oct 2015, jh

◆ get4dFinishedTaskList

QStringList desiteCore::ProjectAPI::get4dFinishedTaskList ( QDateTime  ,
bool  linkedToObjectsOnly = false 
)
slot

Get list of tasks finished on date 'dt';

Since
1.5.0, 01 dec 2015, jh

◆ get4dIsActive

bool desiteCore::ProjectAPI::get4dIsActive ( )
slot

Check if 4d simulation is activated.

Since
1.5.0, 14 oct 2015, jh

◆ get4dOptions

QVariantMap desiteCore::ProjectAPI::get4dOptions ( )
slot

Get 4D options as JSON object.

{
"animationName":"A1",
"drawLegend":true,
"drawTasks":true,
"legendMaxRows":50,
"showAnimation":true,
"showOnlyTasksWithLinkedObjects":false,
"simulateVisibleTasks":false,
"simulationStep":1,
"startFinishWithTime":false,
"startProperty":Start##xs:dateTime,
"finishProperty":Finish##xs:dateTime,
"durationProperty":Duration##xs:string
}
Since
1.5.0, 14 oct 2015, jh
2.6.2, 29 sep 2020, sl: added start/finish/duration properties

◆ get4dProjectFinish

QDateTime desiteCore::ProjectAPI::get4dProjectFinish ( )
slot

Get finish date, i.e. last finish date.

Since
1.5.0, 14 oct 2015, jh

◆ get4dProjectStart

QDateTime desiteCore::ProjectAPI::get4dProjectStart ( )
slot

Get project start, i.e. first start date.

Since
1.5.0, 14 oct 2015, jh

◆ get4dProspectiveTaskList

QStringList desiteCore::ProjectAPI::get4dProspectiveTaskList ( QDateTime  ,
bool  linkedToObjectsOnly = false 
)
slot

Get list of tasks which have not been started on date 'dt';

Since
1.5.0, 01 dec 2015, jh

◆ get4dTaskColor

QString desiteCore::ProjectAPI::get4dTaskColor ( QString  taskID,
QDateTime  dt,
QString  defaultColorName = "#000" 
)
slot

Get color of task 'taskID' at date and time dt.

Since
1.5.0, 14 oct 2015, jh

◆ getActiveTooltipName

QString desiteCore::ProjectAPI::getActiveTooltipName ( ) const
slot

Get name of active tooltip.

Returns
Name of active object tooltip, else an empty string if no tooltip is active.
Since
1.3.6, 26 apr 2014, jh

◆ getAll

QString desiteCore::ProjectAPI::getAll ( QString  domainFilter = "geometry")
slot

Get IDs of all elements.

Parameters
domainFilterGet all IDs of given domains
Returns
List of element IDs separated by ';'
Since
2.2.4, 03 nov 2018, ar

◆ getAllElements

QStringList desiteCore::ProjectAPI::getAllElements ( QString  domainFilter = "geometry")
slot

Get IDs of all elements as list.

Parameters
domainFilterGet all IDs of given domains
Returns
List of element IDs
Since
2.2.4, 06 nov 2018, ar

◆ getAllPickedPoints

QVariantMap desiteCore::ProjectAPI::getAllPickedPoints ( )
slot

Get all picked points from measure handler (if active) as a list "points". Points are listed in pick order. Measured lines, polygones etc. are ignored. Each measure point is represented by an object in the list having 2 attributes: Attribute ip contains the internal model coordinates, attribute p the global coordinates. the list can be translated into JSON-String.

Example:

JSON.stringify( desiteAPI.getAllPickedPoints(), undefined, 2 );
{
"points":[
{
"ip":[-9.793106549424811,-9.601763445601856,16.2],
"p":[-9.793106549424811,-9.601763445601856,16.2]
},
{
"ip":[-9.79410654942481,5.1549005393821545,15.4],
"p":[-9.79410654942481,5.1549005393821545,15.4]
}
]
}
Since
2.0.7, 20 dec 2016, ar

◆ getBsPlanUnderlayActive

bool desiteCore::ProjectAPI::getBsPlanUnderlayActive ( )
slot

Draw plan underlay of building structure. Check if drawing is active.

Since
2.0, jh

◆ getCamera

QVariantMap desiteCore::ProjectAPI::getCamera ( )
slot

projection: 0 = perspective, 1 = ortho

{
projection: 0,
eye: [12.2,23.4,34.5],
poi: [12.2,23.4,34.5],
near: 1.23,
far: 1.23,
aspectRatio: 1.23,
orthoHeight: 1.23,
angle: 50.0
}
Since
1.3.5, 20 apr 2014, jh
Remarks
2.1.6, 2018-03-05, ah : added angle
Deprecated:
Use getCameraAsJsonObject() instead

◆ getCameraAsJsonObject

QVariantMap desiteCore::ProjectAPI::getCameraAsJsonObject ( )
slot

Get current camera settings.

Example:

{
"angle": 50.0,
"eye":{
"x": -52.236498896174346,
"y": 136.00571168732904,
"z": 91.61624155645401
},
"far": 30000,
"near": 0.3,
"orthoH": 10,
"poi": {
"x": 22.36818544224709,
"y": 39.28349943044079,
"z":-29.431822043051575
},
"pro":0, // projection: 0 = perspective, 1 = orthographic
"up": {
"x":0,
"y":0,
"z":1
}
}
Since
2.2.5, 24 nov 2018, jh

◆ getClipping

QVariantMap desiteCore::ProjectAPI::getClipping ( int  i)
slot

Get clipping parameters as JSON object.

JSON object:

{
enabled: true,
d: 12.23,
nx: 1.0,
ny: 0.0,
nz: 0.0
}

Example.

for( var i=0; i<6; i++ ) {
var clp = desiteAPI.getClipping(i);
console.append( clp.enabled );
console.append( clp.d );
console.append( clp.nx + '/' + clp.ny + '/' + clp.nz );
}
Since
1.3.5, 19 apr 2014, jh

◆ getCreatedPins

QStringList desiteCore::ProjectAPI::getCreatedPins ( )
slot

Get ids of all pins created since navigation mode was set to 'pin'.

Since
1.4.10, may 2015, jh

◆ getCurrentViewAsImage

QString desiteCore::ProjectAPI::getCurrentViewAsImage ( )
slot

Get the current view as Base64 encoded image.

Example:

<html>
<head>
<script>
function showView()
{
// console.log('show view');
var s = desiteAPI.getCurrentViewAsImage();
imgA.src = 'data:image/png;base64,' + s;
}
</script>
</head>
<body>
<input type="submit" onclick="showView()" value="Show View" /> <br>
<image width="200" id="imgA" />
</body>
</html>
Since
1.3.4, 12 apr 2014, jh

◆ getDocumentsTooltipsVisible

bool desiteCore::ProjectAPI::getDocumentsTooltipsVisible ( )
slot

Check if documents tooltip painter is activated.

◆ getHandlerMode

QVariantMap desiteCore::ProjectAPI::getHandlerMode ( )
slot

Return current handler (navigation) mode with additional info as json object.

See also
setHandlerMode( QVariantMap )
Since
1.9.0. 01 jul 2017, sl

◆ getLightSources

QList<QVariant> desiteCore::ProjectAPI::getLightSources ( )
slot

Get light sources as list of JSON objects.

[
{
"ambient": {"b":0.29411765933036804,"g":0.29411765933036804,"r":0.29411765933036804},
"diffuse": {"b":0.4901960790157318,"g":0.4901960790157318,"r":0.4901960790157318},
"specular":{"b":0.1568627506494522,"g":0.1568627506494522,"r":0.1568627506494522},
"direction": [0,0,0],
"enabled":true,
"followsCamera":true,
"glID":16384,
"position":[2.7,-5,5.2]
},
...
]
Since
2.1.0, 29 may 2017, jh

◆ getNavigationMode

QString desiteCore::ProjectAPI::getNavigationMode ( )
slot
Deprecated:
This method will be removed in future versions of DESITE and should not be used for new scripts anymore.

Get current navigation mode.

See also
setNavigationMode()
Since
1.0.16
Remarks
Deprecated since 1.9.0, 01 Jul 2016
Deprecated:
Use getHandlerMode() instead.

◆ getPainterOptions

QVariantMap desiteCore::ProjectAPI::getPainterOptions ( )
slot

Get Painter Options.

Returns an Object with the following Properties:

Property Type
drawSolid bool
drawTextures bool
drawWired (deprecated) bool
drawEdges bool
edgesColor list(3) of float (RGB)
edgesWidth int
drawComposites bool
drawNegative bool
drawParts bool
backfaceCulling bool
cullSmallGeometry bool
pixelThreshold int
alignmentsWidth int
alignmentsDrawLabels bool
alignmentsLabelScaleFactor double
alignmentsDrawConstructionLines bool
alignmentsSelectSegments bool
lockColor list(3) of float (RGB)
selectionColor list(3) of float (RGB)
drawOOBB bool
drawOOBBxy bool
drawTesselation bool
drawNormalVectors bool
scaleFactorNormals double
selectCompositeParts bool
selectAllCompositeParts bool
selectVisibleCompPartsOnly bool

Example:

var pOpt = desiteAPI.getPainterOptions();
if (pOpt.drawEdges) {
alert( 'Edges are drawn in color ' + pOpt.edgesColor[0] + ',' + pOpt.edgesColor[1] + ',' + pOpt.edgesColor[2] );
}
Since
1.3.8, 06 may 2014, ah

◆ getPickedFaces

QVariantMap desiteCore::ProjectAPI::getPickedFaces ( )
slot

Get picked faces from measure handler (if active) as JS object.

Example:

JSON.stringify(desiteAPI.getPickedFaces(), undefined, 2);
{
"faces": [
{
"triangles": [
[
0,
1,
2
],
[
2,
3,
0
]
],
"vertices": [
[
1694.4953974440796,
-624.4960397721558,
38.35000101928711
],
[
1671.7195980255003,
-637.6460394364624,
38.35000101928711
],
[
1679.86959823302,
-651.7618397958863,
38.35000101928711
],
[
1702.645397651599,
-638.6118401315797,
38.35000101928711
]
]
}
]
}
Since
2.8.2, 2021-03-25

◆ getPickedPoint

QVariantMap desiteCore::ProjectAPI::getPickedPoint ( )
slot

Get last picked point from measure handler (if active) as JS object. Attribute ip contains the internal model coordinates, attribute p the global coordinates.

Example:

JSON.stringify( desiteAPI.getPickedPoint(), undefined, 2 );
{
"ip":[-9.793106549424811,-9.601763445601856,16.2],
"p":[-9.793106549424811,-9.601763445601856,16.2]
}
Since
1.9.0, 08 mar 2016, jh

◆ getPickedPointGK

QVariantMap desiteCore::ProjectAPI::getPickedPointGK ( )
slot

Get last picked point from measure handler (if active) as JS object, in Gauss-Krueger coordinates.

Example:

JSON.stringify( desiteAPI.getPickedPointGK(), undefined, 2 );
{
"h": 5699375.383960576,
"r": 2571694.2875580466,
"z": 38.35000101928711
}
Since
2.2

◆ getPickedPointGPS

QVariantMap desiteCore::ProjectAPI::getPickedPointGPS ( )
slot

Get last picked point from measure handler (if active) as JS object, in GPS coordinates.

Example:

JSON.stringify( desiteAPI.getPickedPointGPS(), undefined, 2 );
{
"Lat": 51.424485207726626,
"Lon": 7.030167203128515
}
Since
2.2

◆ getResourcesTooltipsVisible

bool desiteCore::ProjectAPI::getResourcesTooltipsVisible ( )
slot

Check if resources tooltip painter is activated.

Since
2.5.2, 22 aug 2018, sl

◆ getSelected

QString desiteCore::ProjectAPI::getSelected ( QString  domainFilter = "geometry")
slot

Get selected elements.

Parameters
domainFilterGet only visible of given domains
Returns
List of selected element IDs separated by ';'
Since
1.0.16

◆ getSelectedElements

QStringList desiteCore::ProjectAPI::getSelectedElements ( QString  domainFilter = "geometry")
slot

Get IDs of selected elements as list.

Parameters
domainFilterGet only selected of given domains
Returns
List of selected element IDs
Since
2.2.4, 06 nov 2018, ar

◆ getViewpointAsJsonObject

QVariantMap desiteCore::ProjectAPI::getViewpointAsJsonObject ( const QString &  vpID,
const QStringList &  blacklist = QStringList() 
)
slot

Get the viewpoint 'ID' as JSON object. If the viewpoint could not be found, an empty object is returned. List of selected or visible objects are not returned. To get this data use method getViewpointObjectDataAsJsonObject()

Example and format:

{
"ID": "ba634ebb-7a8b-4209-9b39-42c621d0efc0",
"annotation": "",
"camera": {
"angle": 50,
"eye": {
"x": -2.651556431872601,
"y": 20.847788530747906,
"z": 125.19329605197524
},
"far": 30000,
"near": 0.3,
"orthoH": 10,
"poi": {
"x": -3.8839713485598133,
"y": -16.246041441017695,
"z": 103.18995554738714
},
"pro": 0,
"up": {
"x": 0,
"y": 0,
"z": 1
}
},
"clipoptions": {
"drawEdges": "true",
"drawFaces": true,
"edgeColor": "#ffaa00ff",
"edgeWidth": 2,
"fillColor": "#c0c0c0ff",
"fillColorMode": 1,
"fillOpaqueOnly": true
},
"clippinglist": [{
"enabled": false
},
{
"enabled": false
},
{
"enabled": false
},
{
"d": 12.098503478319836,
"enabled": true,
"nx": 0.27948493207885655,
"ny": -0.9601500782382288,
"nz": 0
},
{
"enabled": false
},
{
"enabled": false
}],
"created": "2018-11-23T20:55:22.635Z",
"createdBy": "jh",
"largeThumb": "89504e470d0a1 ... 426082",
"longAnnotation": "",
"name": "NVP~(1)",
"redlining": {
"rlitemlist": [],
"sh": 1275,
"sw": 1065
},
"saveSel": false,
"saveVis": true,
"thumb": "89504e47 ... e426082"
}
Since
2.2.4, 26 oct 2018, jh

◆ getViewpointList

QVariantMap desiteCore::ProjectAPI::getViewpointList ( )
slot

Get list of viewpoints.
The viewpoints are encoded in a JSON object which contains the ID and the name.

Example:

var vpListJSON = desiteAPI.getViewpointList();
var vpList = vpListJSON.list;
for (var i=0; i<vpList.length; i++)
{
var vpID = vpList[i].ID;
var vpName = vpList[i].name;
var vpAnno = vpList[i].annotation;
console.log("ID: " + vpID + ", name: " + vpName + ", annotation: " + vpAnno );
}
Since
20 Aug 2016
01 Sep 2017

◆ getViewpointMeasureItemsAsJsonObject

QVariantMap desiteCore::ProjectAPI::getViewpointMeasureItemsAsJsonObject ( const QString &  vpID)
slot

Get Measure Items from viewpoint identified by ID.
Resulting object will be empty if the ID was not found or if the viewpoint does not have Measure Items.

Since
2.2.4, 26 oct 2018, jh

◆ getViewpointMetadata

QVariantMap desiteCore::ProjectAPI::getViewpointMetadata ( QString  id)
slot
Parameters
idViewpoint ID
{
"ID": "5c30973f-383b-4269-bc10-d3d1f2d75b0a",
"Name": "RedLining ...",
"comments": [{
"Assigned": "2018-05-28T09:21:35",
"AssignedTo": "jh",
"Comment": "Kommentar\nZ2\nz3",
"ID": "17697025-eaf3-427d-81df-330b9e2b056b",
"Status": "Unknown",
"VerbalStatus": ""
}]
}
Since
2.0.13, 26 may 2017, jh

◆ getViewpointObjectDataAsJsonObject

QVariantMap desiteCore::ProjectAPI::getViewpointObjectDataAsJsonObject ( const QString &  vpID)
slot

Get information about visible/selected objects from a Viewpoint identified by ID.
Resulting object will be empty if the ID was not found or if the viewpoint does not store visible/selected object lists.

Since
26 oct 2018, 2.2.4, jh

◆ getVisible

QString desiteCore::ProjectAPI::getVisible ( QString  domainFilter = "geometry")
slot

Get visible elements.

Parameters
domainFilterGet only visible of given domains
Returns
List of element IDs separated by ';'
Since
1.0.16

◆ getVisibleElements

QStringList desiteCore::ProjectAPI::getVisibleElements ( QString  domainFilter = "geometry")
slot

Get IDs of visible elements as list.

Parameters
domainFilterGet only visible of given domains
Returns
List of visible element IDs
Since
2.2.4, 06 nov 2018, ar

◆ getVisualisationMode

int desiteCore::ProjectAPI::getVisualisationMode ( )
slot
Since
1.5.0, 21 jul 2015, jh

◆ getVisualizationOptions

QVariantMap desiteCore::ProjectAPI::getVisualizationOptions ( )
slot

Get Visualization Options.

Returns an Object with the following Properties:

Property Type
drawOrigin bool
drawGrid bool
gridDistanceFine double
gridDistanceBold double
drawBoundingBox bool
showFramerate bool
enableFastPaint bool
lineStepFastPaint int
walkSpeed double
decimalPlaces int
bgColor list(3) of float (RGB)
lineStep int
drawNorthArrow bool
northArrowPos list(3) of float (xyz)
northArrowRot double
modelCoordinates list(2) of double (xy)
gpsLat double
gpsLon double

Example:

var visOpt = desiteAPI.getVisualizationOptions();
if (visOpt.drawNorthArrow) {
alert( 'North arrow at coordinates ' + visOpt.northArrowPos[0] + ',' + visOpt.northArrowPos[1] + ',' + visOpt.northArrowPos[2] );
}
Since
1.3.5, 22 apr 2014, ah

◆ getWebFormLocations

QVariantMap desiteCore::ProjectAPI::getWebFormLocations ( )
slot

Return an object containing all stored WebForm sources.
Keys:

  • default: Contains the full path to 'DbInputForm.html' in the current project directory, if found. If not found, the value will be empty.
  • projectBookmarkList: A list of WebForm bookmarks stored in the current project (if any). This list contains objects with keys name and url.
  • globalList: List of session global URLs that have been set by command line switch or config file.

Example:

{
"default": "Y:/D-41-TEST-PROJECTS/-001.06-2.6-CD-Test-IFC-BCF-PropTest/DbInputForm.html",
"globalList": [],
"projectBookmarkList": [{
"name": "CPT START",
"url": "https://office.ceapoint.com/CLOUD//Kd_CEAPOINT/index.html"
}]
}
Since
2.5.3, 2019-12-03, ah

◆ hasSelected

bool desiteCore::ProjectAPI::hasSelected ( QString  domainFilter = "all")
slot

Check if the domain projects have selected elements.

Parameters
domainFilterCheck only given domains. Default is 'all' domains.
Since
1.5.0

◆ hasVisible

bool desiteCore::ProjectAPI::hasVisible ( QString  domainFilter = "all")
slot

Check if the domain projects have visible elements.

Parameters
domainFilterCheck only given domains. Default is 'all' domains.
Since
1.5.0

◆ hideAll

void desiteCore::ProjectAPI::hideAll ( bool  repaint,
QString  domainCombination = "geometry" 
)
slot

Hide all objects of domain (combinations allowed). Blocked objects are not included.

Parameters
repainttrue: Refresh 3D-view
Since
1.0.16

◆ hideDimensionsPainter

void desiteCore::ProjectAPI::hideDimensionsPainter ( )
slot

Switch dimension painter off.

Since
1.4.8, 29 sep 2014, jh

◆ hideElements

void desiteCore::ProjectAPI::hideElements ( QString  idList,
bool  ignoreObjectLocking = false,
QString  domainCombination = "geometry" 
)
slot
Parameters
ignoreObjectLockingHide also objects if they are blocked [optional]
Since
1.0.16
Remarks
1.3.8 Added optional parameter 'ignoreObjectLocking', jh

◆ importBCF

bool desiteCore::ProjectAPI::importBCF ( QString  sourceFilePath)
slot

Import a BCFZIP file.

Parameters
sourceFilePathSource BCFZIP file
Returns
true if import was successful, false else
Since
2.5.2, 2019-08-01, ah

◆ importModel

QVariant desiteCore::ProjectAPI::importModel ( QString  filename,
bool  showDialog = true,
QVariantMap  options = QVariantMap() 
)
slot

Import a model into the current project.
This will only work for DESITE products that support model imports (e.g. MD, MD PRO, but not CUSTOM).

Parameters
filenameFilename of the model to be imported. Format will be determined by extension.
showDialogIf set to false, no import dialog is shown and default (or passed) options will be used. By default true.
optionsTBI, passing an object here will currently have no effect
Returns
Model ID on success, else -1 (more detailed error codes TBI).
Since
2.5.1, 2019-07-09, ah
2.5.4, 2020-02-17, ah (returning model ID on success)

◆ message

int desiteCore::ProjectAPI::message ( QString  )
slot

Send a message to the Remote interface of the desite application. This is the same interface as it can be used with a TCP-socket. The interface is documented in the tutorial 'desite_remote.pdf'.

Example:
show a message in a message window:

desiteAPI.message( "<cmdMessage><![CDATA[<font size=\"+2\" color=\"#ffffff\">Nur ein Objekt selektieren!</font>]]></cmdMessage>");
Since
1.0.18, 15 aug 2012, jh

◆ moveToLocationGps

void desiteCore::ProjectAPI::moveToLocationGps ( double  lat,
double  lon 
)
slot

Move camera in 3d view to location given by GPS coordinates (decimal degrees).

Since
2.0.19, 03 mar 2018, jh

◆ openLink

void desiteCore::ProjectAPI::openLink ( QString  url,
bool  useDesktopService 
)
slot

Open an URL by passing this url to the operating system or to the project.

Parameters
useDesktopServicetrue: The URL is passed directly to the operating system
false: The project handles the link, this enables paths relative to the project directory
// Open webpage in standard browser.
desiteAPI.openLink( 'http://www.thinkproject.com', true );
Since
1.3.1, 27 feb 2014, jh

◆ openProject

void desiteCore::ProjectAPI::openProject ( QString  url,
bool  useSessionData 
)
slot

Open project in this instance.

Parameters
useSessionDataOpen project with last session settings such as last viewpoint.
Since
1.3.3, 02 apr 2014, jh

◆ redirectDocument

int desiteCore::ProjectAPI::redirectDocument ( QString  modelId,
QString  newSourceFilePath 
)
slot

Redirect a model source file to a new local path.
Note that the source redirection will have no immediate effect. The project must be saved and reopened to trigger a model update from the new location.

Parameters
newSourceFilePathPath and file name of the new model source
Returns
Error Code:
1 - OK
0 - Undefined
-1 - Error: No model with given ID found.
-2 - Error: New source file not found or not accessible.
-3 - Error: The new source file is not of the same data format
Since
2.7.1, 2020-11-23, ek/ah

◆ removeFromViewPoint

void desiteCore::ProjectAPI::removeFromViewPoint ( QString  vpID,
QString  objIdList 
)
slot

Remove a list of objects from a Viewpoint's visible objects

Since
2.0.16, 2017-09-04, ah (port from 1.4)

◆ removeWebFormBookmark

int desiteCore::ProjectAPI::removeWebFormBookmark ( QString  url)
slot

Remove a WebForm bookmark by URL.

Returns
1 Bookmark removed
-1 Bookmark not found.
Since
2.5.3, 2019-12-03, ah

◆ repaint3DView

void desiteCore::ProjectAPI::repaint3DView ( )
slot

Refresh 3D-view.

Since
1.0.16

◆ saveCPA

int desiteCore::ProjectAPI::saveCPA ( QString  cpa_filename,
QString  pack_bookmark 
)
slot

Write CP Archive to 'cpa_filename'. A missing suffix (*.cpa) will be appended.

Parameters
cpa_filenameFilename of archive with complete path. If no absolute path is given the CP Archive is written to the parent directory of the project directory.
pack_bookmarkName of bookmark to apply. If the bookmark does not exist, the default file list is used for creating the CP Archive.
Returns
Error Code:
1 - OK
-1 - Error : Internal error.
-2 - Error: Project directory is empty. Project must be saved first.
Since
2.1.0, 31 may 2017, jh

◆ saveCurrentViewToFile

bool desiteCore::ProjectAPI::saveCurrentViewToFile ( QString  filename)
slot

Save the current view to a file. The format is specified by the extension of the filename.

Supported formats are *.jpg, *.png

Example:

var s = desiteAPI.saveCurrentViewToFile( 'C:/tmp/abc.jpg' );
// if s = false, picture could not be saved
Since
12 aug 2016, 2016, jh

◆ saveProject

int desiteCore::ProjectAPI::saveProject ( )
slot

Save current project.

Returns
1 ok
0 undefined
-1 could not save
Since
2.1.0, 16 may 2017

◆ saveViewpoint

QString desiteCore::ProjectAPI::saveViewpoint ( QString  name,
bool  saveVisible = true,
bool  saveSelected = false,
QString  desc = QString(),
bool  saveRedlining = false,
bool  copyMeasureItems = false 
)
slot

Create a viewpoint from current view.

Parameters
saveVisible: Store the visible objects to new viewpoint
saveSelected: Store the selected objects to new viewpoint
desc: Description
Returns
ID of new viewpoint.
Since
1.3.5, 18 apr 2014, jh

◆ selectElements

void desiteCore::ProjectAPI::selectElements ( QString  idList,
bool  flag,
QString  domainCombination = "geometry" 
)
slot

Select objects given by IDs.

Parameters
idListString of object IDs separated by ';'.
flagtrue = select, false = unselect elements
Since
1.0.16

◆ selectVisible

void desiteCore::ProjectAPI::selectVisible ( )
slot

Select visible 3D objects and generic elements. 3D-view is refreshed afterwards.

Since
1.0.16

◆ selectVisibleGeometric

void desiteCore::ProjectAPI::selectVisibleGeometric ( )
slot

Select visible 3D objects. 3D-view is refreshed afterwards.

Since
1.0.17, 01 jul 2012, jh

◆ sendRemoteMessage

bool desiteCore::ProjectAPI::sendRemoteMessage ( QString  message)
slot

Send a message to the Remote client socket (by default localhost:45455; for more info on the Remote interface, see documentation).
The message does not need to follow any particular format or convention.
Note that, since the Remote socket communication is connectionless, there is no way of checking if anyone actually received the message.

Returns
false if Remote was not initialized correctly, else true.
Since
2.5.2, 2019-08-13, ah

◆ set4dDateTime

bool desiteCore::ProjectAPI::set4dDateTime ( QDateTime  dt)
slot

Set current date/time of 4D-Simulation.

Returns
true if date could be set and model is painted, false if a date is just being set.
Since
1.5.0, 14 oct 2015, jh

◆ set4dIsActive

void desiteCore::ProjectAPI::set4dIsActive ( bool  active)
slot

Activate/Deactivate 4D-Simulation.

Since
1.5.0, 14 oct 2015, jh

◆ set4dOptions

void desiteCore::ProjectAPI::set4dOptions ( QVariantMap  opt)
slot

Set 4D options from JSON object.

See also
get4dOptions()
Since
1.5.0, 14 oct 2015, jh

◆ setBsPlanUnderlayActive

void desiteCore::ProjectAPI::setBsPlanUnderlayActive ( bool  active)
slot

Draw plan underlay of building structure. Activate drawing of plan underlay. The plan underlay is drawn for visible building structure items.

The plan underlay must be created from linked 3d-objects first.

Parameters
activetrue: activate, false: deactivate
Since
2.0, jh

◆ setCamera

void desiteCore::ProjectAPI::setCamera ( QVariantMap  cam)
slot

Set camera.

Parameters
cam: Camera encoded as JSON
var cam = {
near: 0.5,
far: 25000,
eye: [ 0.0, 1.0, 2.0 ],
poi: [ 10.0, 8.0, 3.0 ],
angle: 50.0,
projection: 0
}
desiteAPI.setCamera( cam );
Since
1.3.5, 20 apr 2014, jh
Remarks
2.1.6, 2018-03-05, ah : added angle
Deprecated:
Use setCameraFromJsonObject() instead

◆ setCameraFromJsonObject

void desiteCore::ProjectAPI::setCameraFromJsonObject ( QVariantMap  camJSON)
slot

Set current camera settings.

Parameters
camJSONObject holding the camera data
See also
getCameraFromJsonObject();
Since
2.2.5, 24 nov 2018, jh

◆ setClipping

void desiteCore::ProjectAPI::setClipping ( int  i,
QVariantMap  clp 
)
slot
Parameters
i: Index of clipping plane [0,5]
var clp = { enabled: true, d: 12.0, nx: 1.0, ny: 0.0, nz: 0.0 }
desiteAPI.setClipping( 0, clp );
Since
1.3.5, 19 apr 2014, jh

◆ setDocumentsTooltipsVisible

void desiteCore::ProjectAPI::setDocumentsTooltipsVisible ( bool  v)
slot

Switch documents tooltip painter on/off.

◆ setHandlerMode

bool desiteCore::ProjectAPI::setHandlerMode ( QVariantMap  handlerInfo)
slot

Set handler for navigation mode.

Parameters
handlerInfoJSON object containing type of handler which is one of the following:
'select', 'orbit', 'pan', 'walk', 'lookaround', 'zoom', 'measure', 'cutting', 'pin', 'redline', 'clipping'
Returns
true, if handler could be set, else false

Examples:

Select Handler

var handlerInfo = {
type: 'select'
}

Orbit Handler

var handlerInfo = {
type: 'orbit'
}

Measure Handler

var handlerInfo = {
type: 'measure',
mode: 'points' // one of 'points', 'lines', 'polylines', 'polygons', 'faces', 'distance'
}

Cutting Handler

var handlerInfo = {
type: 'cutting',
mode: 'perpendicular', // one of 'horizontal', 'vertical', 'perpendicular'
snap: 'point' // one of 'point', 'line'
}

Pin Handler

var handlerInfo = {
type: 'pin',
containerID: 'xyz123', // parent container id of pins,
scaleX: 0.5 // scale of object
}

Redlining Handler

var handlerInfo = {
type: 'redline',
mode: 'rect', // one of 'rect', 'oval', 'text', 'freehand', 'arrow', 'erase'
penWidth: 5, // should be 1, 5 or 10
penColor: 'red', // one of 'red', 'green', 'blue' or hex-coded RGB color value
brushColor: '#FFFF00' // one of 'red', 'green', 'blue' or hex-coded RGB color value
}

Clipping Handler

var handlerInfo = {
type: 'clipping',
drawEdges: true,
drawFaces: true,
edgeColor: '#FFAA00FF', // hex-coded RGB(A) color value
edgeWidth: 2, // 1-9
fillColor: '#647882FF', // hex-coded RGB(A) color value
fillColorMode: 1, // 1 = user defined color, 2 = object color
fillOpaqueOnly: true
}
Since
1.9.0, 01 jul 2017, sl
2.8.2, 14 apr 2021, sl: added missing 'walk' handler and mode 'distances' to measure handler
2.8.5, 03 dec 2022, sl: added missing 'clipping' handler

◆ setLightSources

void desiteCore::ProjectAPI::setLightSources ( QList< QVariant >  lList)
slot

Set light sources from list of JSON objects.

See also
getLightSources()
Since
2.1.0, 29 may 2017, jh

◆ setNavigationMode

void desiteCore::ProjectAPI::setNavigationMode ( QString  mode,
QString  pinModeContainerID = QString() 
)
slot
Deprecated:
This method will be removed in future versions of DESITE and should not be used for new scripts anymore.

Modes: 'pin', 'select', 'orbit', 'pan', 'lookaround', 'zoom', ...

Parameters
pinModeContainerIDIF pinMode this is the parentcontainer where the pins are created.
Since
1.0.16
Remarks
Deprecated since 1.9.0, 01 Jul 2016
Deprecated:
Use setHandlerMode( QVariantMap mode ) instead.

◆ setPainterOptions

void desiteCore::ProjectAPI::setPainterOptions ( QVariantMap  opt)
slot

Set Painter Options

Parameters
opt: Options encoded as a JSON object

See getPainterOptions() for a list of all properties; not all must be set!

Example:

desiteAPI.setPainterOptions({ drawWired: true, edgesColor: [1.0, 0.0, 0.0] });
Since
1.3.8, 06 may 2014, ah

◆ setResourcesTooltipsVisible

void desiteCore::ProjectAPI::setResourcesTooltipsVisible ( bool  v)
slot

Switch resources tooltip painter on/off.

Since
2.5.2, 22 aug 2018, sl

◆ setViewpointObjectDataFromJsonObject

int desiteCore::ProjectAPI::setViewpointObjectDataFromJsonObject ( const QString &  vpID,
const QVariantMap &  vm 
)
slot

Set visible/selected objects from an object map.

Returns
1 ok
0 no changes
-1 failed to look up ID
Since
2.2.4, 26 oct 2018, jh

◆ setVisualisationMode

void desiteCore::ProjectAPI::setVisualisationMode ( int  mode,
bool  repaint = true 
)
slot

0 - Normal
1 - Wire Mode, Selected in Model Color, Unselected as Lines in Model Color
2 - Wire Mode, Selected in Model Color, Unselected as Lines in grey

Since
1.0.16

◆ setVisualizationOptions

void desiteCore::ProjectAPI::setVisualizationOptions ( QVariantMap  opt)
slot

Set Visualization Options

Parameters
opt: Options encoded as a JSON object

See getVisualizationOptions() for a list of all properties; not all must be set!

Example:

desiteAPI.setVisualizationOptions({ drawNorthArrow: true, northArrowPos: [5.0, 5.0, 0.0] });
Since
1.3.5, 22 apr 2014, ah

◆ showAll

void desiteCore::ProjectAPI::showAll ( bool  repaint,
QString  domainCombination = "geometry" 
)
slot

Show all objects of domain (combinations allowed).

Parameters
repainttrue: Refresh 3D-view
Since
1.0.16

◆ showClashList

void desiteCore::ProjectAPI::showClashList ( QString  clashIdList)
slot

Show conflicted objects of given clashes.

Since
1.9.0, 04 aug 2016, jh

◆ showColorSchema

int desiteCore::ProjectAPI::showColorSchema ( QString  name)
slot

Show color schema by name.

Parameters
nameName of color schema. 'reset' will reset color schema and show source materials of objects.
Returns
1 Ok
-1 Color Schema does not exist
Since
1.0.16
Remarks
deprecated, use bool AutomationAPI::activateColorSchemaByName( QString name ) instead!

◆ showDimensionsPainter

void desiteCore::ProjectAPI::showDimensionsPainter ( bool  showAABB,
bool  showOOBB 
)
slot

Switch dimension painter on. Show dimensions of selected objects.

Parameters
showAABBShow dimensions of axis aligned bounding box of selected objects
showOOBBShow dimensions of optimized, orientated bounding box of selected objects
Since
1.4.8, 29 sep 2014, jh

◆ showElements

void desiteCore::ProjectAPI::showElements ( QString  idList,
bool  includeBlocked = false,
QString  domainCombination = "geometry" 
)
slot
Parameters
includeBlockedShow also objects if they are blocked [optional]
Since
1.0.16
Remarks
1.3.8 Added optional parameter 'includeBlocked', jh

◆ showElementsOnly

void desiteCore::ProjectAPI::showElementsOnly ( QString  idList,
QString  domainCombination = "geometry" 
)
slot

Hide all objects and show objects in list 'IDList' only.

Parameters
IDListList of Object IDs separated by ';'.
Since
1.3.5, 19 apr 2014, jh

◆ showElementsOOBBFront

QVariantMap desiteCore::ProjectAPI::showElementsOOBBFront ( QString  idList,
double  prec = 1.e-2 
)
slot

Show objects from front or back, determined by current camera position and by width and height of Optimized Bounding Box of objects.

Parameters
IDListString with object IDs, separated by ';'.
Returns
Temporarily calculated Optimized Bounding Box as JSON-Object.
See also
showElementsOOBBSide(QString, double)
Since
1.4.8, 29 sep 2014, jh

◆ showElementsOOBBSide

QVariantMap desiteCore::ProjectAPI::showElementsOOBBSide ( QString  IDList,
double  prec = 1.e-2 
)
slot

Show objects from left or right side, determined by camera current position and by length and height of Optimized Bounding Box of objects.

Parameters
IDListString with object IDs, separated by ';'.
Returns
Temporarily calculated Optimized Bounding Box as JSON-Object.
{
Height: 2.45,
Width: 1.23,
Length: 4.56
}
Since
1.4.8, 29 sep 2014, jh

◆ showElementsOOBBTop

QVariantMap desiteCore::ProjectAPI::showElementsOOBBTop ( QString  IDList,
double  prec = 1.e-2 
)
slot

Show objects from top or bottom, determined by current camera position and by length and width of Optimized Bounding Box of objects.

Parameters
IDListString with object IDs, separated by ';'.
Returns
Temporarily calculated Optimized Bounding Box as JSON-Object.
See also
showElementsOOBBSide(QString, double)
Since
1.4.8, 29 sep 2014, jh

◆ showOnScreenKeyboard

void desiteCore::ProjectAPI::showOnScreenKeyboard ( )
slot

Open virtual keyboard.

Since
1.9.0, 27 may 2016, jh
Remarks
update 2.0.9, 16. jan 2017, ar, for Windows10

◆ showOpenFileDialog

QString desiteCore::ProjectAPI::showOpenFileDialog ( QString  caption = "",
QString  directory = "",
QString  filter = "" 
)
slot

Show an "Open File" dialog to choose the path and name of a file.

Parameters
captionTitle of the dialog (default 'Open File')
directoryDirectory which is initially displayed
filterFile filter (default 'All files (*.*)'). Format example:
"JPEG (*.jpg *.jpeg);; TIFF (*.tif);; All files (*.*)"

You could also use a standard HTML input, for example:

<input type="file" onchange="alert(window.webkitURL.createObjectURL(this.files[0]))">

An Object URL created like this represents the specified file object and can be used to access the file, but for security reasons, it will never reveal the actual file's path.
If you need the unencrypted path, use this function instead.

Returns
Path of the file that got selected in the Dialog.
Since
2.2.4, 16 oct 2018, th
Remarks
updated on 08 nov 2018, sl: added optional parameters

◆ showSaveFileDialog

QString desiteCore::ProjectAPI::showSaveFileDialog ( QString  caption = "",
QString  directory = "",
QString  filter = "" 
)
slot

Show a "Save File" dialog to choose the path and name of a file to save to.

Parameters
captionTitle of the dialog (default 'Save File')
directoryDirectory which is initially displayed
filterFile filter (default 'All files (*.*)'). Format example:
"JPEG (*.jpg *.jpeg);; TIFF (*.tif);; All files (*.*)"
Returns
Path and name of the file given by the user.
Since
2.5.4, 2020-02-03, ah

◆ showViewpoint

int desiteCore::ProjectAPI::showViewpoint ( QString  name)
slot

Show a viewpoint by name.

Returns
1 : ok
-1 : viewpoint 'name' could not be found
Since
1.0.16

◆ showViewpointByID

int desiteCore::ProjectAPI::showViewpointByID ( QString  id)
slot

Show a viewpoint by ID.

Returns
1 : ok
-1 : viewpoint 'id' could not be found
Since
1.3.5

◆ startEXE

void desiteCore::ProjectAPI::startEXE ( QString  prg,
QString  args 
)
slot

Start program

Search order for programs is:
1) absolute path
2) application directory
3) project directory

Since
1.0.17, 18 jul 2012, jh

◆ zoomToAllDocuments

void desiteCore::ProjectAPI::zoomToAllDocuments ( )
slot

Documents have a location. Zoom the screen so all documents are fitted in the 3D-view.

Since
1.9.0, 09 apr 2016, jh

◆ zoomToAllResources

void desiteCore::ProjectAPI::zoomToAllResources ( )
slot

Resources (Instances) have a location. Zoom the screen so all resources are fitted in the 3D-view.

Since
1.9.0, 09 apr 2016, jh

◆ zoomToDocuments

void desiteCore::ProjectAPI::zoomToDocuments ( QStringList  idList)
slot

Zoom to given documents in 3D view.

Parameters
idListArray of IDs.
Since
1.9.0, 09 apr 2016, jh

◆ zoomToLocationGK

void desiteCore::ProjectAPI::zoomToLocationGK ( double  rw,
double  hw,
double  h 
)
slot

Zoom to location given by Gauss-Krueger coordinates.

Since
2.0.19, 03 mar 2018, jh

◆ zoomToLocationGps

void desiteCore::ProjectAPI::zoomToLocationGps ( double  lat,
double  lon 
)
slot

Zoom to location given by GPS coordinates (decimal degrees).

Since
2.0.19, 03 mar 2018, jh

◆ zoomToObjects

void desiteCore::ProjectAPI::zoomToObjects ( QString  objIDs)
slot

Zoom to given objects.

The view is adjusted in such a way that all selected 3D-objects fit into the current view. The view direction (vector eye -> poi) is not changed, just the eye point is moved.

Parameters
objIdsString holding the object IDs, separated by ';'.
Since
1.9.0, 09 may 2016, jh

◆ zoomTopView

void desiteCore::ProjectAPI::zoomTopView ( )
slot

Show elements from top. Zoom to visible if no elements are selected, otherwise zoom to selected objects.

Since
1.0.16

◆ zoomToResources

void desiteCore::ProjectAPI::zoomToResources ( QStringList  idList)
slot

Zoom to resources in 3D view. The resources are given by an ID list.

Since
1.9.0, 09 apr 2016, jh

◆ zoomToSelected

void desiteCore::ProjectAPI::zoomToSelected ( )
slot

Zoom to selected 3D-objects.

The view is adjusted in such a way that all selected 3D-objects fit into the current view. The view direction (vector eye -> poi) is not changed, just the eye point is moved.

Since
1.0.16

◆ zoomToSelectedDocuments

void desiteCore::ProjectAPI::zoomToSelectedDocuments ( )
slot

Documents have a location. Zoom the screen so the selected documents are fitted in the 3D-view.

Since
1.9.0, 09 apr 2016, jh

◆ zoomToSelectedResources

void desiteCore::ProjectAPI::zoomToSelectedResources ( )
slot

Resources (Instances) have a location. Zoom the screen so the selected resources are fitted in the 3D-view.

Since
1.9.0, 09 apr 2016, jh

◆ zoomToVisible

void desiteCore::ProjectAPI::zoomToVisible ( )
slot

Zoom to visible 3D-objects.

The view is adjusted in such a way that all visible 3D-objects fit into the current view. The view direction (vector eye -> poi) is not changed, just the eye point is moved.

Since
1.0.16

◆ zoomToVisibleDocuments

void desiteCore::ProjectAPI::zoomToVisibleDocuments ( )
slot

Documents have a location. Zoom the screen so the visible documents are fitted in the 3D-view.

Since
1.9.0, 09 apr 2016, jh

◆ zoomToVisibleResources

void desiteCore::ProjectAPI::zoomToVisibleResources ( )
slot
Since
1.9.0, 09 apr 2016, jh

The documentation for this class was generated from the following file:

Created: Tue Dec 13 2022 13:14:00