1.1.1
Getting Started
Technical Overview
Data Import (server side)
HOOPS Converter
Direct Authoring
Data loading (client side)
Streaming
File-based loading
Quickstart
Viewing the sample page
Viewing your model
Converter application
Package Description
Supported Formats
Supported Import Formats
Supported Export Formats
Additional Import Formats Available to HOOPS Web Platform or HOOPS Exchange Licensees
Additional Export Formats Available to HOOPS Web Platform or HOOPS Exchange Licensees
Additional Export Formats Available to HOOPS Web Platform or HOOPS Publish Licensees
Supported Platforms
Operating Systems
Recommendations
Recommended hardware
Recommended platforms
Amazon Linux (Amazon EC2 GPU Instance) [hardware accelerated graphics]
Amazon Linux EC2 GPU Instance
Generic Linux Server
Ubuntu 14.04 Server Edition (Amazon EC2 GPU Instance) [hardware accelerated graphics]
Ubuntu 14.04 Server Edition (Amazon EC2 GPU instance)
Ubuntu 14.04 Server Edition (Physical machine) [hardware accelerated graphics]
Ubuntu 14.04 Server Edition (Physical Machine With Hardware-Accelerated Graphics)
Ubuntu 14.04 Server Edition (Virtual machine)
Ubuntu 14.04 Server Edition (Virtual Machine)
Windows Server 2012 R2 / Windows Server 2008 R2 (Amazon EC2 GPU instance) [hardware accelerated graphics]
Windows Server 2012 R2 / Windows Server 2008 R2 (Amazon EC2 GPU Instance)
Amazon EC2 recommendations
Windows redistributables
Linux dependencies
Web Viewer
Contact
Community forum
Commerical licensed developers
Policies
Support portal
License Key
Evaluation license
Commerical license
Updating your license
Frequently Asked Questions
Acknowledgements
3dconnexion 0.61
tinyxml2 2.0.0
js-base64 1.3
Iscroll
jQuery 3.5.1
jQuery UI 1.11.14
jQuery-minicolors 2.2.3
touchpunch 0.2.3
Keymaster 1.6.2
mobile detect
Canvg 1.4
FileSaver 2.0.0
html2canvas 0.5.0-beta-4
jsziptools 2.4.1
libcurl 7.61.1
nowide-standalone 2.6
libwebsockets 2.0.1
OpenSSL
Boost 1.57
libjpeg-turbo 1.4.0
libegl 1.5
libgles2 2.1.0
SDL2 2.0.10
commander.js
express.js
node-http-proxy 1.18
morgan 1.9.1
os-service 2.20
uuid 3.3.3
winston 3.2.1
zstd 1.4.5
libpng 1.6.37
LZ4 r127
clipper 6.4.2
Eigen 3.2
LambdaOptions 1.0
rapidJSON 1.0
rapidXML 1.13
stb_image 2.26
base64.h 1.0
pugixml 1.7
v8 v8-7.8.279
v8 v8pp-1.5.1
promise-polyfill 2.1.0
bowser 1.x.x
tinygltf 2.1.0
zlib 1.2.5
Knowledge Base
Support
Downloads
Community Forum
Release notes
2023 U1
Enhancements
Fixed bugs
2023
Enhancements
Fixed bugs
2022 SP2 U1
Enhancements
Fixed bugs list
2022 SP2
Update supported formats
Enhancements
Fixed bugs list
2022 SP1 U1
Functional changes
Fixed bugs list
2022 SP1
Update supported formats
Enhancements
Functional changes
Fixed bugs list
2022 U1
Update supported formats
Fixed bugs list
2022
Update supported formats
Enhancements
Functional changes
Fixed bugs list
2021 SP2 U2
Update supported formats
Enhancements
Functional changes
Fixed bugs list
2021 SP2 U1
Update supported formats
Enhancements
Fixed bugs list
2021 SP2
Update supported formats
Enhancements
Functional changes
Fixed bugs list
2021 SP1 U1
Update supported formats
Enhancements
Fixed bugs
2021 SP1
Update supported formats
Enhancements
Functional changes
Fixed bugs
2021 U1
Fixed bugs list
2021
Enhancements
Fixed bugs
Public Roadmap
Archives
Tutorials
Environment setup
Prerequisites
Development approach
Installing Node.js and using NPM
package.json
Copying the HOOPS Web Viewer JS and Typescript files
Building a basic application
Project Layout
Summary
Concepts
Sample code
Copying files
Hello Web Viewer
Summary
Concepts
Creating a minimal HTML header
Creating a minimal HTML body
Connecting to the HOOPS Web Viewer component
Loading a model
Registering callbacks
Switching operators
Switching the draw mode
Custom operator basics
Summary
Concepts
Operator class skeleton
onMouseDown action
DOM element for operator switching
Instantiating an operator
Switching to a new operator
Advanced operator concepts
Summary
Concepts
Creating the measure operator class
Handling the “onMouseDown” event
Registering the new operator
Creating a markup element
Defining the markup class
Implementing the draw method
Running the application
Displaying line and distance
Drawing the markup on mouse move
Different style before finalizing
Handling model units
Interacting With The Model Tree
Summary
Concepts
Creating the model tree class
Function to generate model tree in the DOM
Generating the model tree
Adding node IDs to DOM elements
Selection from DOM
Handle selection from the Web Viewer Component
Wiring up selection callback
Displaying CAD views
Color and transparency
Summary
Concepts
Functions to set node colors
Creating HTML for color picker
Running the application
Setting node opacity
HTML for opacity button
Geometry And Texture Creation
Summary
Concepts
Starting the Web Viewer with an empty model
Creating the cube mesh geometry
Create a cube
Creating multiple cubes
Running the application
Loading images
Setting textures
Copying images
Creating the UI
Connect UI to texture logic
Initialize the textures
Loading the application
Model Loading And Aggregation
Summary
Concepts
Add UI for model switching
Handle onchange event
Adding option for loading two models
Loading two models
Handling overlapping node IDs
Generating XML model structure file
Add XML loading option
Load via XML file
Connection to the HOOPS Server
Summary
Concepts
Running the server
Requesting a viewing session
Modifying the loading code
Additive manufacturing
Project Layout
Summary
Concepts
Setting Up Views
Summary
Concepts
Creating the printing plane
Summary
Concepts
Setting the selection callback
Summary
Concepts
Add a handles operator
Summary
Concepts
Syncing Multiple Viewers
Summary
Concepts
the Auto-Arrange Function
Summary
Concepts
The instance operator
Summary
Concepts
Adding additional models
Summary
Concepts
Inventory management
Project layout
Summary
Concepts
The model XML file
Use Converter to generate files
Inspect the output of the XML
Setting up the main viewer
Summary
Concepts
Create the main entry and structure for the application
Setup, instantiate, and start the WebViewer
Create the WebViewer callback skeletons
Loading models
Summary
Concepts
Set event callbacks
Loading the model into the assembly tree
Encapsulate the event listeners
Linking to application data
Summary
Concepts
Retrieve supplemental database information
Storing retrieved data
Filling application data
Creating the display filter
Summary
Concepts
Creating a helper class
Using class properties to track values
Using filter values
Reset the scene
Adding color gradients
Summary
Concepts
Capturing the native default colors assigned to the model
Determine the range of active values
Include calls to the new color determinant functions
Adding the UI event listeners
Summary
Concepts
Use the ‘oninput event listener
Hookup company filter buttons
Setup the event listeners
Product configurator
Project layout
Summary
Concepts
Setting up the viewers
Summary
Concepts
Create the main entry point
Start the WebViewer objects
Create the WebViewer callback skeletons
Loading models
Summary
Concepts
Write the loadModelPreview function
Add interaction to the navigation
Encapsulating the anchor event listeners
Add component selection
Summary
Concepts
Tracking component selections
Organizing the assembly tree
Incorporating model relationships
Summary
Concepts
Using “fetch”
Scaling correctly
Apply the transform data
Clearing the build
Summary
Concepts
Resetting your application
Build a streaming service
Setup
Creating a simple file server
Creating the application server
Spawning a stream cache server
Liveliness updates
The ready message
The disconnect message
The ping message
Creating viewers
Removing viewers
SSR support
Monitoring server load
Conclusion and next steps
Prerequisites
Development approach
Programming Guide
Docker Support
Basic configuration
Extending the containers
HOOPS Containers with AWS
Overview
HOOPS Converter
Stream Cache Streaming Server
Viewing
Basic Setup
Required libraries
Creating a basic application
Configuration
Loading data at startup
Streaming via the Stream Cache Server
Loading an SCS file via an HTTP request
Additional settings
boundingPreviewMode
calculateDefaultViewAxes
defaultMeshLevel
enginePath
memoryLimit
rendererType
sessionToken
streamingMode
streamCutoffScale
Callbacks
Setting callbacks
Multiple callbacks
Unregistering callbacks
Important callbacks
Performance
Minimum framerate
Incremental updates
Stream cutoff scale
Bounding previews
Memory limit
Show framerate
Selection and picking
Picking
Pick from point selection
Selection
Select single node
Events
Selection operator
Area and volume selection
Select by area
Ray drill selection
Polyhedron selection
Animation
Quickstart UI example
Overview
Translation animation
1. Create a NodeChannel
2. Set the initial keyframe
3. Convert the translation vector in the local coordinate
4. Set keyframe for the node’s end position
Camera animation
Rotation animation
Export/Import
Operators
Custom Operators
Overview
Creating custom operators
Registering an operator
Activating an operator
Event propagation
Built-in operators
Activating a predefined operator
Operator categories
Geometry Handles
Introduction
Handle operator
Scene Attributes
Camera
Setting a camera
Getting a camera
Storing and retrieving a camera
Camera components
Retrieving the camera matrices
Camera callback
Conversion functions
Point to window position
Project point
Draw Modes
Overview
Hidden line
Hard edge detection
X-ray
Cutting Planes
Basic concepts
Cutting manager
Cutting sections
Capping geometry
Reference geometry
Cutting plane operator
Callbacks related to cutting planes / sections
Cutting pane UI
Explode
Basic concepts
Explode manager
Start
Stop
setMagnitude
Explode effects
Effects
Ambient occlusion
Ambient occlusion radius
Ambient light
Bloom
Bloom threshold
Bloom threshold ramp width
Bloom intensity scale
Multi-layer bloom
BloomLayerInfo
Adding and removing bloom layers
Simple shadows
Simple shadow opacity
Simple shadow color
Simple shadow resolution
Simple shadow blurSamples
Simple shadow blurInterval
Simple reflections
Simple reflection blurInterval
Simple reflection blurSamples
Simple reflection fade angle
Simple reflection opacity
Simple reflection attenuation
Silhouette edges
Silhouette color
Silhouette opacity
Silhouette threshold
Silhouette threshold ramp width
Overlays
Creating a new overlay
Setting the viewport
Assigning geometry
Assigning a camera
Complete example
Selection
Hiding and destroying an overlay
Other considerations
Lights
Introduction
Lighting examples
Axis Triad and Navcube
Axis triad
NavCube
Modifying the axis triad
Modifying the NavCube
Model Attributes
Materials
Basics
Textures
Physically Based Rendering
Matrices
Points and vectors
Copying
Matrices
Identity matrix
Translation
Rotation
Scaling
Combining matrices
Direct element access
Matrices and nodes
Relative geometry changes
Instance Modifiers
Setting and unsetting
AlwaysDraw
DoNot modifiers
Line Patterns
Setting/unsetting line patterns
Define a style
Limitations
Visibility
Element visibility
Node visibility
Visibility propagation
Hidden nodes
Querying node visibility
Resetting node visibility
Geometry
Meshes
Creating meshes
Create meshData
Create mesh
MeshInstanceData
NodeId
Create mesh instance
Replacing meshes
Level of detail (LOD)
Miscellaneous
Point Clouds
Overview
Authoring
Eye-dome lighting
Splat rendering
Markup
Markup Basics
Markup manager overview
Markup types
Markup views
Advanced Markup
Custom markup item
Custom markup item operator
Custom markup item manager
Example
Custom markup operator
HTML page
Markup callbacks
Line markup
Measurement
Redline
Measurement
How to measure a model
Edge / face / point measure
How to insert 2D and 3D text
Measure operator
Callbacks
Data Model
Overview
Model Tree
Overview
Nodes
NodeIDs
Node hierarchy
Instancing
Callbacks
Node creation
Instancing
Creating multiple instances from a part of a model
Full instancing source code
Layers and filters
Filters
Retrieving filters
Filtering nodes
Layers
Retrieving layers
Retrieving nodes per layer
Model Units
Overview
Working with model units
Multiple units with model aggregation
Metadata
Overview
Retrieving properties
Retrieving user data
Drawings
Identifying a drawing
Drawing UI
Sheets
Stream Cache
Overview
Loading
Loading subtrees
Shattered Workflows
SC and PRC
Miscellaneous Topics
User Interface
Default UI
Writing your own model tree
Model tree UI performance optimizations
Integrating with modern UI toolkits
Image and SVG Generation
Image creation overview
Example: Creating and displaying a snapshot image
Snapshot configuration
Extracting the image data
SVG creation overview
Example: Creating and displaying an SVG
Using the results
SVG configuration
Promises
Async / await
Typescript
About TypeScript
Definition files
Adding TypeScript support
Building the UI
Operator source
Data Import
Authoring
Creating Stream Cache Models
License
Models
Creating geometric data
Assigning parameters
Inserting geometry
Materials
Matrices
Creating geometry instances
Camera
Authoring the assembly tree
Assembly Tree Node IDs
Basics
Loading multiple files into the same viewing session
Working with units
How units are expressed
Examples
C++ examples
Building and running the C++ examples on Windows
Building and running the C++ examples on Linux
Java examples
Running the Java examples on Windows
Running the Java examples on Linux
Viewing the model in a browser
Converter Application
XML Batch Conversion
Stream Cache Workflows
Monolithic
Shattered
Creating a master SC model
Additional use cases
Known limitations
Monolithic HTML Export
About the HOOPS Communicator template file
Creating a custom template file
Helpful hints
Sample HTML template
Exchange SC mapping
Matching conversion parameters
Relationships between entity types
Product occurrences
Representation items
Selecting a server framework for HOOPS Exchange
XML Assembly Tree
Generating XML data
XML Data Format
Connecting HOOPS Web Viewer
License key
Running on Windows
Running in a “Headless” Linux environment
More examples
Distributing your application
64-bit Windows
64-bit Linux
Converter Library
License key
Linking to the Converter library
Development on Windows
Example usage
Importing multiple files
Servers
Stream Cache Server
HOOPS Server
HTTP-Server
Rendering types
Client-Side Rendering (CSR)
Server-Side Rendering (SSR)
SCS - Single File Based Rendering
Communicator for MCAD
CAD Views
Overview
Activating a CAD view
Creating a new CAD view
Other considerations
PMI
Importing PMI
Authoring PMI
Retrieving PMI elements
Interrogating PMI
Setting PMI color
Metadata
Importing generic attributes
Importing physical properties
Importing measurement data
Retrieving metadata
Configurations
Importing configurations
Importing a specific configuration
Querying configurations
Activating a configuration
Callback
Other considerations
Communicator for BIM
Supported formats
IFC
IFC types
IFC layers
IFC GlobalID
IFC Walk Operator
Revit
DWG
Importing DWGs
Sheets
Federated models in BIM
API References
Web Viewer API Reference
Animation
Util
Functions
CameraProperty
Enumeration members
InterpolationType
Enumeration members
KeyType
Enumeration members
NodeProperty
Enumeration members
PlayerState
Enumeration members
Animation
Constructors
Properties
Methods
BatchedCameraValues
Properties
Methods
BatchedNodeValues
Properties
Methods
BatchedValues
Properties
Methods
CameraChannel
Properties
KeyframeBuffer
Constructors
Properties
Methods
Manager
Methods
NodeChannel
Constructors
Properties
Player
Properties
Methods
Sampler
Constructors
Properties
Methods
ColorPosition
Properties
Type aliases
ColorMap
KeyframeIndex
Functions
exportAnimations
importAnimations
Event
InputEvent
Methods
KeyInputEvent
Methods
MouseInputEvent
Constructors
Methods
MouseInputEventBase
Methods
MouseWheelInputEvent
Methods
NodeSelectionEvent
Methods
TouchInputEvent
Methods
Functions
isMouseEventType
GUID
Functions
create
Markup
Line
LineMarkup
Measure
MeasureMarkup
Note
NoteTextElement
NoteTextManager
Redline
RedlineItem
Shape
EndcapType
Circle
CircleCollection
EndcapShape
FilledShape
Line
LineCollection
Polygon
PolygonCollection
Polyline
PolylineCollection
Rectangle
RectangleBase
RectangleCollection
StrokedShape
Text
TextBox
TextBoxBase
TextBoxCollection
TextCollection
TextMarkupBase
MarkupItem
Methods
MarkupView
Methods
MarkupRenderer
Methods
Operator
MeasurePolygonAreaAnchor
Enumeration members
MeasurePolylineDistanceAnchor
Enumeration members
AreaSelectionOperator
Methods
AxisTriadOperator
Methods
CameraKeyboardWalkOperator
Bim
Methods
CameraNavigationOperator
Methods
CameraOrbitOperator
Type aliases
Methods
CameraPanOperator
Methods
CameraTurntableOperator
Type aliases
Methods
CameraWalkModeOperator
Methods
CameraWalkOperator
Bim
Methods
CameraWindowZoomOperator
Methods
CameraZoomOperator
Methods
FloorplanOperator
Methods
HandleOperator
Constructors
Methods
MeasureBodyBodyDistanceOperator
Constructors
Methods
MeasureEdgeLengthOperator
Methods
MeasureFaceFaceAngleOperator
Constructors
Methods
MeasureFaceFaceDistanceOperator
Constructors
Methods
MeasureLineLineAngleOperator
Constructors
Methods
MeasurePointPointDistanceOperator
Methods
MeasurePolygonAreaOperator
Methods
MeasurePolylineDistanceOperator
Methods
NavCubeOperator
Methods
NoteOperator
Methods
RayDrillSelectionOperator
Methods
RedlineCircleOperator
Properties
Methods
RedlinePolylineOperator
Properties
Methods
RedlineRectangleOperator
Properties
Methods
RedlineTextOperator
Properties
Methods
SelectionOperator
Methods
SpaceMouseOperator
Constructors
Methods
Operator
Properties
Selection
CompositeSelectionItem
Constructors
Properties
Methods
FaceEntity
Methods
IncrementalSelectionId
Constructors
LineEntity
Methods
PointEntity
Methods
SelectionItem
Methods
EntitySelectionItem
Methods
FaceSelectionItem
Methods
LineSelectionItem
Methods
NodeEntitySelectionItem
Methods
NodeSelectionItem
Methods
PointSelectionItem
Methods
Type aliases
VolumeSelectionId
Settings
HiddenLineSettings
Methods
StaticGenericType
Variables
SubentityProperties
EdgeType
Enumeration members
FaceType
Enumeration members
Blend01Element
Properties
Methods
Blend02Element
Properties
Methods
Blend03Element
Properties
Methods
CircleElement
Constructors
Properties
Methods
ConeElement
Constructors
Properties
Methods
CylinderElement
Constructors
Properties
Methods
CylindricalElement
Properties
Methods
ExtrusionElement
Properties
Methods
FromCurvesElement
Properties
Methods
LineElement
Constructors
Properties
Methods
NurbsElement
Properties
Methods
OffsetElement
Properties
Methods
OtherEdgeElement
Constructors
Properties
Methods
OtherFaceElement
Properties
Methods
PipeElement
Properties
Methods
PlaneElement
Constructors
Properties
Methods
RevolutionElement
Properties
Methods
RuledElement
Properties
Methods
SphereElement
Constructors
Properties
Methods
TorusElement
Constructors
Properties
Methods
TransformElement
Properties
Methods
Type aliases
Base
Edge
Face
OtherElement
UUID
Functions
create
Util
OpenPromise
Properties
Functions
Methods
TimerIdleType
Enumeration members
ActionQueue
Constructors
Methods
CurrentAction
Constructors
Methods
CurrentActionSync
Methods
IncrementalSelection
ConvexPolyhedronConfig
RayDrillConfig
ScreenByAreaConfig
SphereConfig
Type aliases
Methods
Lazy
Properties
Methods
StateMachine
Action
Type aliases
Constructors
Methods
Timer
Methods
Type aliases
Action
ActionLike
ActionResult
LazyLike
Functions
TypeAssert
TypeAssertNever
closestPointFromPointToSegment
closestPointScalarFromPointToSegment
computeAngleBetweenVector
computeOffaxisRotation
computePointToLineDistance
copyMap
copySet
createCylinderMeshDataFromArc
degreesToRadians
delayCall
distanceLineLine
filterInPlace
formatWithUnit
generateArcPoints
generateConeCylinderMeshData
generatePointsOnCircle
generateSphereMeshData
getLongUnitString
intersect3d2Planes
intersectionPlaneLine
intersectionPlaneLine2
isPointInRect2d
isPointOnLineSegment
isPointOnLineSegment2d
lineLineIntersect
oneVectorCross
radiansToDegrees
setSubtraction
setToArray
sleep
toSet
waitForAll
AntiAliasingMode
Enumeration members
None
SMAA
AttributeType
Enumeration members
Float
Ignored
Int
String
Time
Undefined
Axis
Enumeration members
X
Y
Z
BCFFileType
Enumeration members
Markup
Project
Schema
Snapshot
TopicFolder
Unknown
Version
Viewpoint
BCFVersion
Enumeration members
Unknown
v1_0
v2_0
v2_1
BasicUnit
Enumeration members
unitActivityRadionuclide
unitCapacitance
unitCatalyticActivity
unitDoseEquivalent
unitElectricCharge
unitElectricConductance
unitElectricCurrent
unitElectricResistance
unitElectromotiveForce
unitEnergy
unitForce
unitFrequency
unitIlluminance
unitInductance
unitKerma
unitLength
unitLuminosityIntensity
unitLuminousFlux
unitMagneticFlux
unitMagneticFluxDensity
unitMass
unitPlaneAngle
unitPower
unitPressure
unitSolidAngle
unitSubstanceAmount
unitThermoTemperature
unitTime
unitUnknown
BimMask
Enumeration members
Door
Floor
None
Wall
BlurIntervalUnit
Enumeration members
Pixels
ProportionOfHeight
ProportionOfWidth
BoundingPreviewMode
Enumeration members
All
Ejected
Instance
Model
None
BranchVisibility
Enumeration members
Hidden
Mixed
Shown
BuiltinOverlayIndex
Enumeration members
AxisTriad
Floorplan
Handles
NavCube
Button
Enumeration members
Left
Middle
None
Right
Buttons
Enumeration members
Left
Middle
None
Right
CullingVectorSpace
Enumeration members
Object
World
DrawMode
Enumeration members
Gooch
HiddenLine
Shaded
Toon
Wireframe
WireframeOnShaded
XRay
ElementType
Enumeration members
Faces
Lines
Points
EventType
Enumeration members
KeyDown
KeyUp
MouseDown
MouseMove
MouseUp
Mousewheel
TouchEnd
TouchMove
TouchStart
ViewOrientationChange
FaceWinding
Enumeration members
Clockwise
CounterClockwise
Unknown
FileType
Enumeration members
Acis
Cadds
Catia
CatiaV5
Cgr
Dae
Dwf
Dwg
Dxf
Euclid
Fbx
Gltf
Hpgl
Hsf
Ideas
Ifc
Iges
Inventor
Jt
Kmz
Obj
OneSpaceDesigner
Parasolid
Pdp
PostScript
Prc
ProE
Revit
Rhino
Scs
Se
Slw
Step
Stl
TopSolid
U3d
Unigraphics
Unisurf
Unknown
Vda
Wrl
Xml
Xvl
_3dHtml
_3ds
_3dxml
_3mf
FilterId
FloorplanAutoActivation
Enumeration members
Bim
BimWalk
Never
FloorplanOrientation
Enumeration members
AvatarUp
NorthUp
HandleEventType
Enumeration members
Rotate
Translate
HandleType
Enumeration members
Axis
Plane
Rotate
ViewPlane
ImageFormat
Enumeration members
Gray8
GrayAlpha16
Jpeg
Png
Rgb24
Rgba32
InfoType
Enumeration members
Error
Info
Warning
InstanceModifier
Enumeration members
AlwaysDraw
DoNotCut
DoNotExplode
DoNotLight
DoNotOutlineHighlight
DoNotSelect
DoNotUseVertexColors
DoNotXRay
ExcludeBounding
IgnoreCameraScale
IgnoreCutting
IgnoreExplosion
IgnoreLighting
IgnoreOutlineHighlight
IgnoreSelection
OverrideSceneVisibility
ScreenOriented
ScreenSpace
ScreenSpaceStretched
SuppressCameraScale
KeyCode
Enumeration members
Backspace
Delete
DownArrow
Escape
LeftArrow
NumPad_0
NumPad_1
NumPad_2
NumPad_3
NumPad_4
NumPad_5
NumPad_6
NumPad_7
NumPad_8
NumPad_9
PgDown
PgUp
RightArrow
Shift
UpArrow
_0
_1
_2
_3
_4
_5
_6
_7
_8
_9
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
KeyInputType
Enumeration members
Down
Up
KeyModifiers
Enumeration members
Alt
Command
Control
None
Shift
LayerId
LightSpace
Enumeration members
Camera
World
LightType
Enumeration members
Directional
LinePatternLengthUnit
Enumeration members
Object
ProportionOfScreenHeight
ProportionOfScreenWidth
World
MeshInstanceCreationFlags
Enumeration members
AlwaysDraw
DoNotCut
DoNotExplode
DoNotLight
DoNotOutlineHighlight
DoNotSelect
DoNotUseVertexColors
DoNotXRay
ExcludeBounding
Invisible
None
OverrideSceneVisibility
ScreenOriented
ScreenSpace
ScreenSpaceStretched
SuppressCameraScale
MouseInputType
Enumeration members
Down
Move
Up
Wheel
NodeSource
Enumeration members
CreateInstance
CreateNode
CreatePmi
LoadModel
NodeType
Enumeration members
AssemblyNode
Body
BodyInstance
BrepBody
CADView
CadView
DrawingSheet
PMI
PMIBody
Part
PartInstance
Pmi
PmiBody
PointsBody
TessBody
Unknown
ViewFrame
WireBody
OperatorId
Enumeration members
AreaSelect
AxisTriad
Cutting
Floorplan
Handle
Invalid
KeyboardWalk
MeasureBodyBodyDistance
MeasureEdgeLength
MeasureFaceFaceAngle
MeasureFaceFaceDistance
MeasureLineLineAngle
MeasurePointPointDistance
MeasurePolygonArea
MeasurePolylineDistance
NavCube
Navigate
None
Note
Orbit
Pan
RayDrillSelect
RedlineCircle
RedlinePolyline
RedlineRectangle
RedlineText
Select
SpaceMouse
Turntable
Walk
WalkMode
WindowZoom
Zoom
OrbitFallbackMode
Enumeration members
CameraTarget
ModelCenter
OrbitTarget
OverlayAnchor
Enumeration members
BottomCenter
Center
LeftCenter
LowerLeftCorner
LowerRightCorner
RightCenter
TopCenter
UpperLeftCorner
UpperRightCorner
OverlayUnit
Enumeration members
Pixels
ProportionOfCanvas
ProportionOfOtherDimension
PmiSubType
Enumeration members
DatumIdent
DatumTarget
DimensionAngle
DimensionChamfer
DimensionDiameter
DimensionDiameterCone
DimensionDiameterCylinder
DimensionDiameterEdge
DimensionDiameterTangent
DimensionDistance
DimensionDistanceCumulate
DimensionDistanceOffset
DimensionLength
DimensionLengthCircular
DimensionLengthCurvilinear
DimensionOrdinate
DimensionRadius
DimensionRadiusCylinder
DimensionRadiusEdge
DimensionRadiusTangent
DimensionSlope
GdtFcf
OtherGeometricReference
OtherRegion
OtherSymbolCustom
OtherSymbolUser
OtherSymbolUtility
Unknown
WeldingLine
WeldingSpot
PmiTopoRef
Enumeration members
Body
BrepData
CoEdge
Connex
Context
Edge
Face
Item
Loop
MultipleVertex
Shell
SingleWireBody
UniqueVertex
Unknown
WireBody
WireEdge
PmiType
Enumeration members
Arrow
Balloon
CircleCenter
Coordinate
Datum
Dimension
Fastener
Gdt
GeometricalTolerance
Locator
MeasurementPoint
Other
Roughness
Table
Text
Unknown
Welding
PointShape
Enumeration members
Disk
Sphere
Square
PointSizeUnit
Enumeration members
CSSPixels
ProportionOfBoundingDiagonal
ProportionOfScreenHeight
ProportionOfScreenWidth
ScreenPixels
World
Projection
Enumeration members
Orthographic
Perspective
RelationshipType
Enumeration members
Aggregates
ConnectsPathElements
ContainedInSpatialStructure
FillsElement
SpaceBoundary
Undefined
VoidsElement
RendererType
Enumeration members
Client
Server
ScreenConfiguration
Enumeration members
Desktop
Mobile
SelectionHighlightMode
Enumeration members
HighlightAndOutline
HighlightOnly
OutlineOnly
SelectionMask
Enumeration members
All
Face
Line
None
Point
SelectionMode
Enumeration members
Add
Set
Toggle
SelectionType
Enumeration members
Face
Line
None
Part
Point
SimpleReflectionAttenuationUnit
Enumeration members
ProportionOfBoundingHeight
World
SnapshotLayer
Enumeration members
All
Html
Model
Svg
StreamingMode
Enumeration members
All
Default
Interactive
OnDemand
TextureModifier
Enumeration members
Decal
TextureParameterization
Enumeration members
UV
TextureTiling
Enumeration members
Clamp
Repeat
Trim
TouchInputType
Enumeration members
End
Move
Start
TransparencyMode
Enumeration members
SingleLayer
Unsorted
TreeWalkMode
Enumeration members
Default
PerNode
ViewOrientation
Enumeration members
Back
BackBottom
BackBottomLeft
BackBottomRight
BackLeft
BackRight
BackTop
BackTopLeft
BackTopRight
Bottom
BottomBack
BottomFront
BottomLeft
BottomLeftBack
BottomLeftFront
BottomRight
BottomRightBack
BottomRightFront
Front
FrontBottom
FrontBottomLeft
FrontBottomRight
FrontLeft
FrontRight
FrontTop
FrontTopLeft
FrontTopRight
Iso
Left
LeftBack
LeftBottom
LeftBottomBack
LeftBottomFront
LeftFront
LeftTop
LeftTopBack
LeftTopFront
Right
RightBack
RightBottom
RightBottomBack
RightBottomFront
RightFront
RightTop
RightTopBack
RightTopFront
Top
TopBack
TopFront
TopLeft
TopLeftBack
TopLeftFront
TopRight
TopRightBack
TopRightFront
WalkDirection
Enumeration members
Backward
Down
Forward
Left
Right
RotateLeft
RotateRight
TiltDown
TiltUp
Up
WalkMode
Enumeration members
Keyboard
Mouse
XRayGroup
Enumeration members
Selected
Unselected
XRayTransparencyMode
Enumeration members
SingleLayer
Unsorted
AssemblyDataParseError
Constructors
constructor
Properties
AxisTriad
Methods
disable
enable
getAnchor
getEnabled
getOverlayId
getSelectionAxis
insideOverlay
onClickSelection
setAnchor
setAxisColor
BCFComment
Constructors
constructor
Methods
getAuthor
getDate
getId
getModifiedAuthor
getModifiedDate
getText
getViewpointGuid
setAuthor
setDate
setModifiedAuthor
setModifiedDate
setText
setViewpointGuid
BCFData
Constructors
constructor
Methods
addTopic
exportBCF
getFilename
getId
getTopic
getTopics
getVersion
setVersion
toBcfZipBlob
BCFManager
Constructors
constructor
Methods
addBCFFromBuffer
addBCFFromFile
createBCFData
getBCFData
getBCFMap
removeBCFData
BCFMarkup
Constructors
constructor
Methods
addComment
addViewpoint
deleteComment
export
getBimDate
getBimFilename
getComments
getFilename
getIfcProject
getIfcSpacialStructureElement
getIsExternal
getMarkupHeaderFiles
getProjectGuid
getReference
getTopicAssignedTo
getTopicCreationAuthor
getTopicCreationDate
getTopicDescription
getTopicDueDate
getTopicId
getTopicIndex
getTopicLabels
getTopicModifiedAuthor
getTopicModifiedDate
getTopicPriority
getTopicReferenceLink
getTopicStage
getTopicStatus
getTopicTitle
getTopicType
getViewpoints
setTopicAssignedTo
setTopicCreationAuthor
setTopicCreationDate
setTopicDescription
setTopicDueDate
setTopicId
setTopicIndex
setTopicLabels
setTopicModifiedAuthor
setTopicModifiedDate
setTopicPriority
setTopicReferenceLink
setTopicState
setTopicStatus
setTopicTitle
setTopicType
updateComment
BCFMarkupHeaderFile
Constructors
constructor
Methods
getBimDate
getBimFilename
getIfcProject
getIfcSpacialStructureElement
getIsExternal
getReference
BCFMarkupViewpoint
Constructors
constructor
Methods
getGuid
getIndex
getSnapshotFilename
getViewpointFilename
BCFSnapshot
Constructors
constructor
Methods
getData
getFilename
getUrl
createFromImage
snapshotDataFromImage
BCFTopic
Constructors
constructor
Methods
addMarkup
addSnapshot
addViewpoint
getMarkup
getSnapshot
getSnapshotMap
getTopicId
getViewpoint
getViewpointMap
setSnapshot
setViewpoint
createTopic
BCFViewpoint
Constructors
constructor
Methods
activate
export
getCamera
getClippingPlanes
getColors
getColorsToNodes
getFilename
getLines
getSelection
getSelectionNodes
getViewpointGuid
getVisibilityExceptionNodes
getVisibilityExceptions
setCamera
setClippingPlanes
setColorNodes
setColors
setDefaultVisibility
setLines
setSelection
setSelectionNodes
setVisibilityExceptionNodes
setVisibilityExceptions
createViewpoint
Box
Constructors
constructor
Properties
Methods
addBox
addPoint
center
copy
equals
extents
forJson
getCorners
isDegenerate
toJson
construct
fromJson
invalid
Camera
Methods
copy
dolly
equals
equalsWithTolerance
forJson
getCameraPlaneIntersectionPoint
getFullMatrix
getHeight
getMatrixFromCamera
getNearLimit
getPosition
getProjection
getProjectionMatrix
getTarget
getUp
getViewMatrix
getWidth
setHeight
setNearLimit
setPosition
setProjection
setTarget
setUp
setWidth
toJson
transform
construct
create
fromJson
Color
Constructors
constructor
Properties
Methods
assign
copy
equals
forJson
fromFloatArray
getFloatArray
set
setFromFloat
toFloatArray
toJson
black
blue
createFromFloat
createFromFloatArray
fromJson
green
red
white
yellow
CommunicatorError
Constructors
constructor
Properties
CuttingManager
Methods
activateCuttingSections
clearAllCuttingSections
createReferenceGeometryFromAxis
createReferenceGeometryFromFaceNormal
deactivateAllCuttingSections
deactivateCuttingSections
delayCapping
enableCappingIdleCallback
forJson
fromJson
getActiveCuttingSectionCount
getCappingFaceColor
getCappingGeometryVisibility
getCappingLineColor
getCuttingSection
getCuttingSectionCapacity
getCuttingSectionCount
getCuttingSectionFromNodeId
getStandinGeometryPickable
hasActiveCuttingSection
refreshPlaneGeometry
setCappingDelay
setCappingFaceColor
setCappingGeometryVisibility
setCappingLineColor
setCuttingPlaneColor
setStandinGeometryPickable
toJson
waitForCappingIdle
CuttingSection
Methods
activate
addPlane
applyPlaneOpacity
clear
deactivate
forJson
fromJson
getCount
getNodeId
getPlane
getPlaneIndexByNodeId
getPlaneOpacity
getReferenceGeometry
isActive
removePlane
resetPlanesOpacity
setColor
setItemTransparency
setOpacity
setPlane
setPlaneOpacity
setPlaneTransparency
setTransparency
toJson
updatePlane
ExplodeManager
Methods
getActive
getMagnitude
setMagnitude
start
stop
FaceFaceDistanceItem
Properties
FilteredNodes
Constructors
constructor
Properties
FloorplanConfig
Properties
Methods
copy
FloorplanManager
Methods
activate
deactivate
getAvatarNodeId
getConfiguration
getCurrentFloorNodeId
getFloorLock
insideOverlay
isActive
setAutoActivate
setAvatarColor
setAvatarOpacity
setAvatarOutlineColor
setAvatarScale
setBackgroundColor
setBackgroundOpacity
setBorderColor
setBorderOpacity
setConfiguration
setCustomAvatar
setFixedAvatarScale
setFloorLock
setFloorplanOrientation
setOverlayAnchor
setOverlayFeetPerPixel
setOverlayOffset
setOverlaySize
setTrackCameraEnabled
setUseTightBoundings
setZoomLevel
snapAvatarToPoint
IncrementalPickConfig
Constructors
constructor
Properties
InternalLogicError
Constructors
constructor
Properties
InvalidIndexError
Constructors
constructor
Properties
InvalidNodeIdError
Constructors
constructor
Properties
InvalidNodeTypeError
Constructors
constructor
Properties
Light
Constructors
constructor
Properties
LineManager
Methods
addLine
exportMarkup
getAllLines
getLineByNodeId
loadData
removeAllLines
removeLastLine
removeLine
LoadCancelledError
Constructors
constructor
Properties
LoadError
Constructors
constructor
Properties
LoadSubtreeConfig
Properties
Methods
copy
MarkupManager
Methods
activateMarkupView
activateMarkupViewWithPromise
addMarkupElement
createMarkupView
deleteMarkupView
exportMarkup
getActiveMarkupView
getMarkupView
getMarkupViewKeys
getPickTolerance
getRenderer
getSelectedMarkup
loadMarkupData
pickMarkupItem
refreshMarkup
registerMarkup
registerMarkupTypeManager
removeMarkupElement
selectMarkup
setPickTolerance
unregisterMarkup
updateLater
MarkupTypeManager
Methods
exportMarkup
loadData
Matrix
Constructors
constructor
Properties
Methods
assign
copy
equals
equalsWithTolerance
forJson
inverseAndDeterminant
isIdentity
loadIdentity
multiplyByScalar
normalMatrix
scale
setScaleComponent
setTranslationComponent
toJson
transform
transform4
transformArray
transformBox
transpose
upperLeft3x3Determinant
construct
createFromArray
createFromBasis
createFromOffAxisRotation
fromJson
inverse
multiply
xAxisRotation
yAxisRotation
zAxisRotation
MeasureManager
Methods
addMeasurement
exportMarkup
finalizeMeasurement
getAllMeasurements
getMeasurementColor
getMeasurementEdgeColor
loadData
removeAllMeasurements
removeLastMeasurement
removeMeasurement
setMeasurementColor
setMeasurementEdgeColor
MeshData
Methods
addFaces
addPoints
addPolyline
clear
getBackfacesEnabled
getFaceWinding
isManifold
setBackfacesEnabled
setFaceWinding
setManifold
MeshInstanceData
Constructors
constructor
Methods
clear
copy
getCreationFlags
getFaceColor
getInstanceName
getLineColor
getLineOpacity
getMatrix
getMeshId
getMeshKey
getOpacity
getOverlayIndex
getPointColor
getPointOpacity
getTransparency
setCreationFlags
setFaceColor
setInstanceName
setLineColor
setLineOpacity
setMatrix
setMeshId
setMeshKey
setOpacity
setOverlayIndex
setPointColor
setPointOpacity
setTransparency
MissingModelError
Constructors
constructor
Properties
Model
Methods
activateCADConfiguration
activateCADDefaultConfiguration
activateCADView
activateCadConfiguration
activateCadView
activateDefaultCadConfiguration
activateDefaultCadView
addPropertyToNode
cadConfigurationsEnabled
clear
clearNodeFaceVisibility
clearNodeLineVisibility
clearNodePointVisibility
computeMinimumBodyBodyDistance
computeMinimumFaceFaceDistance
computeMinimumFaceLineDistance
computeMinimumFaceRayDistance
createAndAddBody
createAndAddRepresentationItem
createCADView
createCadView
createImage
createMesh
createMeshInstance
createNode
createPMIInstance
createPart
createPmiInstance
deleteImages
deleteMeshInstances
deleteMeshes
deleteNode
getAbsoluteRootNode
getActiveCadConfiguration
getAssociatedModelKey
getBimIdConnectedElements
getBimIdFromNode
getBimIdRelatedElements
getBimIdRelatingElements
getBimIdsFromGenericId
getBimInfoFromBimId
getBranchVisibility
getCADActiveConfiguration
getCADConfigurations
getCADDefaultConfiguration
getCADViewPMIs
getCADViews
getCadConfigurations
getCadViewConfiguration
getCadViewMap
getCadViewPmis
getCadViews
getClientDimensions
getDataFromIds
getDataFromKeys
getDefaultCadConfiguration
getDefaultCadView
getEdgeAttributes
getEdgeCount
getEdgeProperty
getFaceAttributes
getFaceCount
getFaceProperty
getFilterName
getFilters
getFiltersWithNode
getGenericIdFromBimId
getGenericTypeIdMap
getGenericTypes
getIfcNodeIds
getIfcTypeByNodeId
getIfcTypes
getLayerIdsFromName
getLayerName
getLayers
getLooseBounding
getLowestAvailableNodeID
getLowestAvailableNodeId
getMeshIds
getMetallicRoughness
getModelBounding
getModelFileNameFromNode
getModelFileTypeFromNode
getNodeChildren
getNodeColorMap
getNodeEffectiveFaceColor
getNodeEffectiveLineColor
getNodeEffectivePointColor
getNodeExchangeId
getNodeFaceColor
getNodeFaceHighlighted
getNodeGenericId
getNodeGenericType
getNodeIDFromSCInstanceKey
getNodeIdFromBimId
getNodeIdOffset
getNodeIdsByGenericIds
getNodeIdsByIfcGuids
getNodeLayerId
getNodeLineColor
getNodeLineHighlighted
getNodeMatrix
getNodeMeshData
getNodeName
getNodeNetMatrix
getNodeParent
getNodePointColor
getNodePointHighlighted
getNodeProperties
getNodeRealBounding
getNodeType
getNodeUnitMultiplier
getNodeUserData
getNodeUserDataIndices
getNodeVisibility
getNodesBounding
getNodesByGenericType
getNodesByIfcType
getNodesCullingVectors
getNodesEffectiveFaceColor
getNodesEffectiveLineColor
getNodesEffectiveOpacity
getNodesEffectivePointColor
getNodesEffectiveTransparency
getNodesFaceColor
getNodesFromFiltersId
getNodesFromLayer
getNodesFromLayerName
getNodesFromLayers
getNodesHaveTransparency
getNodesHighlighted
getNodesInstancingSamePart
getNodesLineColor
getNodesOpacity
getNodesPointColor
getNodesTransparency
getOutOfHierarchy
getPMIColor
getPMIColorOverride
getPMISubtype
getPMIType
getPMIs
getPmiColor
getPmiColorOverride
getPmiSubtype
getPmiTopologyReferences
getPmiType
getPmis
getPointAttributes
getPrimaryModelId
getPrimaryModelKey
getRelationshipTypesFromBimId
getRootNode
getSCInstanceKey
getUniqueLayerNames
getUnitMultiplier
getViewAxes
getVisibilityState
hasDepthRange
hasEffectiveGenericType
isAnnotationView
isDrawing
isFaceMeasurable
isLineMeasurable
isMeasurable
isNodeLoaded
isWithinExternalModel
loadMeasurementFromFile
loadMeasurementFromJson
loadMeasurementFromString
loadSubtreeFromModel
loadSubtreeFromScsBuffer
loadSubtreeFromScsFile
loadSubtreeFromScsXmlBuffer
loadSubtreeFromScsXmlFile
loadSubtreeFromUrl
loadSubtreeFromXML
loadSubtreeFromXmlBuffer
loadSubtreeFromXmlFile
registerBimNodes
registerIfcNodes
replaceMesh
requestNodes
reset
resetModelHighlight
resetModelOpacity
resetModelTransparency
resetNodeMatrixToInitial
resetNodesColor
resetNodesOpacity
resetNodesTransform
resetNodesTransparency
resetNodesVisibility
setBehaviorInitiallyHidden
setBodyNodesVisibility
setDepthRange
setEdgeProperty
setEnableAutomaticUnitScaling
setFaceProperty
setInstanceModifier
setMeshLevel
setMetallicRoughness
setNodeFaceColor
setNodeFaceHighlighted
setNodeFaceVisibility
setNodeLineColor
setNodeLineHighlighted
setNodeLineVisibility
setNodeMatrix
setNodePointColor
setNodePointHighlighted
setNodePointVisibility
setNodesColors
setNodesCullingVector
setNodesFaceColor
setNodesHighlighted
setNodesLineColor
setNodesLinePattern
setNodesOpacities
setNodesOpacity
setNodesPointColor
setNodesTexture
setNodesTransparencies
setNodesTransparency
setNodesVisibilities
setNodesVisibility
setPMIColor
setPMIColorOverride
setPart
setPhysicalProperties
setPmiColor
setPmiColorOverride
setViewAxes
switchToModel
triangulatePolygon
unsetDepthRange
unsetMetallicRoughness
unsetNodeFaceColor
unsetNodeLineColor
unsetNodePointColor
unsetNodesCullingVectors
unsetNodesFaceColor
unsetNodesLineColor
unsetNodesLinePattern
unsetNodesPointColor
unsetNodesTexture
viewAxesHaveBeenSet
NavCube
Methods
disable
enable
getAnchor
getEnabled
getOverlayId
getPreserveModelUp
insideOverlay
onClickSelection
onMoveSelection
setAnchor
setPreserveModelUp
OperatorManager
Methods
clear
getOperator
indexOf
injectEvent
peek
pop
push
registerCustomOperator
remove
replaceOperator
set
size
unregisterCustomOperator
OverlayManager
Methods
addNodes
destroy
getViewportAnchor
getViewportPixelOffsetInCanvas
getViewportPixelPosition
getViewportPixelSize
maxIndex
setCamera
setViewport
setVisibility
ParseError
Constructors
constructor
Properties
PickConfig
Constructors
constructor
Properties
Methods
copy
PickOutsideCanvasError
Constructors
constructor
Properties
Plane
Properties
Methods
assign
copy
determineSide
distanceToPoint
equals
getCoefficients
intersectsRay
rayIntersection
setFromCoefficients
setFromPointAndNormal
setFromPoints
createFromCoefficients
createFromPointAndNormal
createFromPoints
Point2
Constructors
constructor
Properties
Methods
add
assign
copy
equals
forJson
length
scale
set
squaredLength
subtract
toJson
distance
fromJson
fromPoint3
zero
Point3
Constructors
constructor
Properties
Methods
add
assign
copy
equals
equalsWithTolerance
forJson
fromArray
isAxis
length
negate
normalize
scale
set
squaredLength
subtract
toArray
toJson
construct
createFromArray
cross
distance
dot
fromJson
zero
Point4
Constructors
constructor
Properties
Methods
assign
scale
set
zero
Ray
Constructors
constructor
Properties
Methods
assign
copy
negate
RefOnTopoItem
Properties
SelectionInvalidatedError
Constructors
constructor
Properties
SelectionManager
Properties
Methods
add
advanceIncrementalSelection
advanceVolumeSelection
beginConvexPolyhedronSelection
beginRayDrillSelection
beginScreenSelectByArea
beginSphereSelection
clear
contains
containsParent
each
endIncrementalSelection
endVolumeSelection
exportSelectionData
getFirst
getHighlightFaceElementSelection
getHighlightLineElementSelection
getHighlightNodeSelection
getHighlightPointElementSelection
getIgnoreEntityWhenTogglingChildSelection
getLast
getNodeElementSelectionColor
getNodeElementSelectionHighlightMode
getNodeElementSelectionOutlineColor
getNodeSelectionColor
getNodeSelectionHighlightMode
getNodeSelectionOutlineColor
getPickTolerance
getPruneSelectionDescendants
getResult
getResults
getSelectParentIfSelected
getSelectedLayers
getSelectedTypes
getSelectionFilter
getSingleEntityToggleModeEnabled
getSuppressImplicitRemovalCallback
isNodeSelected
isSelected
loadSelectionData
remove
selectAllFromPoint
selectAllFromRay
selectFromPoint
selectFromRay
selectLayer
selectNode
selectType
set
setHighlightFaceElementSelection
setHighlightLineElementSelection
setHighlightNodeSelection
setHighlightPointElementSelection
setIgnoreEntityWhenTogglingChildSelection
setNodeElementSelectionColor
setNodeElementSelectionHighlightMode
setNodeElementSelectionOutlineColor
setNodeSelectionColor
setNodeSelectionHighlightMode
setNodeSelectionOutlineColor
setPickTolerance
setPruneSelectionDescendants
setSelectParentIfSelected
setSelectionFilter
setSingleEntityToggleModeEnabled
setSuppressImplicitRemovalCallback
size
toggle
SheetManager
Constructors
constructor
Methods
deactivateSheets
endComparison
get3DNodes
getActiveSheetId
getBackgroundSelectionEnabled
getBackgroundSheetEnabled
getSheetBackgroundColor
getSheetColor
getSheetIds
getSheetShadowColor
isDrawingSheetActive
setActiveSheetId
setBackgroundSelectionEnabled
setBackgroundSheetEnabled
setSheetColors
startComparison
SnapshotConfig
Constructors
constructor
Properties
SubentityAttributes
Constructors
constructor
Properties
Methods
copy
SvgConfig
Properties
VerticalGradient
Constructors
constructor
Properties
View
Properties
Methods
addLight
advanceIncrementalSelection
advanceVolumeSelection
beginConvexPolyhedronSelection
beginRayDrillSelection
beginScreenSelectByArea
beginSphereSelection
centerCameraOnNode
clearLights
compositePickFromPoint
endComparison
endIncrementalSelection
endVolumeSelection
fitBounding
fitNodes
fitWorld
getAmbientLightColor
getAmbientOcclusionEnabled
getAmbientOcclusionRadius
getAntiAliasingMode
getAxisTriad
getBackfacesVisible
getBackgroundColor
getBloomEnabled
getBloomIntensityScale
getBloomLayers
getBloomThreshold
getBloomThresholdRampWidth
getBoundingCalculationIgnoresInvisible
getCamera
getCanvasSize
getDrawMode
getEyeDomeLightingBlurEdgeDistance
getEyeDomeLightingBlurInterval
getEyeDomeLightingBlurSamples
getEyeDomeLightingEnabled
getEyeDomeLightingOpacity
getEyeDomeLightingShadingEdgeDistance
getFaceVisibility
getFullCameraMatrix
getGoochBaseColorProminence
getGoochBlue
getGoochLuminanceShiftStrength
getGoochYellow
getGroundPlane
getHardEdgeColor
getHardEdgeOpacity
getHardEdgeThreshold
getHardEdgeThresholdRampWidth
getHardEdgesEnabled
getHiddenLineSettings
getImageBasedLightingEnabled
getImageBasedLightingIntensity
getImageBasedLightingOrientation
getInteractiveDrawLimitIncreaseEnabled
getLightingEnabled
getLineJitterEnabled
getLineJitterFrequency
getLineJitterInstanceCount
getLineJitterRadius
getLineVisibility
getNavCube
getPointShape
getPointSize
getProjectionMatrix
getProjectionMode
getSilhouetteColor
getSilhouetteEnabled
getSilhouetteOpacity
getSilhouetteThreshold
getSilhouetteThresholdRampWidth
getSimpleReflectionAttenuation
getSimpleReflectionBlurInterval
getSimpleReflectionBlurSamples
getSimpleReflectionEnabled
getSimpleReflectionFadeAngle
getSimpleReflectionOpacity
getSimpleShadowBlurInterval
getSimpleShadowBlurSamples
getSimpleShadowColor
getSimpleShadowEnabled
getSimpleShadowInteractiveUpdateEnabled
getSimpleShadowOpacity
getSimpleShadowResolution
getToonShadingBandCount
getToonShadingSpecularFactor
getViewMatrix
getViewOrientationCamera
isolateNodes
pickAllFromPoint
pickAllFromRay
pickFromPoint
pickFromRay
pointToWindowPosition
projectPoint
raycastFromPoint
removeLight
resetCamera
setAmbientLightColor
setAmbientOcclusionEnabled
setAmbientOcclusionRadius
setAntiAliasingMode
setBackfacesVisible
setBackgroundColor
setBloomEnabled
setBloomIntensityScale
setBloomLayers
setBloomThreshold
setBloomThresholdRampWidth
setBoundingCalculationIgnoresInvisible
setCamera
setDisplayIncompleteFrames
setDrawMode
setEyeDomeLightingBlurEdgeDistance
setEyeDomeLightingBlurInterval
setEyeDomeLightingBlurSamples
setEyeDomeLightingEnabled
setEyeDomeLightingOpacity
setEyeDomeLightingShadingEdgeDistance
setFaceVisibility
setGoochBaseColorProminence
setGoochBlue
setGoochLuminanceShiftStrength
setGoochYellow
setGroundPlane
setHardEdgeColor
setHardEdgeOpacity
setHardEdgeThreshold
setHardEdgeThresholdRampWidth
setHardEdgesEnabled
setImageBasedLightingEnabled
setImageBasedLightingEnvironment
setImageBasedLightingIntensity
setImageBasedLightingOrientation
setInitialCamera
setInteractiveDrawDelay
setInteractiveDrawLimitIncreaseEnabled
setLightingEnabled
setLineJitterEnabled
setLineJitterFrequency
setLineJitterInstanceCount
setLineJitterRadius
setLineVisibility
setPointShape
setPointSize
setPointVisibilityTest
setProjectionMode
setSilhouetteColor
setSilhouetteEnabled
setSilhouetteOpacity
setSilhouetteThreshold
setSilhouetteThresholdRampWidth
setSimpleReflectionAttenuation
setSimpleReflectionBlurInterval
setSimpleReflectionBlurSamples
setSimpleReflectionEnabled
setSimpleReflectionFadeAngle
setSimpleReflectionOpacity
setSimpleShadowBlurInterval
setSimpleShadowBlurSamples
setSimpleShadowColor
setSimpleShadowEnabled
setSimpleShadowInteractiveUpdateEnabled
setSimpleShadowOpacity
setSimpleShadowResolution
setStatisticsDisplayVisibility
setToonShadingBandCount
setToonShadingSpecularFactor
setTransparencyMode
setViewOrientation
setXRayColor
setXRayOpacity
setXRayTransparencyMode
startComparison
testPointVisibility
unprojectPoint
unsetXRayColor
updateCamera
updateLight
ViewAxes
Properties
VisibilityState
Constructors
constructor
Properties
WebViewer
Constructors
constructor
Properties
Methods
advanceExportToSvg
beginExportToSvg
closeConnection
deactivateSheets
delayCapping
endExportToSvg
endSheetComparison
exportToSvg
fitWorld
focusInput
getActiveSheetId
getAllowHighDPI
getAllowHighDpi
getBackgroundSelectionEnabled
getBackgroundSheetEnabled
getContextMenuStatus
getCreationParameters
getCuttingManager
getExplodeManager
getFormatVersionString
getLineManager
getMarkupManager
getMeasureManager
getMinimumFramerate
getModel
getOperatorManager
getOverlayManager
getRendererType
getSelectionManager
getSheetBackgroundColor
getSheetColor
getSheetIds
getSheetShadowColor
getStatistics
getStreamCutoffScale
getStreamingMode
getView
getViewElement
getViewerVersionString
isDrawingSheetActive
moveToWindow
pauseRendering
redraw
registerCustomOperator
reset
resetClientTimeout
resizeCanvas
resumeRendering
selectPart
setActiveSheetId
setAllowHighDPI
setAllowHighDpi
setBackgroundSelectionEnabled
setBackgroundSheetEnabled
setCallbacks
setClientTimeout
setContextMenuStatus
setMinimumFramerate
setServerRenderQuality
setSheetColors
setStreamCutoffScale
setViewOrientation
shutdown
start
startSheetComparison
takeSnapshot
trigger
triggerEvent
unregisterCustomOperator
unsetCallbacks
waitForIdle
XmlParseError
Constructors
constructor
Properties
Attribute
Methods
copy
getTitle
getType
getValue
BcfNode
Properties
BloomLayerInfo
Properties
CallbackMap
Properties
ComparisonConfig
Properties
CullingVector
Properties
DeprecatedPromise
Properties
Methods
catch
then
GetNodesBoundingConfig
Properties
GroundPlane
Properties
IdBooleanMap
IdColorMap
IdNumberMap
IdStringMap
ImageBasedLightingOrientation
Properties
ImageOptions
Properties
MarkupData
MeshDataCopy
Properties
MeshDataCopyElement
Properties
Methods
iterate
MeshDataCopyElementGroup
Properties
Methods
element
iterate
MeshDataCopyIterator
Methods
done
goTo
next
MeshDataCopyVertex
Properties
MetallicRoughnessValue
Properties
RelationshipInfo
Properties
StringStringMap
TextureOptions
Properties
UnitElement
Properties
WebViewerConfig
Properties
Type aliases
BCFCommentId
BCFMarkupName
BCFName
BCFTopicId
BCFViewpointName
BimId
BodyId
BuiltInOperatorId
CadViewId
Degrees
ExchangeId
ExternalModelName
FilterName
GenericId
GenericType
Guid
HtmlId
IfcGuid
IfcType
ImageId
LayerName
LightKey
LinePattern
MassageModelNameFunc
MeshId
MetaDataParseError
Milliseconds
ModelNameToScsFileFunc
NodeId
NodeIdOffset
OverlayIndex
PMISubType
PMITopoRef
PMIType
PartId
Pixels
PmiId
Radians
ScModelName
ScsBuffer
ScsUri
SelectionFilter
SheetId
Unreferenced
UserDataIndex
Uuid
VolumePickConfig
XmlFilename
Variables
Web Viewer Deprecated API
B
C
G
I
M
O
P
S
V
Data Import
Converter Command Line Options
Error Codes
Converter
Functions
C
E
G
I
L
O
S
W
~
Classes and Data Structures
C
E
I
L
P
R
S
V
Stream Cache C++
Namespaces
SC
std
TC
Files
sc_assemblytree.h
sc_store.h
sc_store_utils.h
sc_store_utils_text.h
Functions
A
B
C
D
E
F
G
I
L
M
N
O
P
Q
R
S
T
U
V
W
~
Classes and Data Structures
A
B
C
D
E
F
G
H
I
K
L
M
N
O
P
Q
R
S
T
U
V
W
Stream Cache Java
Servers
HOOPS Server REST API Reference
Stream Cache Server
Namespaces
SC
Files
sc_server.h
Functions
I
O
S
T
~
Classes and Data Structures
C
L
R
S
HOOPS Communicator
Communicator
StringStringMap
Previous
Next
StringStringMap
class
Communicator
.
StringStringMap
(
)
Object which maps a string to a string
