#include <domainBim/AutomationAPI.h>
Public Slots | |
FIND OBJECTS | |
| 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) |
DOCUMENTS - SYNC, METADATA | |
| int | synchronizeDocumentContainer (QString containerId, QScriptValue callback=QScriptValue(), bool blockExecution=false) |
| void | resetDocumentMetaData (QString objId) |
ACTIVITIES - TOOLS | |
| QVariantMap | getVisualisationList () |
| int | setVisualisationByID (QString taskIDList, QString visID) |
| int | removeVisualisation (QString taskIDList) |
| int | setTaskMode (QString taskID, int mode) |
| QVariantMap | calcPropertyValuesOverTime (QString propName, QString propType, QVariantMap options) |
GEOMETRY | |
| 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()) |
| QString | mergeObjects (QString parentContainerId, QString idList, bool skipClosed=false, bool keepTransparency=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) |
SELECTION SETS | |
| 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 objectIDList) |
| QString | createSelectionSet (QString name, QString parentID=QString()) |
| bool | removeSelectionSet (QString selsetID) |
MODELS | |
| 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) |
PROJECT | |
| void | setCloudSettings (QVariantMap vm) |
| void | setTempValue (QString name, QVariant value) |
| QVariant | getTempValue (QString name) |
| QStringList | getListOfTempValues () |
| void | clearListOfTempValues () |
LINKED OBJECTS | |
| int | setLinkedObjects (const QString &elementID, const QString &IDList) |
| int | removeAllLinkedObjects (QString id) |
| int | removeLinkedObjects (QString id, QString linkedIdList) |
PROPERTY TYPES | |
| 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) |
PROPERTIES | |
| 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) |
PROPERTY SCRIPTS | |
| 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) |
GEOMETRY - MATERIALS | |
| 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 () |
GEOMETRY - COLOR SCHEMA | |
| 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) |
GEOMETRY- WIREMODE | |
| 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 () |
BOUNDINGBOX | |
| 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) |
CREATE / DELETE OBJECTS / GET OBJECTS | |
| 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) |
REGIONS OF ALIGNMENTS | |
| 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()) |
FILE OPERATIONS | |
| int | createDirectory (QString path, QString dirName) |
| bool | writeFile (QString filePath, const QString &content, const QString &encoding=QString()) |
| 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()) |
| 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="") |
| QVariantList | getDirectoryEntryList (QString dirPath, bool filesOnly=false, QString orderBy="Name") |
Database | |
| 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) |
Object Tooltips | |
| QStringList | getListOfObjTooltips () |
| void | addObjectListToTooltip (QString idList, QString tooltipname) |
| void | removeObjectListFromTooltip (QString idList, QString tooltipname) |
Locking of Objects | |
| void | lockObjects (QString idList) |
| void | unlockObjects (QString idList) |
| void | unlockAllObjects () |
| QString | getLocked () |
| int | countLocked () |
Object Iterator | |
| 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) |
 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 objId, double d) |
| double | getStationOfProjectedPoint (QString objId, 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) |
| int | updateRuleBasedLinks (QString domainName, bool visibleOnly=false) |
| int | removeRuleBasedLinks (QString domainName) |
DESITE API for scripting in automation.
(c) ceapoint aec technologies GmbH
|
slot |
Activate color scheme with given name (case sensitive). If name is empty, materials will be restored. View will be repainted.
|
slot |
|
slot |
Add object list to tooltip.
| idList | List of objects |
| tooltipname | Name of the tooltip template |
|
slot |
|
slot |
Add property type bookmark.
| bookmarkConfig | Bookmark config information map. For format description see getPropertyTypeBookmarkByID() |
|
slot |
Add an ADDITIONAL range to a region (a region can have several - possibly disjunct - ranges with the same value).
| regionId | ID of region (will be returned if region is successfully added to an alignment) |
| fromStation | Lower bound of range |
| toStation | Upper bound of range |
| alignmentId | ID of alignment. Optional parameter, if given, method is faster, because not all objects have to be searched |
|
slot |
Add a region with a first given range and value to an alignment (simplified, linear representation of a road or track).
A region is represented by a strip along an alignment with a name, value and color and is used to visualize different properties/data, indicated by a color and a value, along the alignment. Further ranges (which will get the same name, color and value) can be added to this region afterwards. At the beginning of each range, the name and the value set will be drawn (like stations).
| alignmentId | ID of alignment |
| options | Options, given as json object (see below). |
Example
|
slot |
Add objects to selection set in domain 'geometry'.
|
slot |
Append a string to a file. User must not take care of opening and closing the file.
| filePath | Name and path of the file to be written. If no path is given, the current project's path will be used. |
| content | String to be appended to the end of the file |
| encoding | File encoding, such as "ISO 8859-1", "UTF-8", or "UTF-16" (optional) |
|
slot |
Calculate distance between two surface objects.
| objId1 | ID of first object |
| objId2 | ID of second object |
|
slot |
Calculate optimized, orientated bounding box (OOBB) of all given geometric objects and set it to them. The bounding box is only calculated and set if an object has no OOBB yet.
| objIdList | IDs of objects to be affected (separated by ';') |
| eps | Threshold for optimization (default: 0.001) |
|
slot |
Calculate optimized, orientated bounding box in xy-plane (OOBBxy) of all given geometric objects and set it to them. The bounding box is only calculated and set if an object has no OOBBxy yet.
| objIdList | IDs of objects to be affected (separated by ';') |
| eps | Threshold for optimization (default: 0.001) |
|
slot |
Calculate property values over time. Returns an object with a list of property values for each day between startDay and endDay.
Options:
Return:
|
slot |
Checks if a file exists
| filePath | Name and path of the file. If no path is given, the current project's path will be used. |
|
slot |
Check if two geometric objects intersects.
| objId1 | : ID of object #1 |
| objId2 | : ID of object #2 |
| tolerance | : Numerical tolerance (default -0.00001). If tolerance is set to a small negative value, objects may overlap without intersection detected. A value > 0 means approach. |
|
slot |
Check overlap of oriented bounding boxes of two given objects with 'id1' and 'id2'. If an OOBB has not been already calculated for each object, it will be calculated with numerical precision eps (default 0.01).
Note: In case of two OBBs with the same orientation it is the exact percentage of overlap, else only a indicative value. If no geometric object exists for one of both IDs, 0.0 will be returned.
|
slot |
Set all objects to normal mode, 3D view will be refreshed.
|
slot |
Close an open file. There can only be one open file at once!
|
slot |
Copy file 'fnFrom' to file 'fnTo'.
|
slot |
Count locked objects.
|
slot |
Count objects which are in wireframe mode.
|
slot |
Create color schema with given name from the hierarchy (content) given by a container.
| setContainerId | ID of container whose content defines the color schema. For each contained container a material is created with the container names. |
| name | Name of new color schema. If name already exists it is augmented by an index, e.g. '~(2)'. |
|
slot |
Create color scheme with given name from current material settings.
| name | Name of new color scheme |
| updateExisting | If 'true' an already existing color scheme is updated, otherwise a new color scheme is created. If name already exists it is augmented by an index, e.g. '~(2)'. |
| Options,e.g. | if a legend shall be drawn if color scheme is applied |
Options:
|
slot |
Create contact object (contact surface) between two objects. If angle > 0, the resulting surface may differ for each object. In this case the projection on object 1 ist choosen.
| parentId | : ID of container the newly created object should be added. |
| objId1 | : ID of object 1. |
| objId2 | : ID of object 2. |
| matId | : ID of material of the newly created object. If empty, a default material (dark orange) will be chosen. |
| options | : Options encoded as JSON. If not specified, the default values of the code snipped (see below) will be chosen. |
|
slot |
Create new directory at given file path. Resulting directory path is path + '/' + dirName.
| dirName | Name of new directory |
| path | File path of directory in which new directory should be created (relative paths are allowed) |
|
slot |
Create a new material for visualization. If the material already exists the existing material is not changed.
| matXml | Material encoded as XML. If a tag is missing, default values are set. |
| modelId | Create a new material in this model. If the model is not found or the string is empty (default) the standard model of the geometry project is used. |
Example:
|
slot |
Create a new model in a specified domain.
By default the model is empty.
For models within the geometry and documents domain a root container has to be created. to access the rootnode in the model use method getRootNodeByModel(). The model itself is not visible in the GUI.
| name | Name of model |
| domain | Domain in which model is created. This is one of
|
| createRootC | If true, create a root container (in domain 'geometry': a container on which transformations can be applied) with the same name as the new model (only for domains: geometry/documents!) |
|
slot |
Create an attribute object (no geometry).
| parentId | ID of parent container |
| name | Name of new object. |
|
slot |
Create a new object encoded by XML.
If ID (attribute ID="..." in code) is not given or is already used in the project, a new ID will be created.
| parentId | ID of parent element |
| objectXML | XML code |
Error Codes:
Available objects
Examples
Available objects
Note: If WBS is empty, it will be automatically created from parent task WBS and child index of the new task.
Examples
Available objects
Available types:
typeBsUnknown
typeBsContainer
typeBsSection (general containment)
typeBsSite
typeBsBuilding
typeBsBuildingStorey
typeBsLevel (arbitrary level)
typeBsUnit (e.g. an apartment unit)
typeBsSpace (room)
typeBsLocation (any location point)
typeBsAlignment (e.g. road)
typeBsStation (station point of alignment)
typeBsSegment (e.g. line, curve or spiral)
typeBsTakt
Examples
Create two nested sections in the building structure
Available objects
Examples
Note that a "document" object can be used either as a file link or as a URL.
A "documentDir" will scan contained directories recursively, so deeply nested directory structures may incur a performance penalty.
Available objects
Examples
Available types:
1 - Category (LV-Bereich)
2 - BOQ-Item (LV-Position)
3 - Markup Item (Zuschlagsposition)
4 - Remark (Hinweistext)
5 - Performance Description (Ausfuehrungsbeschreibung)
6 - Sub-Description (Unterbeschreibung)
7 - Invalid, reserved for internal use
8 - AddText (Zusatztext)
9 - Take-Off Sheet (Aufmassblatt)
10 - Take-Off Row (Aufmasszeile)
qty is the quantity as floating point number (double). unit is the unit of measurements as text. up is the unit price as a floating point number (double).
Example JavaScript:
Available objects
Examples
Available objects
Examples
ID, prefix and comment are optional.
Available objects
|
slot |
| uomCode | Unit of Measurement |
| target | 1 - Project Repository 2 - Database |
|
slot |
| name | Name of new Selection Set |
| parentID | Parent of new Selection Set. If empty the set is created on top level. |
|
slot |
Create selections sets of geometry objects.
For each value of a given property type a selection set is created.
| propertyTypes | A concatenation of Property Type Keys, each containing a name and datatype. Example: 'cpName##xs:string; cpVolume##xs:double' This is still possible, but deprecated. |
| rootName | Name of the Selection Set Container to be created. If the name is already used, a suffix will be added. |
| config | Object containing Options. Default Values: { maxItems: 0, considerCompositeParts: true, considerOpenings: true, considerParts: true, intervalSize: 0.5 } |
Usage examples:
|
slot |
Create a wire mode schema for objects.
| ids | String of semicolon-separated object IDs |
| wmName | Name of new wire-frame mode |
| overwrite | If 'true' an existing schema will be overwritten with current settings (default: 'false') |
|
slot |
|
slot |
Checks if csv file has more data.
|
slot |
Reads next line of csv.
|
slot |
Open text file in CSV format for reading.
| filename | Name of file |
| delimiter | one character as delimiter of cells, mostly ";" or " " (a tab sign) |
| quoteSign | one character, Some CSV files use quotes to specify text. Delimiters and line breaks within quotes are ignored. |
|
slot |
Cut object into subparts. ...
| parentId | : ID of parent container. If empty, subparts will be added to object. |
| objId | : ID of object |
| options | : Options encoded as JSON. If not specified, the default values of the code snipped (see below) will be chosen. |
Example: Cut object ID="ABCxyz123" by xy-plane (through origin) and append parts to object (parent=""):
|
slot |
Check if database has a specific table with certain columns.
| tableName | Table name |
| columnsList | List of columns specified in the format [columnname columndatatype] |
Example:
|
slot |
Database check-in.
|
slot |
Check out properties in local database. Only properties which are checked out can be edited. All other properties are locked in local database.
| propList | List of properties in such format: propName##propType |
|
slot |
|
slot |
|
slot |
Close the currently connected DB. Returns false if no DB was connected.
|
slot |
Delete properties from database.
| objIdList | The properties are removed and deleted from these objects. |
|
slot |
Free all resources bound to the last dbQueryExec.
|
slot |
If the connected DB is file-based, returns the filename and path. Otherwise, an empty string is returned.
|
slot |
|
slot |
Check if current database is a local copy.
|
slot |
Open and connect a project database. Will do nothing if a database connection is already open.
Pass connection data as object.
Example:
You can pass an empty object or no connection data at all. In that case, a DB will be opened with default parameters (in the current project's directory). Project must have been saved first.
|
slot |
Create a database query by a SQL statement. To iterate over the query result use dbQueryNext() and get the values of the current record by dbQueryValue().
| sqlQuery | Database query as SQL statement |
|
slot |
Get the error message that the last executed SQL query returned (if any).
|
slot |
Go to next record of last query.
|
slot |
Create a database query by SQL statement.
| sqlQuery | the SQL query string. |
| key | the field name used as key in record set returned. For more than one key value only the last one will be returned. |
| maxNumberOfRows | max number of rows in result set returned, left open or 0 for unlimited. |
Example call: desiteAPI.dbQueryRecordset("SELECT matchKey, price FROM tblPrices", "matchKey", 0);
Example:
|
slot |
|
slot |
|
slot |
Remove and delete color scheme by name (pattern).
| namePattern | Name of the color scheme that should be deleted. Could be a pattern such as 'csXYZ*', which means that all CS which name starts with 'csXYZ' are removed and deleted. |
|
slot |
Delete material with given ID.
| matId | ID of material to be deleted |
|
slot |
Delete Model.
Contained elements are removed from all locations where they are used (links, viewpoints, ...) and will be deleted afterwards.
| id | ID of model |
|
slot |
Delete and remove one or more objects or containers. Model root nodes will not be deleted!
Contained elements are also removed and deleted. Also these elements are removed from all other locations where they are used (links, viewpoints, ...)
| idList | List of object/container IDs separated by ';' |
|
slot |
Delete property 'propName' from the element identified by 'objId'.
| objId | ID of element. Use 'GlobalProject' to remove and delete a global project property. |
|
slot |
Remove property type from domain. All affected properties will be deleted.
Note that for DB property types, this will only work if the type is defined for a single domain only. (To delete DB property types across all domains, use the database widget.)
| propName | Name of property type |
| propDatatype | Data type of property type |
| domainName | Name of domain (default: "all", combinations are allowed) |
|
slot |
Finish transaction on project of given domain.
|
slot |
Finish database transaction.
|
slot |
Get container with name 'name' and parent node 'parentId'. If the container does not exist, an empty string is returned.
Note that a name is not necessarily unique; this method will only return the first match.
| parentId | Parent node ID |
| name | Name of the container |
| lookupDomain | Lookup container 'name' in this domain, default = 'all' |
|
slot |
Get documents where the creation date is between a given range or where the reference date is between a given range.
| start | Start of date range |
| end | End of date range |
| idList | (optional) List of IDs of documents. If empty, all documents will be considered. |
| useRef | (optional) Flag determining if documents are searched by their create or reference date |
|
slot |
Get documents which are located around a given point in Gauss-Krueger coordinates by a given distance.
| rw | 'Rechtswert' (x-coordinate) of search point |
| hw | 'Hochwert' (y-coordinate) of search point |
| distance | Search range |
| idList | (optional) List of IDs of documents. If empty, all documents will be considered. |
|
slot |
Get documents which are located around a given point in GPS coordinates by a given distance.
| lat | Latitude of search point |
| lon | Longitude of search point |
| distance | Search range |
| idList | (optional) List of IDs of documents. If empty, all documents will be considered. |
|
slot |
Get documents which are located around a given point list in GPS coordinates by a given distance.
| gpsCoordinates | List of GPS coordinates ('lat::lon') |
| distance | Search range |
| idList | (optional) List of IDs of documents |
|
slot |
Get object data.
Example:
A 3D-objects contains vertices and triangles.
Example Result:
|
slot |
Get all available values of property 'propName/propDatatype'.
| maxValues | 0 - get all values > 0 - do not get more than 'maxValues' items |
Example:
|
slot |
Get maximal x-coordinate of overall bounding box of all geometric objects (visible and hidden) in the project.
|
slot |
Get maximal y-coordinate of overall bounding box of all geometric objects (visible and hidden) in the project.
|
slot |
Get maximal z-coordinate of overall bounding box of all geometric objects (visible and hidden) in the project.
|
slot |
Get minimal x-coordinate of overall bounding box of all geometric objects (visible and hidden) in the project.
|
slot |
Get minimal y-coordinate of overall bounding box of all geometric objects (visible and hidden) in the project.
|
slot |
Get minimal z-coordinate of overall bounding box of all geometric objects (visible and hidden) in the project.
|
slot |
Get common bounding box of all objects in objIdList. If an object ID represents a composite (geometric container), all parts of it will be taken into account.
| objIdList | IDs of objects to be affected (separated by ';') |
|
slot |
Get all color schemes.
|
slot |
Get container with name 'name' and parent node 'parentId'. If the container does not exist, it is created.
| parentId | : Parent node ID |
| name | : Name of the container |
|
slot |
Get current (applied) color scheme.
|
slot |
Return a list of all files and (optionally) subdirectories in the given directory.
The list will NOT include system and hidden files.
A Windows environment variable can be used, but only once in the string (e.g. 'userprofile%/pictures')
Objects in the returned list will contain the following keys:
Name
AbsoluteFilePath
AbsolutePath
SizeInBytes
CreationDateTime
LastModifiedDateTime
IsReadable
IsWritable
IsDirectory
| dirPath | Full path to the directory to scan |
| filesOnly | (default false) if this is set to true, subdirectories will not be included in the list |
| orderBy | Sort the result list either by "Name" (alphabetically, default), "Size" (largest first), or "Time" (most recently modified first) |
|
slot |
Get list of tooltip templates.
|
slot |
Get list of temporary values.
|
slot |
Get all locked objects.
|
slot |
Get material as object.
| matId | ID of Material |
Example return:
|
slot |
Get material encoded by XML.
| matId | ID of Material |
|
slot |
Get ID of material with given name.
| matName | Name of material |
|
slot |
Get list of all available materials.
|
slot |
Lookup the parent model of the element with the given ID. If the model could not be found, this method returns an empty string.
| id | Element ID to find the model of |
| domainFilter | [optional] Domain(s) to look in; by default "all". The lookup may be faster if you narrow the search to specific domains. |
|
slot |
Return ID of Model 'name'. If the model does not exist, it is created.
|
slot |
Return a ID-list of all models in a given domain.
| domainFilter | Given domain(s) (default = 'all'). Different domain names have to be separated by ';'. |
|
slot |
Get a list of IDs of all models with name 'name'.
name : Name of the model domain : Domain name combination. Default is 'geometry'
|
slot |
Get meta data of a given model as JSON object.
Keys of JSON object:
|
slot |
Calculate the common OOBB of all objects in objIdList. The OOBB is not explicitly set to affected objects and cannot be re-used (see properties cpOOBB... and so on). If an object ID represents a composite or geometric container, all parts of it will be taken into account.
| objIdList | IDs of objects to be affected (separated by ';') |
|
slot |
Calculate the common OOBBxy of all objects in objIdList. The OOBBxy is not explicitly set to affected objects and cannot be re-used (see properties cpOOBBxy... and so on). If an object ID represents a composite or geometric container, all parts of it will be taken into account.
| objIdList | IDs of objects to be affected (separated by ';') |
|
slot |
Get projection of given geometric objects as SVG.
| idList | Given geometric objects, list of IDs separated by ';' |
| options | Options as JSON object If an empty JSON object is passed to this method, the size and viewBox is adjusted to the drawn objects. |
Example Options:
resolution - resolution in DPI, default is 72
|
slot |
Get list of properties.
This is the same format as the export/import of properties used by the GUI.
| opt | Options to configure the export. |
Example:
|
slot |
Get code (background) of property script.
|
slot |
Get code (value) of property script.
|
slot |
Get code (foreground) of property script.
|
slot |
Get list of property scripts as JSON object.
Example:
|
slot |
|
slot |
Get a property type bookmark as an object.
The 'Type' of the bookmark is 1 for User-defined and 2 for Global.
| bookmarkId | ID of the bookmark to look up. If the ID isn't found, an empty object is returned. |
|
slot |
Return list of property types bookmarks.
Example:
|
slot |
Get all available property values for a given property type and domain.
| propName | Name of property type |
| propDatatype | Data type of property type |
| maxValue | Max. number of values which should be returned. If 'maxValue' = 0 all available values will be returned. |
| domainName | Name of domain (default: "all", combinations are allowed) |
|
slot |
Get all available different property values for a given property type, list of objects and domain.
| propName | Name of property type |
| propDatatype | Data type of property type |
| checkInh | true = Consider inherited properties, false = Check direct properties only |
| maxValue | Max. number of values which should be returned. If 'maxValue'<= 0 all available values will be returned. |
| obIdList | Ids of objects to check property values. |
| domainName | Name of domain (default: "all", combinations are allowed) |
| getNullValues | Set true if result list shall contain NULL values for objects not having this property. |
|
slot |
Return ID of Root Container 'rootContainerName' which is elements of model 'modelName'.
If the model or the container does not exist it is created. If the model is readonly, an empty string is returned.
|
slot |
Get a list of IDs of all root containers of all models with name 'modelName'. Works only in domain geometry, because not the model roots but the 'red' root containers (where transformations can be applied) are returned.
| modelName | : Name of the model(s) |
|
slot |
Get ID of root node of a given model.
Each model has a container as root node in which the whole object hierarchy of a model is stored. This root node is visible in the tree view. The model itself is not visible in the GUI but can be accessed by methods in the API.
|
slot |
Get list of IDs of root nodes of a given domain filter.
Each model has a container as a root node in which the whole object hierarchy of a model is stored.
| domainFilter | Given domain(s) (default = 'all'). Different domain names have to be separated by ';'. |
|
slot |
Get root nodes of selection sets. These root nodes are the top level selection sets in a domain project.
|
slot |
Retrieve a temporarily stored property.
|
slot |
Get list of visualization configurations as JSON object.
Example
|
slot |
Get all objects which are set to wireframe mode.
|
slot |
Check if two objects have contact.
| objId1 | : ID of object 1 |
| objId2 | : ID of object 2 |
| options | : Options encoded as JSON. If not specified, the default values of the code snipped (see below) will be chosen. |
|
slot |
Check if an object or container with the given ID exists.
| id | : Element ID |
|
slot |
Checks if the object with the given ID is a container.
| id | : Object ID |
|
slot |
Check if object with ID 'objId1' is included in object with ID 'objId2'.
|
slot |
Check if point with given coordinates is included in object with ID 'objId'.
| x | : x coordinate of point |
| y | : y coordinate of point |
| z | : z coordinate of point |
| objId | : ID of object (surface or composite) |
| tol | : numerical tolerance |
|
slot |
Get objects which match the filter. If the filter should be applied on all objects, make sure the object iterator is cleared first. Otherwise the filter is applied on an existing object iterator. The filter string is not case sensitive (except for data type xs:ID and xs::IDREF).
| propName | Property name |
| propDatatype | Property data type [xs:string, xs:double, xs:long, ... ] |
| checkInh | Check inherited properties |
| domain | [ all, geometry, activities, ... ] |
|
slot |
Object Iterator is set to objects in idList.
| idList | List of Object IDs as String separated by ';'. |
|
slot |
Calculate OptOBB of all contained 3D-objects. The bounding box is only calculated if an object has no OOBB.
|
slot |
Calculate OptOBBxy of all contained 3D-objects. The bounding box is only calculated if an object has no OOBBxy.
|
slot |
Clear and delete an existing object iterator.
|
slot |
Color code objects in current object iterator. If the current object iterator does not exist all objects are color coded by property 'propName'. An existing object iterator is deleted by calling itClear().
| propName | : property name |
| propDT | : property data type |
|
slot |
Color code objects in current object iterator. If the current object iterator is empty or does not exists all objects are color coded by property 'propName'. (An existing object iterator can be deleted by calling itClear() ).
| propName | : property name |
| propDT | : property data type |
| intervalSize | : Size of interval |
|
slot |
Count the elements in current object iterator.
|
slot |
Filter objects in iterator list by their status.
| status | Status as string ['visible', 'selected', 'wired' or 'locked'] |
| enabled | Value of status [true, false] |
| domain | Domain as string to check ['geometry', 'activities', 'documents, 'building', 'boq', 'qto', 'pc', 'cd', 'qa', 'type', 'res', 'all]', combinations are allowed (separated by ';') |
|
slot |
Get property values of objects in current object iterator.
|
slot |
Get list of IDs of current object iterator.
|
slot |
Check if iterator is not at end.
|
slot |
Get ID of next element in object iterator.
|
slot |
Set material to current objects of iterator.
|
slot |
Setup cache for objects in iterator and property 'propname'.
|
slot |
Set object iterator before first element. Call itNext(9 to get the first element.
|
slot |
Calculate OptOBB of all contained 3D-objects. The bounding box is always calculated.
|
slot |
Calculate OptOBB of all contained 3D-objects. The bounding box is always calculated.
|
slot |
Locks given objects.
| idList | List of IDs of objects to lock (separated by ';') |
|
slot |
Merge objects into a new one. The material of the resulting object is the material of the object with the largest surface area, or, if flag 'keepTransparency' is set, the transparent material.
Source Objects must be deleted manually if merging was successful.
| parentContainerId | : ID of container to which merged object should be added. |
| idList | : String of IDs of objects to be merged, separated by ';' |
| skipClosed | : Exclude closed surfaces from merging. |
| keepTransparency | : Keep transparent material if any. |
|
slot |
Move file 'fnFrom' to file 'fnTo'.
|
slot |
Open a text stream to a new file for writing. By default, local 8 bit encoding is used.
To change it, set encoding as optional second parameter.
| filePath | Name and path of the file to be opened. If no path is given, the current project's path will be used. |
| encoding | File encoding, such as "ISO 8859-1", "UTF-8", or "UTF-16" (optional) |
|
slot |
Clear cache of all property scripts.
|
slot |
|
slot |
Read text file in CSV format and return a JSON-object of cells.
| filename | Name of file |
| delimiter | one character as delimiter of cells, mostly ";" or " " (a tab sign) |
| quoteSign | one character, some CSV files use quotes to specify text. Delimiters and line-breaks within quotes are ignored. |
Example:
... returns something like:
|
slot |
Read image file and return a Base64-encoded string.
The source image format will be determined automatically.
| filename | Name of image file |
| targetFormat | optionally specify "png", "jpg", "bmp" or "gif" for target format if you want a conversion. If you want to keep the original source format (determined automatically), this parameter can be omitted (or set to ""). |
|
slot |
Read text file and return each line as string.
| filename | Name of file |
| ignoreLineBreakesInDoubleQuotes | |
| code | Codec for reading the textfile, one of [ "ISO 8859-1", "UTF-8", "UTF-16" ] |
|
slot |
Read text file and return complete content.
| filename | Name of file |
|
slot |
Remove all linked objects from the element with the given ID.
| id | ID of element |
|
slot |
Remove all ranges from region.
| regionId | ID of region (will be returned if region is successfully added to an alignment) |
| alignmentId | ID of alignment. Optional parameter, if given, method is faster, because not all objects have to be searched |
|
slot |
Remove all regions from an alignment with given ID.
|
slot |
Remove a file
| filePath | Name and path of file to be removed. If no path is given, the current project's path will be used. |
|
slot |
Remove objects from selection set in domain 'geometry'.
| objectIDList | List of objects which should be remove from selection set. IDs are separated by ';' |
|
slot |
Remove links to a given list of objects from another object.
|
slot |
Removes the object list from tooltip.
| idList | List of objects |
| tooltipname | Name of the tooltip template |
|
slot |
|
slot |
|
slot |
Remove a range from a region. Example: Remove [110.0,300.0] from [0.0,350.0] => [0.0,110.0] + [300.0,350.0]
| regionId | ID of region (will be returned if region is successfully added to an alignment) |
| fromStation | Lower bound of range |
| toStation | Upper bound of range |
| alignmentId | ID of alignment. Optional parameter, if given, method is faster, because not all objects have to be searched |
|
slot |
Remove selection set with given ID.
|
slot |
Remove visualisation configuration from tasks.
|
slot |
Renew painting order of geometric elements. Transparent objects have to be drawn at last to appear properly in 3d view. This method should be called after changes in transparency of visible materials.
|
slot |
Forces the MetaDataThreadWorker to reread the meta data of document from URL. since 1.9.0, 18 jun 2016, jh
|
slot |
Reset all object materials to materials originally imported with the geometry model file.
| updateUI | If set to true (default), an active color scheme will be unapplied and the 3D view will be repainted |
|
slot |
Set all property types active.
|
slot |
Change container with given ID to composite and vice versa.
| id | ID of container/composite |
| composite | true: set as composite, false: set as container |
|
slot |
Set list of objects as opening elements to a given object. Objects in lists which have openings will be skipped.
| objId | ID of object for which to set openings |
| openingIDList | Objects to set as openings |
|
slot |
Set Cloud Data such as URL, User and Password. Password is not saved when the project is saved.
|
slot |
Create a link (relation) between objects.
| elementID | ID of element to the linked.object links. The element can be of any domain (like geometry, activity etc). |
| IDList | List of objects to be linked to. List must be a semicolon-separated string. Currently, only geometric elements are supported as link targets. |
|
slot |
Set material to given objects (elements of domain 'geometry').
| matId | ID of material |
| objectIds | String of semicolon-separated object IDs to which the material is to be assigned. If an ID is an ID of a container, the material is assigned to all contained objects. |
|
slot |
Set name of all given elements.
| eleIDList | List of elements to be renamed |
| name | Name to be set to elements |
|
slot |
Set objects to wire-frame mode based on condition.
| ids | String of semicolon-separated object IDs |
| wired | true = set objects to wire mode false = set objects to normal mode |
|
slot |
Set list of property values to objects.
| propmap | List of properties as JSON object. |
Example: Property List
| opt | Options for setting property values. Target: <br>
1: Database <br>
2: Repo <br>
3: Default <br>
HandleExisting:
0: overwrite <br>
1: ignore <br>
2: backupWithDate
|
Example: Options
|
slot |
Set code (background) of property script.
|
slot |
Set code (value) of property script.
|
slot |
Set code (foreground) of property script.
|
slot |
|
slot |
| domain | Domain(s) for which to set the active status, e.g. "geometry", "geometry;activities", "all" |
|
slot |
Set meta data of property type such as display name and unit.
| pName | Name of property type |
| pType | Data type of property type |
Example:
|
slot |
A Property value is set in the Project Repository, DB or model (the lookup sequence for this is the same as when setting a Property via the GUI).
If the Property Type does not exist, it is created in the Project Repository.
To set a global property use objId = GlobalProject.
| objId | ID of element to set the property value to |
| propName | Name of the Property |
| propDataType | Data Type of the Property in XML notation (for example 'xs:string' or 'xs:long') |
| value | Property Value |
|
slot |
A property is set in the database.
Only datatypes supported by the database are provided. In SQLite DBs, datatypes xs:int and xs:float are mapped to xs:long and xs:double accordingly.
| objIdList | : List of objects (objIDs separated by ';') which should be affected. |
| propDomain | : Domains that the object IDs will be looked up in and the property will be created for. Example: "geometry;activities". If empty, "geometry" is used. |
| createType | : If true (default), a property type will be created if not yet existing; if false, the operation will fail if the property type does not already exist |
Changed in 1.3.0, 30 jan 2014:
Extended signature by parameter 'propDomain'.
|
slot |
Explicitly force the property to be written in project repository (memory).
| objId | ID of element to set the property value to |
| propName | Name of the Property |
| propDataType | Data Type of the Property in XML notation (for example 'xs:string' or 'xs:long') |
| value | Property Value |
| createType | If true (default), a property type will be created if not yet existing; if false, the operation will fail if the property type does not already exist |
|
slot |
Set Task Mode:
taskmodeManuallyScheduled = 1, taskmodeAutomaticallyScheduled = 2
To get task mode see class CoreAPI.
|
slot |
Stores the value for property name as long as the project is not closed or reloaded. Webform reload has no effect on it. No persistence. Information is lost when project is reloaded or DESITE ist closed, even when the project is saved before.
|
slot |
Objects get a transparent version of their original material. A new material is created if not already assigned to an object. '-T' is appended to the original name.
| objectIds | String of semicolon-separated IDs of objects to change material of. |
| defaultTransparency | Transparency value used (default: 0.95). Existing transparency remains unchanged. |
|
slot |
Set visualisation configuration to task.
|
slot |
Apply wire mode schema with given name.
| name | Name of wire mode schema which should be applied. 'Reset' resets wire mode (draw all objects solid). |
|
slot |
Start transaction on project of given domain. Use this if you want to create many objects at once.
|
slot |
Start database transaction.
|
slot |
Synchronizes a document container with the assigned local directory or webservice. An URL must be set for the container which should be synchronized!
| containerId | : container node ID |
| callback | When synching via webservice, the process will be asynchronous. You can optionally set this callback to be triggered when the sync finishes. The callback function should have one boolean parameter, indicating success (true) or failure (false). |
| blockExecution | Will only have an effect with a webservice sync. With this flag set to true, script execution will not continue until the synchronisation has finished. This may incur a performance penalty and is generally not recommended. If possible, use a callback function to define post-sync steps instead. |
Example 1: Non-blocking with callback
Example 2: Blocking, no callback
|
slot |
Rotate, scale, translate object.
| objId | ID of object which should be transformed |
| transformation | scale, translate, rotate encoded as XML |
Transformation:
|
slot |
Unlocks all objects.
|
slot |
Unlocks given objects.
| idList | List of IDs of objects to lock (separated by ';') |
|
slot |
Update overall bounding box of all objects in 3D view.
|
slot |
Update material properties such as diffuse, transparency, ...
| matId | ID of material |
| matXml | New material properties as XML |
|
slot |
Update optimized, orientated bounding box (OOBB) of all given geometric objects. It will always be re-calculated.
| objIdList | IDs of objects to be affected (separated by ';') |
| eps | Threshold for optimization (default: 0.001) |
|
slot |
Update optimized, orientated bounding box in xy-plane (OOBBxy) of all given geometric objects. It will always be re-calculated.
| objIdList | IDs of objects to be affected (separated by ';') |
| eps | Threshold for optimization (default: 0.001) |
|
slot |
Write a string as whole to file. User must not take care of opening and closing the file.
| filePath | Name and path of the file to be written. If no path is given, the current project's path will be used. |
| content | String to be written to the file |
| encoding | File encoding, such as "ISO 8859-1", "UTF-8", or "UTF-16" |
|
slot |
Write property value to database.
Other than setPropertyValueDB(), this method does not check if the objects given by objIdList exist in the project.
|
slot |
Write text to an open file.
| content | Text to be written |
| Created: Fri Feb 5 2021 09:33:06 |
