XML-API Documentation

KISTERS AG

Version 2021.1.672


GeneralStructureMethodsEventMethodsActivateConfigurationViewActivateGraphicalCompareActivateInteractionActivateOnSaveConfigurationViewActivateNextConfigurationViewActivatePrevConfigurationViewActivateSavedSelectionsActivateSelectedCoordinateSystemAddEventListenerAlignCalloutsAlignViewAssignCalloutIdToBillOfMaterialRowClearBillOfMaterialCalloutIdClearBillOfMaterialCalloutIdsClearTextSearchClearValidationDataClearViewCloseCloseAllComputeComputeBrepCompareCreateCalloutGroupCreateConfigurationViewDeleteConfigurationViewDeleteConfigurationViewsDeleteNodeAttributesDeleteOffsetLinesDeleteSavedSelectionsDeleteVisibleCalloutsDisableAutoCalloutAlignmentEnableAutoCalloutAlignmentExecuteNeighbourhoodSearchExplodeByDistanceExplodeHierarchicallyExport2DExport3DExportConfigurationViewsExportMarkupsAsXMLExportSectionGeometryExportViewsOverviewAsPDFExportViewsAsPDFExportViewsAsPNGFitAllFitHeightFitWidthFocusGenerateBOMCalloutsGenerateBOMCalloutIdsGenerateAttributeGenerateCustomIdsGenerateFacesGenerateNormalsGenerateStatisticsGenerateWiresGetAnimationAxisGetAnimationSpeedGetBCFVisualizationInfoGetBillOfMaterialGetBillOfMaterialAttributeNamesGetBillOfMaterialNodePropertyNamesGetCalloutAnchor2DProjectionGetCalloutsGetCameraGetClashDetectionGetConfigurationViewInformationGetCurrentViewGetImageGetLastPickDurationInSecondsGetMaxTreeDepthGetModelRepositoryGetNodePropertiesGetNodeTransformMatrixGetPageCountGetPropertiesOfSelectedNodesGetSavedSelectionsGetSceneSettingsGetSceneStateGetSearchableNodeTypesGetSelectedBillOfMaterialRowsGetSelectedFacesColorGetSelectedNodesGetSettingsGetStructureMinimal StructureGetViewsOverviewAsPDFGetViewsAsPDFGetUndoStackGotoPageHideAllMarkupsHideAllPMIsHideVisibleCalloutsImportConfigurationViewsImportFileImportMarkupsImportVSXMLToNodeInvertVisibilityIsAutoCalloutAlignmentActiveLockCalloutsLogMessageMeasureSelectedWireLengthMeasureDistanceSolidsToSolidsMirrorSelectedNodesModifySelectionMoveConfigurationViewNewScene3DNextPageOpenFilePauseRenderingPreviousPageRemoveEmptyNodesRemoveEventListenerRemoveFacesRemoveNormalsRemoveWiresRenameSavedSelectionRenameBillOfMaterialRowCalloutIdReplaceNodeResetCoordinateSystemResetSceneLightResetNodesLuminanceResetWallthicknessVisualizationResetZoomResumeRenderingRotatePageSave2DAsPdfSaveAsSaveCurrentSelectionSearchNodesSearchNodesByStringSectionAlignAxisSectionCenterHandlesSelectAllGeometriesSelectBillOfMaterialRowsSelectClashIndexSelectSurfacesSelectVisibleCalloutsSetAnimationAxisSetAnimationSpeedSetBCFVisualizationInfoSetCalloutAlignmentSetCameraSetCurrentViewSetSceneLightSetSceneSettingsSetSelectedFacesSetSelectedFacesColorSetSelectedNodesSetSelectedNodesLuminanceSetSelectionModeSetSettingsSetModelRepositorySetNodePropertiesSetNodeTransformMatrixShowAllShowAllCalloutsStartPlayConfigurationViewsStopPlayConfigurationViewsUndoUnGhostAllUnlockCalloutsUpdateBillOfMaterialRowCalloutIdUpdateConfigurationViewUpdateSavedSelectionUpdateSceneValidateGeometryVirtualTreeViewCollapseAllVirtualTreeViewCollapseSelectedVirtualTreeViewExpandAllVirtualTreeViewExpandSelectedVirtualTreeViewExpandToSelectedLevelVirtualTreeViewSelectSameLevelNodesVirtualTreeViewScrollDownVirtualTreeViewScrollUpVirtualTreeViewSetSizeVirtualTreeViewToggleExpansionVirtualTreeViewToggleVisibilityZoomInZoomOutDeprecatedNew3DViewSetMouseButtonFunctionsSetRenderModeShowGridEventsActivateInteractionCalloutAutoAlignmentChangedCalloutListChangedCalloutSelectionChangedCalloutProjectionDeactivateInteractionImportFinishedNodeCreatedNodeDeletedPageChangedPresetChangedSavedSelectionsChangedSelectionChangedSelectionChangedCustomIdTransformChangedImportLogMessageWallthicknessValuesChangedChangelogVersion 2022.0.130Version 2021.1.621Version 2021.1.459Version 2021.1.446Version 2021.0.148Version 2020.2.173Version 2020.1.318Version 2020.1.212Version 2020.0.209Version 2019.0.510Version 2019.0.341Version 2019.0.314Version 2019.0.298Version 2019.0.268Version 2019.0.119Version 2018.0.225Version 1.17Version 1.16Version 1.15Version 1.14Version 1.13Version 1.12Version 1.11Version 1.0AppendixTypesAlignViewOptionARGBAttributeGenerationModeboolColorCustomIdGenerationModeComputationModeCoordinateDirectionDistanceSolidsComputationTypeExplosionTypeExportFormat3DExportFormat2Dfloatfloat3InteractionLogLevelMarkupAlignmentTransformMatrixMouseButtonMouseButtonFunctionNodeIdNodePropertiesNodeTypePlaneOptionPresetTypeRenderModeRGBSavedSelectionSearchSelectionModeSearchStringSectionGeometryTypeSelectionModeSelectionModifierSettingsXMLstringUINTVSXML

General

All methods, events or types marked as BETA are subject to change until their final release.

Structure

Methods

Every method execution consists of a "Call" and a "Response" as XML. All Available methods are listed under General.

Each "Call" is structured as in the following example.

The "Method" attribute contains the name of the method which should be executed.

The "Response" attribute is optional and specifies if a response should be generated. Valid values are"true" and "false". Default value is "true".

The "CustomId" attribute is optional. If present, the "Response" will also carry this "CustomId".

Each "Response" is structured as in the following example.

The "Method" attribute contains the name of the executed method.

The "Error" attribute indicates if the method execution was successful or if an error occurred.

The "CustomId" attribut is only present if the "Call" has a "CustomId".


Event

The "Type" attribute contains the name of the executed event.


Methods

ActivateConfigurationView

Activates the ConfigurationView at the specified position.

Call:

ParameterTypeDescription
PositionUINTPosition of the ConfigurationView

Example:


ActivateGraphicalCompare

Activates graphical compare.

The selection must contain 2 nodes or, if the selection is empty, the model must contain 2 root nodes.

Call:

ParameterTypeDescription
ActivateboolIf set to "true", graphical compare will be activated.

Example:


ActivateInteraction

Activates the specified interaction mode.

ParameterTypeDescription
InteractionInteractionSpecifies the interaction which should be activated.

Example:



ActivateOnSaveConfigurationView

Activates the special "OnSave" configuration view that contains the scene state when it was last saved.

Example:


ActivateNextConfigurationView

Activates the next ConfigurationView. If the last ConfigurationView is active, nothing will happen.

Example:


ActivatePrevConfigurationView

Activates the previous ConfigurationView. If the first ConfigurationView is active, nothing will happen.

Example:


ActivateSavedSelections

Activates one or more saved selections.

Call:

ParameterTypeDescription
Index
[multiple]
UINTIndices of saved selections to select.

Example:


ActivateSelectedCoordinateSystem

Activates the selected "CoordinateSystem".

Example:


AddEventListener

Adds an event listener.

ParameterTypeDescription
Event
[multiple]
EventSpecifies the event which should be added.

Example:


AlignCallouts

Aligns either all selected callouts or all available callouts, if no selection was made beforehand.

Example:

AlignView

Aligns the view.

ParameterTypeDescription
AligmentAlignViewOptionView aligment

Example:


AssignCalloutIdToBillOfMaterialRow

Assigns the given callout id to the row's nodes.

Call:

ParameterTypeDescription
RowIdUINTRow id
CalloutIdstringCallout id

Example:


ClearBillOfMaterialCalloutId

Clears the assigned callout of every node contained in the specified row.

Call:

ParameterTypeDescription
RowIdUINTRow id

Example:


ClearBillOfMaterialCalloutIds

Clears the assigned callout of every node contained in the bill of material.

Example:


ClearTextSearch

Clears/Resets text search and selected highlights of the current scene.

Example:


ClearValidationData

Clears the validation data

Example:

 

ClearView

Clears the view.

Example:


Close

Closes the active scene.

Example:


CloseAll

Closes all open scenes.

Example:


Compute

Triggers a computation.

Call:

Remarks: If not stated otherwise under Special Responses, every call to Compute returns a simple response without any parameters.

ParameterTypeDescription
ModeComputationModeComputation mode

Example:

Note: Some modes might return multiple error codes. Those will appear as a list of <ErrorCode> elements in the response body.

Additional Call Parameters:

ParameterTypeDescription
TypeSectionGeometryTypeGeometry type to create
Step
optional
floatEnables creation of multiple geometries spaced by the given stepping value (in scene units)
Step < 0 -> Creates section geometries above the cutting plane
Step > 0 -> Creates section geometries underneath the cutting plan

Special Responses:


ComputeBrepCompare

Executes "BrepCompare". The selection must contain 2 nodes or, if the selection is empty, the model must contain 2 root nodes.

Example:


CreateCalloutGroup

Creates a new callout group from the current selection.

Response:

ParameterTypeDescription
NodeIdNodeIdId of the created callout node if request was successful.

Example:


CreateConfigurationView

Creates a new ConfigurationView. The view is positioned at the end of the list of views.

Call:

ParameterTypeDescription
NamestringOptional: Custom name.

Example:


DeleteConfigurationView

Deletes the ConfigurationView at the specified position.

ParameterTypeDescription
InteractionUINTPosition of the ConfigurationView.

Example:


DeleteConfigurationViews

Deletes all configuration views.

Example:


DeleteNodeAttributes

Deletes a list of node attributes.

Call:

ParameterTypeDescription
NodeId
[multiple]
NodeIdNodeIds to delete attributes from.
If none are provided, the current selection will be used.
Attribute
[multiple]
StringAttributes to delete.

Example:


DeleteOffsetLines

Deletes offset lines from nodes. Deletion happens either on a list of node ids, the current selection or all nodes, if none of the other options apply.

Call:

ParameterTypeDescription
NodeId
[multiple]
NodeIdNodeIds to delete offset lines from.
If none are provided, the current selection will be used.

Example:


DeleteSavedSelections

Deletes one or many saved selections.

Call:

ParameterTypeDescription
Index
[multiple]
UINTIndices of the selections to delete

Example:


DeleteVisibleCallouts

Deletes all visible callouts.

Example:


DisableAutoCalloutAlignment

Disables automatic callout alignment.

Example:


EnableAutoCalloutAlignment

Enables automatic callout alignment.

Example:


ExecuteNeighbourhoodSearch

If the "SelectionMode" is set to "Neighbourhood" (see also "SetSelectionMode"), this method will execute the search.

ParameterTypeDescription
Radius
[optional]
floatDefines the radius of the sphere in which neighbours will be searched. If this value is not set, the radius will be set to the bounding box extents of the current selection.

Example:


ExplodeByDistance

Explodes the model.

ParameterTypeDescription
PositionUINTValue between 0 and 100.
ExplosionTypeExplosionType 

ExplodeHierarchically

Explodes the model hierarchically.

Hint: You can get the maximum explode level for this operation by calling GetMaxTreeDepth

Call:

ParameterTypeDescription
LevelUINTExplosion level

Example:


Export2D

Exports the scene to a 2D format. Remarks: Any already existing file will be overwritten!

ParameterTypeDescription
ExportFormat2DExportFormat2DFormat to which should be exported.
FileNameFileNameName of the new file (full path).

Example:


Export3D

Exports the scene to a 3D format. Remarks: Any already existing on same location file will be overwritten!

ParameterTypeDescription
ExportFormat3DExportFormat3DFormat to which should be exported.
FileNameFileNameName of the new file (full path).

Example:


ExportConfigurationViews

Exports all or a range of configuration views. To store it separated from the model file.

If the FileName parameter is present, the serialized configuration views get written to the specified file. Otherwise, the serialized configuration is returned in the call's response.

ParameterTypeDescription
FileNamestringOutput file name (optional)
PositionsArray of Position ElementsArray of positions elements to export (optional - otherwise exports all views)

Examples:


ExportMarkupsAsXML

Creates a section geometry at the current position of the section plane and exports it to the desired format. The exported data gets returned as a Base64 encoded string.

Call:

ParameterTypeDescription
Visible
Default: true
boolOnly export visible Markups
References
´Default: true`
boolExport validatable ReferenceData
See ImportMarkups and ValidateGeometry

Example:


ExportSectionGeometry

Creates a section geometry at the current position of the section plane and exports it to the desired format. The exported data gets returned as a Base64 encoded string.

Call:

ParameterTypeDescription
ExportFormat2DExportFormat2DExport format (only SVG and DXF supported)
Type
optional
Default: Wire
SectionGeometryTypeType of section geometry (only 'Wire' type supported at the moment)
FileName
optional
stringOutput filepath

Response:

ParameterTypeDescription
ImagestringBase64 encoded result image (only if FileName parameter was not passed)

Example:


ExportViewsOverviewAsPDF

Creates a PDF file at a given location. The file contains an overview of all views represented by their names and a preview image.

Call:

ParameterTypeDescription
FileNamestringOutput path of the PDF file.

Example:


ExportViewsAsPDF

Creates a PDF file at a given location. The file contains an image of all views referenced by their Id in the call. Additionally, information about the geometry contained in the views are added to the bottom of each page. If no view Ids are passed, the PDF contains all views.

Call:

ParameterTypeDescription
FileNamestringOutput path of the PDF file.
Id
[multiple]
UINTId of the configuration view. Optional - PDF contains all views if no Ids are given.

Example:


ExportViewsAsPNG

Exports PNG images of either the given selection of configuration views or all existing if no selection is passed.

Call:

ParameterTypeDescription
DirectorystringOutput directory to save PNG images to.
Overwritebool
(Default: false)
Overwrites existing files if set to true.
Returns ERR_WOULD_OVERWRITE_FILES if set to false and files would be overwritten.
Id
[multiple]
UINTSelection of configuration views to export.
Exports all views if selection is empty.

Example:


FitAll

Fits the zoom so that the whole visible model can be seen. Zoom level depends on projected bounding box of visible objects.

Example:


FitHeight

Fit the zoom to height of the model or page.

Example:


FitWidth

Fit the zoom to the width of the model or page.

Example:


Focus

Focus on an area of interest in the scene using animated variable camera shift, rotation and zoom steps.

Call:

ParameterTypeDescription
NodeId
[multiple]
[optional]
NodeIdFocus on specified NodeIds.
If none are provided, the current selection will be used. There is no focus operation if the current selection is empty and no NodeIds are specified.
Factor
[optional]
float = 1.0Zoom in factor, default 1.0 corresponds to the adjustment to the bounding box of the selected nodes (larger values to zoom out).
Ghost
[optional]
bool = falseThe other nodes (not selected or specified for focus) are in ghost state (transparent and not selectable) after the focus transition. This option should help to focus on the inner parts of an object.
FadeTime
[optional]
 All times are given in milliseconds (ms)
Available steps for animated focus transition - zoom out, camera translation (shift), rotate camera, zoom in.
To skip a step set 0 ms.
ZoomOutUINTZoom out to view the complete model. Helps the user to orientate himself before the next step.
TranslationUINTMoves the new camera look at to a point in the middle of the objects to be focused.
RotationUINTTurn (rotate) the camera to the best angle to show the focused objects from outside.
ZoomInUINTZoom in to fit the focused objects (see Factor).

Example:


 

GenerateBOMCallouts

Generates callouts for each BOM entry with a callout id value.

Example:


GenerateBOMCalloutIds

Generates callout ids for every BOM entry without any callout id by using the provided start value incrementing it after each assignment. This call doesn't generate any callouts yet.

Call:

ParameterTypeDescription
StartIdUINTStart value

Response:

ParameterTypeDescription
StartIdUINTLast used callout id + 1

Example:


GenerateAttribute

Generates custom ids.

Call:

ParameterTypeDescription
NodeId
[multiple]
NodeIdNodeIds to generate custom ids for.
If none are provided, the current selection will be used.
Recursivebool = falseGenerate custom ids recursively.
IncludePartNodesbool = falseInclude Part nodes.
Overwritebool = trueOverwrite custom id of node if one is present
ModeAttributeGenerationMode = NodePathGeneration mode.
NameStringName of the attribute to create.

Example:


GenerateCustomIds

Generates custom ids.

Call:

ParameterTypeDescription
NodeId
[multiple]
NodeIdNodeIds to generate custom ids for.
If none are provided, the current selection will be used.
Recursivebool = falseGenerate custom ids recursively.
IncludePartNodesbool = falseInclude Part nodes.
Overwritebool = trueOverwrite custom id of node if one is present.
UniqueIdsbool = falseEnsure generated custom ids are unique.
ModeCustomIdGenerationMode = NodePathGeneration mode.

Example:


GenerateFaces

Generates or regenerates faces for all selected nodes or all nodes if none are selected.

Example:


GenerateNormals

Generates normals for all selected nodes or all nodes if none are selected. Nodes with normals are ignored.

Example:


GenerateStatistics

Generates statistics containing drawing information such as buffer memory used or number of nodes present. FPS can be calculated on demand.

Call:

ParameterTypeDescription
PerformFPSTestbool = truePerforms a test that calculates the FPS. This test takes 5 seconds to complete.

Example:


GenerateWires

Generates wires for all selected nodes or all nodes if none are selected. Nodes with wires are ignored.

Example:


GetAnimationAxis

Gets the common animation axis of all selected nodes.

Remarks:

If the selected nodes contain different animation axes, __VARIOUS__ gets returned.

Response:

ParameterTypeDescription
DirectionCoordinateDirectionAnimation axis
__VARIOUS__ if selected nodes contain different animation axes

Example:


GetAnimationSpeed

Gets the animation speed of all selected nodes with an animation.

Remarks:

If the selected animation nodes contain different speed values, __VARIOUS__ gets returned.

Response:

ParameterTypeDescription
SpeedfloatRotation speed
__VARIOUS__ if selected nodes contain different speed values

Example:


 

GetBCFVisualizationInfo

GET the view displayed in current scene as BCF 2.1 Visualization Information XML.

(Version 2.1) -Components -Selection -Visibility -Coloring

-OrthogonalCamera (the camera order depends on the mode that is active in the scene) -PerspectiveCamera -ClippingPlanes (only one plane supported)

Remarks:

For Selection, Visibility, Coloring IFC Data requires loading with attributes (IfcGuid), the same applies to the preparation of 3DVS files.

Response:

ParameterTypeDescription
VisualizationInfoXMLhttps://github.com/buildingSMART/BCF-XML

All X, Y, Z coordinates in meter

Example:


GetBillOfMaterial

Gets the current bill of material of the scene.

Example:

Response:


GetBillOfMaterialAttributeNames

Gets all different attribute names for all nodes in the current scene.

Example:

Response:


GetBillOfMaterialNodePropertyNames

Gets the node property names that can be used in the Bill Of Material.

Example:

Response:


GetCalloutAnchor2DProjection

Generate 2D Coordinates for markup endpoints Sorted from front to back

Call:

ParameterTypeDescription
InViewport
[optional]
Default: false
boolMust be visible on screen
Quantity
[optional]
Default: 0
UINTLimit number of results
0 = no Limit

Example:


GetCallouts

Gets information about callouts in the current scene. If the current selection is empty, all existing callouts will be returned. Otherwise all directly or indirectly referenced callouts will be determined and returned, e.g. if a non-callout node is selected that is referenced by a callout in the scene, this callout will be returned as well.

Example:

Response:


GetCamera

Gets information about the current camera position and look at.

Response:

ParameterTypeDescription
Positionfloat3Camera position
LooktAtfloat3Point on which the camera looks
UpVectorfloat3Up vector of the camera

Example:


GetClashDetection

Gets the clash detection details computed by Compute::ClashSync or Compute::ClashAsync.

Response:

ParameterTypeDescription
IdUINTIndex in list
NamestringName (and optional selection set) of first node
OtherNamestringName (and optional selection set) of second node
TypestringType of clash, either "Unknown", "Unspecified", "Contact" or "Collision"
MaxDepthfloatDepth of collision

Example:


GetConfigurationViewInformation

Gets information about all "ConfigurationViews".

Call:

ParameterTypeDescription
Imagebool = falseIf set to "true", the response contains preview Images.
Position
[optional]
UINTIf set, only the information of the view at the specified position is provided.

Response:

ParameterTypeDescription
ConfigurationView
[multiple]
ConfigurationView 
PositionUINTPosition
NamestringName of the configuration view.
ImagestringBase64 encoded JPEG image

Example:


GetCurrentView

Serialize the current view.

Response:

ParameterTypeDescription
CurrentViewXMLNodeContains the serialzed wiew

Example:


GetImage

Generates an image of the current view and returns it. Call:

ParameterTypeDescription
ExportFormat2DExportFormat2DFormat in which the image should be generated.

Response:

ParameterTypeDescription
ExportFormat2DExportFormat2DFormat of the image.
ImagestringBase64 encoded JPEG image

Example:


GetLastPickDurationInSeconds

Gets the duration of the last pick in seconds. If no pick was performed, the duration will be 0.

Response:

ParameterTypeDescription
PositionfloatPick duration

Example:


GetMaxTreeDepth

Gets the maximum tree depth.

Response:

ParameterTypeDescription
MaxDepthUINTMaximum tree depth

Example:


GetModelRepository

Gets the current WebViewer model repository path.

Example:


GetNodeProperties

Gets the properties of a specific Node

ParameterTypeDescription
NodeId
[multiple]
NodeIdNodeIds of the nodes.
If no NodeId is provided, the selection will be used.

Response:

ParameterTypeDescription
PropertiesVSXMLProperties of the specified nodes.

Example:


GetNodeTransformMatrix

Gets the transformation matrix of a specific node.

ParameterTypeDescription
Global
[optional]
bool = trueIf true, then the global matrix is returned. Otherwise, the local matrix.
NodeIdNodeIdNodeId of the node.

Response:

ParameterTypeDescription
TransformMatrixMatrixa 4x4 row major transformation matrix

Example:


GetPageCount

Gets the page count of a 2D document.

Response:

ParameterTypeDescription
PagesUINTNumber of pages.

Example:


GetPropertiesOfSelectedNodes

Gets common properties of all selected nodes. Computes sum for physical properties if all geometries belonging to selected nodes contain physical properties.

Response:

ParameterTypeDescription
Properties<NodePropertiesXML>Properties of the selected nodes.

Example:


GetSavedSelections

Gets a list of all saved selections for the current scene.

Response:

ParameterTypeDescription
Selection
[multiple]
SavedSelectionList of saved selections

Example:


GetSceneSettings

Get the runtime settings of the current scene.

Response:

ParameterTypeDescription
SettingsXMLSettingsXMLSettings of the current scene

Example:


GetSceneState

Receive all available scenedata required to synchronize UI

Response:

Multiple events (SelectionChanged / SettingsChanged / SplitUpdate / active interactions / Measurementresult)

ParameterTypeDescription
SceneXMLNodeContainer for scenespecific data
NameStringScenename
2DboolIs it a 2D-scene
SelectionmodeSelectionModeCurrently active Selectionmode

Example:


GetSearchableNodeTypes

Gets a list of all searchable node types in the current scene.

Response:

ParameterTypeDescription
NodeType
[multiple]
StringList of searchable node types

Example:


GetSelectedBillOfMaterialRows

Gets the ids of all selected rows. A row is selected if it contains a node that is currently selected.

Response:


GetSelectedFacesColor

Gets the Color (ARGB) of selected faces.

In case of multiple colors the method returns ColorVarious, AlphaVarious = true and the returned color value is invalid.

Response:


GetSelectedNodes

Gets all currently selected nodes.

Response:

ParameterTypeDescription
NodeType
[optional]
NodeTypeThis parameter is present if all nodes have the same type.
NodeId
[multiple]
NodeIdAll selected node IDs

Example:


GetSettings

Gets the default import, export and scene settings. This settings are used on loading a file or stating a new scene.

Response:

ParameterTypeDescription
SettingsXMLSettingsXMLCurrent global Settings

Example:


GetStructure

Call:

ParameterTypeDescription
Minimal
[optional]
bool= trueIf set, the response contains the minimal structure (see below).

Response:

ParameterTypeDescription
Structure<VSXML>Structure of the whole scene.

Example:

Minimal Structure

If the parameter Minimal is set to true, the following data doesn't get exported:

Furthermore, node types values are exported as numeric values instead of strings.


GetViewsOverviewAsPDF

Returns a Base64 encoded string containing an overview of all views represented by their names and a preview image.

Response:

ParameterTypeDescription
ImagestringBase64 encoded image

Example:


GetViewsAsPDF

Returns PDF a Base64 encoded string containing image information of all views referenced by their Id in the call. Additionally, information about the geometry contained in the views are added to the bottom of each page. The image contains all views if no Ids are passed to the call.

Call:

ParameterTypeDescription
Id
[multiple]
UINTId of the configuration view. PDF contains all views if no Ids are given.

Response:

ParameterTypeDescription
ImagestringBase64 encoded image

Example:


GetUndoStack

Returns the current stack of undo operations.

Response:

ParameterTypeDescription
Step
[multiple]
stringTranslated undo step.

Example:


GotoPage

Scrolls to the specified page.

Call:

ParameterTypeDescription
PageUINTPage to which to scroll.
Page starts at 0.

Example:


HideAllMarkups

Hides all markups.

Example:


HideAllPMIs

Hides all PMIs.

Example:


HideVisibleCallouts

Hide all visible callouts.

Example:


ImportConfigurationViews

Imports configuration views.

Remarks: Configuration views can be either imported by a file path or by embedded data in the XML API request. If the FileName parameter is present, data will only be imported from the given file.

ParameterTypeDescription
FileNamestringPath to the file containing configuration view data.
DeleteExistingViewsboolDelete all existing configuration views prior to import.
optional, default: false
VSViewsViews XMLImport configuration views directly from request.

Examples:


ImportFile

Imports a file into the current scene.

Call:

ParameterTypeDescription
FileNameFileNamePath to the file which should be imported.
WebViewer: relative path in ModelRepository (or full path if ModelRepository set to empty in setting file CRendererInstance.ini).
If remote file loading is enabled (enabled by default in all products except WebViewer) you can also pass URLs to files served via HTTP/HTTPS/FTP/FTPS protocols.
Name
[optional]
stringName for the imported root node

Example:


ImportMarkups

Imports Markups to the Scene

The required MarkupXML can be retrieved from ExportMarkupsAsXML

Call:

ParameterTypeDescription
MarkupExportXMLNode
optional
Rootnode of the MarkupXML, may be omitted
MarkupsVSXMLSerialized Markups
ReferencesVSXMLSerialized References

Example


ImportVSXMLToNode

Imports a VSXML to the specified node.

Call:

ParameterTypeDescription
NodeId<NodeId>NodeId of the nodes to which the VSXML should be imported.

Example:


InvertVisibility

Inverts the visibility of all nodes.

Example:


IsAutoCalloutAlignmentActive

Get current status of automatic callout alignment.

Example:

Response:

ParameterTypeDescription
ResultboolStatus of automatic alignment

LockCallouts

Locks all callouts or all selected callouts. Locked callouts cannot be transformed until unlocked again.

Example:


LogMessage

Logs a message with an optional logging level.

Call:

ParameterTypeDescription
MessagestringLog message
Level
[optional]
LogLevelLog level

Example:


MeasureSelectedWireLength

Highlights all wires found in the selected nodes, clears the selection and triggers a MeasurementChanged event with the accumulated wire length of all nodes.

Example:


MeasureDistanceSolidsToSolids

Measures the distance between solids. The solids to be computed will be chosen based on the following parameter:

Call:

ParameterTypeDescription
DistanceSolidsComputationTypeDistanceSolidsComputationTypeDefines the type of groups to be clashed against each other.

Examples: NodesSelectedVsUnselected: Clashes all selected nodes against all unselected nodes. NodesSelectionInternal: Clashes every selected node against every other selected node. SelectionSetsSelectedVsUnselected: Clashes the nodes from all selected selection sets against the remaining sets. SelectionSetsSelectionInternal: Clashes the nodes from each selection set against the nodes from each other set.


MirrorSelectedNodes

Mirrors the selected nodes.

Call:

ParameterTypeDescription
Copybool = trueIf set to "true" the method will generate a mirrored copy.
PlanePlaneOptionDefines the plane at which the nodes are mirrored.

Example:


ModifySelection

Modifies the selection with the selected "SelectionModifier".

Call:

ParameterTypeDescription
SelectionModifier<SelectionModifier>Specifies how the selection is modified

Example:


MoveConfigurationView

Repositions the given configuration view inside the configuration view list.

Call:

ParameterTypeDescription
ConfigurationView<UINT>Current position of the target configuration view (zero based index, i.e. 0 is the first configuration view)
Position<UINT>Target position of the configuration view (zero based index)

Example:


NewScene3D

Creates a new empty 3D scene using default scene settings defined before. Remarks: Any previous file will be closed without saving!

Call:

ParameterTypeDescription
DiscardExistingScenes
[optional]
bool = trueCloses all open scenes if set to true
Width
[optional]
UINT = 1Width in pixels of the window in which the model should be displayed.
Height
[optional]
UINT = 1Height in pixels of the window in which the model should be displayed.
Name
[optional]
stringName of the new scene

Example:


NextPage

Scrolls to the next page of 2D documents.

Example:


OpenFile

Opens the specified file. Remaks: Any previous open file will be closed without saving!

Call:

ParameterTypeDescription
FileNameFileNamePath to the file which should be opened.
WebViewer: relative path in ModelRepository (or full path if ModelRepository set to empty in CRendererInstance.ini).
If remote file loading is enabled (enabled by default in all products except WebViewer) you can also pass URLs to files served via HTTP/HTTPS/FTP/FTPS protocols.
WidthUINT = 1Width in pixels of the window in which the model should be displayed.
HeightUINT = 1Height in pixels of the window in which the model should be displayed.
Name
[optional]
stringIf set, renames the master root node and matching root nodes.
Master root nodes are typically named after the loaded file's name, e.g. FooBar.CATPart or FooBar.CATPart.3dvs
If the master root node contains any child root node whose...
- ...name is equal to the master root node's name
- ...name is equal to the master root node's name except for the last extension (e.g. just FooBar or FooBar.CATPart)
- ...name is equal to the master root node's name except for the last two extensions (3dvs only, e.g. just FooBar)
... then the node's name is replaced by the provided value.
ExecuteAsync
[optional]
bool = falseAsynchronously executes this method.
See Remarks for more info about asynchronous execution.

Response (synchronous execution):

ParameterTypeDescription
NewViewIdUINTId fo the newly created View.
Type2D / 3DIdentifies what type of file was opened.
FileFormatstringFormat and version of the opened file.

Response (asynchronous execution):

ParameterTypeDescription
AsyncOperationIdstringId of asynchronous operation.

Remarks:

If executed with ExecuteAsync flag set to true, the method returns an operation identifier which can be used to identify the matching AsyncEventEnd event instance.

Example (synchronous execution):

Example (asynchronous execution):


PauseRendering

Pauses rendering and tree updates.

Example:


PreviousPage

Scrolls to previous page of 2D documents.

Example:


RemoveEmptyNodes

Removes all empty nodes from the current scene.

Example:


RemoveEventListener

Removes an "Eventlistener" (see also Events).

Call:

ParameterTypeDescription
Event
[multiple]
<Event>Specifies the event which should be removed.

Example:


RemoveFaces

Removes face information from all selected nodes or all nodes if none are selected.

Example:


RemoveNormals

Removes normals for all selected nodes or all nodes if none are selected.

Example:


RemoveWires

Removes wires for all selected nodes or all nodes if none are selected.

Example:


RenameSavedSelection

Renames a saved selection.

Call:

ParameterTypeDescription
IndexUINTIndex of the selection
NamestringNew name of the selection

Example:


RenameBillOfMaterialRowCalloutId

Renames the callout id assigned to the row's nodes.

Call:

ParameterTypeDescription
RowIdUINTRow id
CalloutIdstringCallout id

Example:


ReplaceNode

Replaces the node with a new file/part.

Call:

ParameterTypeDescription
NodeIdNodeIdNodeId of the node to be replaced.
FileNamestringPath of the new part.
ReplaceAll
[optional]
bool = falseReplace all nodes with the same path as the node to be replaced.
KeepCurrent
[optional]
bool = falseKeep and only hide the current node.

Example:


ResetCoordinateSystem

Activates the default coordinate system.

Example:


ResetSceneLight

Reset the scene lighting to the default ambient, diffuse and specular values.

Example:


ResetNodesLuminance

Reset specified nodes luminance; applies to the currently selected nodes or to all specified node luminance if the current selection is empty.

Example:


ResetWallthicknessVisualization

Resets the scene's wall thickness heat map visualization properties.

Example:

 


ResetZoom

Resets the zoom, whole model can be seen without leaving the window extends on rotating the camera.

Example:


ResumeRendering

Resumes rendering and updates tree.

Example:


RotatePage

Rotates the page of a 2D document by 90, 180 or 270 degrees.

Call:

ParameterTypeDescription
AngleUINTAngle by which to rotate the current page. Other values are not supported.

Example:


Save2DAsPdf

Save a 2D-Session as vector PDF file. Remarks: Saving will overwrite existing files!

Call:

ParameterTypeDescription
FileNamestringPath of the new file

Example:


 

SaveAs

Save the Session as 3DVS file. Remarks: Saving will overwrite existing files!

Call:

ParameterTypeDescription
FileNamestringPath of the new file
SaveNodes
[optional]
bool = falseSpecifies if only provided Nodes should be saved. (In Zero position)
NodeId
[multiple]
NodeIdNodeId of the Node which should be changed.
If no NodeId is provided, the selection will be used.

Example:


SaveCurrentSelection

Save the currently selected nodes as a new selection.

Remarks: This is a temporary action. You have to save the opened file as .3dvs to persist selections over the current session.

Call:

ParameterTypeDescription
Name
[optional]
stringName of the selection

Response:

ParameterTypeDescription
IndexUINTIndex of the selection
NamestringName of the selection

Example:


SearchNodes

Search nodes with the given parameters.

Call:

ParameterTypeDescription
SearchStringSearchStringA search string which specifies the search parameters (AND combined)
SelectionModeSearchSelectionMode = NoneSpecified if nodes should be selected, replace selection or be added to the selection.
IncludeHiddenGeometriesbool = falseSpecifies if hidden geometry should be included in the search.
CaseSensitivebool = falseSpecifies if hidden geometry should be included in the search.
ColorRGBSearch for nodes matching color instead of passing a search string

Response:

ParameterTypeDescription
NodeId
[multiple]
NodeIdMatching list of NodeIds as search result.

Example:


SearchNodesByString

Search nodes with the given parameters from string. Option such as case sensitive or select after search will be taken from the current scene settings.

Call:

ParameterTypeDescription
SearchStringstringA search string which specifies the search parameters.

Response:

ParameterTypeDescription
NodeId
[multiple]
NodeIdNodes matching search string

Example:


SectionAlignAxis

Aligns the section pane on the given axis.

Call:

ParameterTypeDescription
AxisstringAxis to align on.
Values: X, Y or Z

Example:


SectionCenterHandles

Centers the cutting pane handle in the view.

Example:


SelectAllGeometries

Selects all geometries.

Example:


SelectBillOfMaterialRows

Selects all nodes contained in the given rows.

Call:

ParameterTypeDescription
RowId
[multiple]
UINTRows to select
AddToSelectionboolAdd nodes to current selection (default: false)

Example:


SelectClashIndex

Selects the clash with the given index.

Call:

ParameterTypeDescription
IndexUINTIndex to select

Example:


SelectSurfaces

Selects all nodes that consist of only one surface, and returns the number of nodes selected.

Response:

ParameterTypeDescription
NumberUINTNumber of nodes selected

Example:


SelectVisibleCallouts

Selects all visible callouts.

Example:


SetAnimationAxis

Sets the animation axis for the selected nodes.

Call:

ParameterTypeDescription
DirectionCoordinateDirectionAnimation axis

Example:


SetAnimationSpeed

Sets the animation rotation speed for the selected nodes.

Call:

ParameterTypeDescription
SpeedfloatRotation speed

Example:


SetBCFVisualizationInfo

SET a view to be displayed in current scene as BCF 1.0, 2.0 or 2.1 Visualization Information XML.

(Version 2.1) Components Selection Visibility Coloring

(Version 2.0 and 1.0) Components Component - Selected, Visible, Color

(Version 2.1, 2.0 and 1.0) OrthogonalCamera (the first camera determines the mode of the scene, orthogonal or perspective) PerspectiveCamera ClippingPlanes (only one plane supported)

Remarks:

For Selection, Visibility, Coloring IFC Data requires loading with attributes (IfcGuid), the same applies to preparation of 3DVS files.

Call:

ParameterTypeDescription
VisualizationInfoXMLhttps://github.com/buildingSMART/BCF-XML
Scale
[optional]
floatfor units other than meters, default: 1.0
FadeTime
[optional]
UINTFade time for a camera transition in ms (Default: 0 ms - no transition)

All X, Y, Z coordinates in meter

Example:

GetBCFVisualizationInfo


SetCalloutAlignment

Sets the alignment for all currently selected callouts or all, if no selection was made.

Call:

ParameterTypeDescription
AlignmentMarkupAlignmentAlignment to set

Example:

 


SetCamera

Sets the current camera position.

Call:

ParameterTypeDescription
PositionfloatCamera position
LooktAtfloatPoint to which the camera looks
UpVectorfloatUp vector of the camera
FadeTime
[optional]
UINTFade time for animated camera transition in ms (Default: 0 ms - no transition)

Example:


SetCurrentView

Deserialize into the current view.

Call:

ParameterTypeDescription
CurrentViewXMLNodeAs exported from GetCurrentView

Example:


SetSceneLight

Sets the scene's lighting components: ambient, diffuse and specular. This is used, e.g. to reduce brightness in case of a night scene.

Call:

ParameterTypeDescription
Ambientfloat3Directionless lighting, provides the scene with basic brightness.
Diffusefloat3Lighting component which provides the surface brightness depending on its direction.
Specularfloat3Lighting component which creates bright spots on surface depending on its shininess.

Example:


SetSceneSettings

Sets runtime settings for the current scene.

Call:

ParameterTypeDescription
SettingsXMLSettingsXMLDesired scene settings

Example:


SetSelectedFaces

Selects a range of faces from a node.

Call:

ParameterTypeDescription
NodeIdNodeIdNodeId to which the face ids refer, or #CustomId.
FaceId
[multiple]
UINTIds of the faces which should be selected.
AddToSelection
[optional]
(default: false)
booltrue to add the given face ids to the current selection, clears the current selection if false

Example:


SetSelectedFacesColor

Sets a Color (ARGB) to selected faces

Call:

ParameterTypeDescription
ColorARGBNodeIds of the nodes which should be selected, or #CustomId.

Example:


SetSelectedNodes

Selects a range of nodes.

Call:

ParameterTypeDescription
NodeId
[multiple]
NodeIdNodeIds of the nodes which should be selected, or #CustomId.
AddToSelection
[optional]
(default: false)
booltrue to add the given node ids to the current selection, clears the current selection if false

Example:


SetSelectedNodesLuminance

This is used, e.g. to simulate a light source in case of night scene. The given float number between 0 and 1 will be added to the ambient lighting component of the selected nodes.

Call:

ParameterTypeDescription
LuminancefloatSpecifies additional brightness, range [0, 1].

Example:


SetSelectionMode

Sets the selection mode.

Call:

ParameterTypeDescription
SelectionModeSelectionModeDesired selection mode

Example:


SetSettings

Sets global settings.

Call:

ParameterTypeDescription
SettingsXMLSettingsXMLDesired global settings.

Example:


SetModelRepository

Sets the WebViewer model repository path.

Note for WebViewer users: This method only has an effect if the AllowModelRepositoryOverrides setting in CRendererInstance.ini is set to 1 (default: 0)

Call:

ParameterTypeDescription
PathStringPath to the model repository.

Example:


SetNodeProperties

Sets the properties of the specified Node.

Call:

ParameterTypeDescription
NodeId
[multiple]
NodeIdNodeId of the Node which should be changed.
If no NodeId is provided, the selection will be used.
VSXMLVSXMLDesired node properties.

Example:


SetNodeTransformMatrix

Sets the transformation matrix of a specific node.

ParameterTypeDescription
Global
[optional]
bool = trueIf true, then the global matrix is set. Otherwise, the local matrix.
NodeIdNodeIdNodeId of the node.
TransformMatrixMatrixa 4x4 row major transformation matrix

Example:


ShowAll

Shows everything.

Example:


ShowAllCallouts

Show all callouts.

Example:


StartPlayConfigurationViews

Starts the playback of the ConfigurationViews.

Timing can be set per ConfigurationView. If not set, it is taken from ConfigurationView Settings.

Call:

ParameterTypeDescription
Position
optional
Default: 0
UINTPosition of the ConfigurationView to start the playback.
Reverse
optional
Default: false
boolPlay towards the end or the beginning of the list.
Number
optional
Default: 0
UINTThe number of ConfigurationViewsin this playback sequence. 0 = All

Example:


StopPlayConfigurationViews

Stops the playback of the .

Example:


Undo

Undos a specifies number of actions.

Call:

ParameterTypeDescription
StepsUINT = 1Number of steps which should be undone.

Example:


UnGhostAll

Unghosts all ghosted nodes.

Example:


UnlockCallouts

Unlocks all callouts or all selected callouts.

Example:


UpdateBillOfMaterialRowCalloutId

Updates the callout id value of the provided BOM row.

If the BOM row contains no callout id, the provided callout id gets remembered to be used by the next call to GenerateBOMCallouts. If the new callout id is empty, any assigned or remembered callout id value gets cleared. If the row contains an id to an existing callout, the actual callout gets renamed.

ParameterTypeDescription
RowIdUINTId of the BOM row to update
CalloutIdstringNew callout id value to use

UpdateConfigurationView

Updates the ConfigurationView at the specified position.

Call:

ParameterTypeDescription
PositionUINTPosition of the ConfigurationView.
NamestringOptional: New name for the ConfigurationView

Remarks:

If the optional Name parameter is given in the call, then only a rename will be performed.

Example:


UpdateSavedSelection

Updates the saved selection with the currently selected nodes.

Call:

ParameterTypeDescription
IndexUINTIndex of the saved selection

Example:


UpdateScene

Updates the scene by deleting the current scene and rebuilding the node tree.

Call:

ParameterTypeDescription
KeepCreatedNodesbool = trueSpecifies if the "CreatedNodes" subtree should be preserved
VSXMLVSXMLNew structures VSXML

Example:


ValidateGeometry

Utilizes the "Reference" part of ImportMarkups to validate geometry

Call:

ParameterTypeDescription
Recoverbool
Default: true
Try to recover reordered indices.
This increases the time

Example:


 

VirtualTreeViewCollapseAll

Collapses all nodes in the tree.

Example:


VirtualTreeViewCollapseSelected

Collapses the children of all selected nodes.

Example:


VirtualTreeViewExpandAll

Expands all nodes in the tree.

Example:


VirtualTreeViewExpandSelected

Expands all selected nodes to make all their children visible.

Example:


VirtualTreeViewExpandToSelectedLevel

Expands the entire tree to the level of the selected node. This will not work if more than one node is selected.

Example:


VirtualTreeViewSelectSameLevelNodes

Selects all nodes that are on the same level as the selected node. If more than one node is selected, the first one will be taken as reference.

Example:


VirtualTreeViewScrollDown

Scrolls down the tree for the specified amount of steps.

Call:

ParameterTypeDescription
StepsUINTNumber of steps to scroll down

Example:


VirtualTreeViewScrollUp

Scrolls up the tree for the specified amount of steps.

Call:

ParameterTypeDescription
StepsUINTNumber of steps to scroll up

Example:


VirtualTreeViewSetSize

Sets the number of lines visible to the amount specified.

Call:

ParameterTypeDescription
SizeUINTNumber of lines visible

Example:


VirtualTreeViewToggleExpansion

Expands a node if not expanded and collapses it otherwise.

Call:

ParameterTypeDescription
NodeIdNodeIdNodeId of the node to be toggled.

Example:


VirtualTreeViewToggleVisibility

Makes a node visible if hidden and hides it otherwise.

Call:

ParameterTypeDescription
NodeIdNodeIdNodeId of the node to be toggled.

Example:


ZoomIn

Zooms in.

Example:


ZoomOut

Zooms Out.

Example:


Deprecated

New3DView

Please use NewScene3D.

Creates a new empty 3DView.

Remarks: Any previous file will be closed without saving!

Example:


SetMouseButtonFunctions

Please use SetSceneSettings.

Sets the mouse buttons functions.

Call:

ParameterTypeDescription
LeftMouseButtonFunction
[optional]
MouseButtonFunctionDesired mouse function
RightMouseButtonFunction
[optional]
MouseButtonFunctionDesired mouse function
MiddleMouseButtonFunction
[optional]
MouseButtonFunctionDesired mouse function

Example:


SetRenderMode

Please use SetSceneSettings.

Sets the render mode.

Call:

ParameterTypeDescription
RenderMode
[multiple]
RenderModeDesired render mode

Example:


ShowGrid

Please use SetSceneSettings.

Shows the grid.

Example:


Events

ActivateInteraction

Occurs if an interaction was activated.

Response:

ParameterDescription
Interaction(#Interaction)Interaction
Specifies the interaction which was activated.

Example:


CalloutAutoAlignmentChanged

Gets triggered whenever the auto alignment mode state of callouts changes.

Response:

ParameterDescription
Statebool
Updated auto alignment state.

Example:


CalloutListChanged

Gets triggered whenever the list of callouts changes.

Example:


CalloutSelectionChanged

Occurs if the selection changed. Contains a list of all selected callout ids or an empty list if none is selected.

Response:

ParameterDescription
CalloutIdCalloutId
ID of a selected callout.
(Can occur multiple times)

Example:


CalloutProjection

ParameterDescription
ItemItem
One projected item.
(Can occur multiple times)
IdId
CavasXUINT
X-position
CavasYUINT
Y-position
CalloutTextstring
CalloutNamestring
Visiblebool
InViewportbool
Depthfloat

Response:


DeactivateInteraction

Occurs if an interaction was deactivated.

Response:

ParameterDescription
Interaction<Interaction>
Specifies the interaction which was deactivated.

Example:


ImportFinished

Gets triggered when the import was finished. For incrementally loaded 3DVS files, this will be after the entire content was loaded.

Example:


NodeCreated

Gets triggered whenever a node got created.

Warning:

Due to the nature of how nodes get created internally it is currently not possible to reliably get the node's properties correctly when this event gets fired. This will be changed in a future update.

Response:

ParameterDescription
NodeId<NodeId>
NodeId of the created node

Example:

NodeDeleted

Gets triggered whenever a node got deleted.

Response:

ParameterDescription
NodeId<NodeId>
NodeId of the deleted node

Example:

PageChanged

2D only

Gets triggered when the current document page changes. Can be sent by the client to change document pages.

Parameters:

ParameterDescription
PageUINT
Current page, starts from 1.
PagesUINT
Page count.

Example:

PresetChanged

Gets triggered whenever a preset changed.

Response:

ParameterDescription
TypePresetType
Type of changed preset.
Namestring
Name of preset.
If name is empty, no preset is active, i.e. userdefined settings.

Example:

SavedSelectionsChanged

Gets triggered whenever the list of saved selections changes.

Response:

ParameterDescription
Selection
[multiple]
SavedSelection
Updated list of all saved selections.

Example:

SelectionChanged

Occurs if the selection was changed. The event only includes internal Ids.

Response:

ParameterDescription
NodeType<NodeType>
NodeId<NodeId>
NodeIds of the currently selected nodes.

Example:


SelectionChangedCustomId

Occurs if the selection was changed. The event only includes CustomIds. If the clicked object does not contain its own CustomId, the event will return the next CustomId found while traversing upwards the model hierarchy.

Response:

ParameterDescription
NodeType<NodeType>
NodeId
[multiple]
<NodeId>
NodeIds of the currently selected nodes (#CustomId).

Example:


TransformChanged

Gets triggered when nodes are transformed, a boundary condition is activated/deactivated or a coordinate system is activated/deactivated.

Example:

In case of activated boundary condition, e.g. rotation around a defined axis:


ImportLogMessage

Gets triggered at the end of file import and sends the collected log messages from the importer.

Example:


WallthicknessValuesChanged

Gets triggered on scene change and whenever the heatmap values of a wallthickness computation changed.

Parameter Groups:

Result

Contains the computed minimum and maximum values of the heatmap. These values cannot be changed.

Visualization

Contains settings affecting the heatmap's visualization. These values can be changed by sending back this event structure with the modified values. Minimum and Maximum are expected to be floating point values without any attached unit like 1.23 mm.

Example:

 

Changelog

Version 2022.0.130

Version 2021.1.621

Version 2021.1.459

Version 2021.1.446

Version 2021.0.148

Version 2020.2.173

Version 2020.1.318

Version 2020.1.212

Version 2020.0.209

Version 2019.0.510

Version 2019.0.341

Version 2019.0.314

Version 2019.0.298

Version 2019.0.268

Version 2019.0.119

Version 2018.0.225

Version 1.17

Version 1.16

Version 1.15

Version 1.14

Version 1.13

Version 1.12

Version 1.11

Version 1.0

Appendix

Types

AlignViewOption


ARGB

32 bit color value with alpha


AttributeGenerationMode


bool


Color

For "Color" its an 32 bit ARGB color.


CustomIdGenerationMode


ComputationMode


CoordinateDirection


DistanceSolidsComputationType


ExplosionType


ExportFormat3D


ExportFormat2D


float


float3

3-dimensional vector of floating point values


Interaction


LogLevel


MarkupAlignment


TransformMatrix

4x4 row major matrix of floating point values