Logo
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]
        • Generic Linux Server
        • Ubuntu 14.04 Server Edition (Amazon EC2 GPU Instance) [hardware accelerated graphics]
        • Ubuntu 14.04 Server Edition (Physical machine) [hardware accelerated graphics]
        • Ubuntu 14.04 Server Edition (Virtual machine)
        • Windows Server 2012 R2 / Windows Server 2008 R2 (Amazon EC2 GPU instance) [hardware accelerated graphics]
      • 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
      • 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

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 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
      • Materials
        • 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
    • HOOPS Server
      • Basic Setup
        • Editing the quick start configuration file
        • Starting the Server
        • Viewing models and monitoring the system
        • Stopping the server
      • Configuration
        • Overview of HOOPS Server
        • Configuration file format
        • Server communication
        • Server ports
        • File system paths
        • Optional HTTP file server
        • Configurable settings
      • Machine Setup
        • Windows-specific
        • Linux-specific
        • Network configuration
      • Advanced Setup
        • Startup configuration
        • Manually starting the HOOPS Server
        • Starting with npm
        • Starting with the NodeJS runtime
        • Running as a background process
        • Running as a Windows service
        • Running as a Linux daemon
        • Running cross-platform with PM2
        • Modifying the HOOPS Server source code
      • Deployment Scenarios
        • Components
        • Deployment configurations
      • Monitoring and troubleshooting
        • Quick Start
      • Amazon EC2 Quick Start
        • Provisioning an instance
        • Installing the package on Ubuntu Server
        • Installing the package on Windows Server
    • Stream Cache Server
      • Liveliness Pinging
      • Command line options
      • Library
        • Overview
        • Building your application
        • Using the library
        • Working example
        • Configuration callbacks
        • Configuration settings reference
      • Stream Cache server application executable
    • 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
    • BCF Format
      • Overview
      • BCF API
        • BCFManager
        • BCFData
        • BCFTopic
        • BCFMarkup
        • BCFSnapshot
        • BCFViewpoint
      • BCF import
      • Interacting with BCF data
      • BCF export
      • Callbacks
    • Floorplan 2D
      • Configuration
        • Changing background and avatar color
        • Camera tracking
        • Floorplan orientation
        • Auto activation mode
        • Avatar mesh
      • Floorplan operator
    • Supported formats
      • IFC
    • IFC types
    • IFC layers
    • IFC GlobalID
    • IFC Walk Operator
      • Revit
      • DWG
    • Importing DWGs
    • Sheets
    • Federated models in BIM

API References

  • Viewing
    • Communicator
      • Animation
        • Util
        • CameraProperty
        • InterpolationType
        • KeyType
        • NodeProperty
        • PlayerState
        • Animation
        • BatchedCameraValues
        • BatchedNodeValues
        • BatchedValues
        • CameraChannel
        • KeyframeBuffer
        • Manager
        • NodeChannel
        • Player
        • Sampler
        • ColorPosition
        • Type aliases
        • Functions
      • Event
        • InputEvent
        • KeyInputEvent
        • MouseInputEvent
        • MouseInputEventBase
        • MouseWheelInputEvent
        • NodeSelectionEvent
        • TouchInputEvent
        • Functions
      • GUID
        • Functions
      • Markup
        • Line
        • Measure
        • Note
        • Redline
        • Shape
        • MarkupItem
        • MarkupView
        • MarkupRenderer
      • Operator
        • MeasurePolygonAreaAnchor
        • MeasurePolylineDistanceAnchor
        • AreaSelectionOperator
        • AxisTriadOperator
        • CameraKeyboardWalkOperator
        • CameraNavigationOperator
        • CameraOrbitOperator
        • CameraPanOperator
        • CameraTurntableOperator
        • CameraWalkModeOperator
        • CameraWalkOperator
        • CameraWindowZoomOperator
        • CameraZoomOperator
        • FloorplanOperator
        • HandleOperator
        • MeasureBodyBodyDistanceOperator
        • MeasureEdgeLengthOperator
        • MeasureFaceFaceAngleOperator
        • MeasureFaceFaceDistanceOperator
        • MeasureLineLineAngleOperator
        • MeasurePointPointDistanceOperator
        • MeasurePolygonAreaOperator
        • MeasurePolylineDistanceOperator
        • NavCubeOperator
        • NoteOperator
        • RayDrillSelectionOperator
        • RedlineCircleOperator
        • RedlinePolylineOperator
        • RedlineRectangleOperator
        • RedlineTextOperator
        • SelectionOperator
        • SpaceMouseOperator
        • Operator
      • Selection
        • CompositeSelectionItem
        • FaceEntity
        • IncrementalSelectionId
        • LineEntity
        • PointEntity
        • SelectionItem
        • EntitySelectionItem
        • FaceSelectionItem
        • LineSelectionItem
        • NodeEntitySelectionItem
        • NodeSelectionItem
        • PointSelectionItem
        • Type aliases
      • Settings
        • HiddenLineSettings
      • StaticGenericType
        • Variables
      • SubentityProperties
        • EdgeType
        • FaceType
        • Blend01Element
        • Blend02Element
        • Blend03Element
        • CircleElement
        • ConeElement
        • CylinderElement
        • CylindricalElement
        • ExtrusionElement
        • FromCurvesElement
        • LineElement
        • NurbsElement
        • OffsetElement
        • OtherEdgeElement
        • OtherFaceElement
        • PipeElement
        • PlaneElement
        • RevolutionElement
        • RuledElement
        • SphereElement
        • TorusElement
        • TransformElement
        • Type aliases
      • UUID
        • Functions
      • Util
        • OpenPromise
        • TimerIdleType
        • ActionQueue
        • CurrentAction
        • CurrentActionSync
        • IncrementalSelection
        • Lazy
        • StateMachine
        • Timer
        • Type aliases
        • Functions
      • AntiAliasingMode
        • Enumeration members
      • AttributeType
        • Enumeration members
      • Axis
        • Enumeration members
      • BCFFileType
        • Enumeration members
      • BCFVersion
        • Enumeration members
      • BasicUnit
        • Enumeration members
      • BimMask
        • Enumeration members
      • BlurIntervalUnit
        • Enumeration members
      • BoundingPreviewMode
        • Enumeration members
      • BranchVisibility
        • Enumeration members
      • BuiltinOverlayIndex
        • Enumeration members
      • Button
        • Enumeration members
      • Buttons
        • Enumeration members
      • CullingVectorSpace
        • Enumeration members
      • DrawMode
        • Enumeration members
      • ElementType
        • Enumeration members
      • EventType
        • Enumeration members
      • FaceWinding
        • Enumeration members
      • FileType
        • Enumeration members
      • FilterId
      • FloorplanAutoActivation
        • Enumeration members
      • FloorplanOrientation
        • Enumeration members
      • HandleEventType
        • Enumeration members
      • HandleType
        • Enumeration members
      • ImageFormat
        • Enumeration members
      • InfoType
        • Enumeration members
      • InstanceModifier
        • Enumeration members
      • KeyCode
        • Enumeration members
      • KeyInputType
        • Enumeration members
      • KeyModifiers
        • Enumeration members
      • LayerId
      • LightSpace
        • Enumeration members
      • LightType
        • Enumeration members
      • LinePatternLengthUnit
        • Enumeration members
      • MeshInstanceCreationFlags
        • Enumeration members
      • MouseInputType
        • Enumeration members
      • NodeSource
        • Enumeration members
      • NodeType
        • Enumeration members
      • OperatorId
        • Enumeration members
      • OrbitFallbackMode
        • Enumeration members
      • OverlayAnchor
        • Enumeration members
      • OverlayUnit
        • Enumeration members
      • PmiSubType
        • Enumeration members
      • PmiTopoRef
        • Enumeration members
      • PmiType
        • Enumeration members
      • PointShape
        • Enumeration members
      • PointSizeUnit
        • Enumeration members
      • Projection
        • Enumeration members
      • RelationshipType
        • Enumeration members
      • RendererType
        • Enumeration members
      • ScreenConfiguration
        • Enumeration members
      • SelectionHighlightMode
        • Enumeration members
      • SelectionMask
        • Enumeration members
      • SelectionMode
        • Enumeration members
      • SelectionType
        • Enumeration members
      • SimpleReflectionAttenuationUnit
        • Enumeration members
      • SnapshotLayer
        • Enumeration members
      • StreamingMode
        • Enumeration members
      • TextureModifier
        • Enumeration members
      • TextureParameterization
        • Enumeration members
      • TextureTiling
        • Enumeration members
      • TouchInputType
        • Enumeration members
      • TransparencyMode
        • Enumeration members
      • TreeWalkMode
        • Enumeration members
      • ViewOrientation
        • Enumeration members
      • WalkDirection
        • Enumeration members
      • WalkMode
        • Enumeration members
      • XRayGroup
        • Enumeration members
      • XRayTransparencyMode
        • Enumeration members
      • AssemblyDataParseError
        • Constructors
        • Properties
      • AxisTriad
        • Methods
      • BCFComment
        • Constructors
        • Methods
      • BCFData
        • Constructors
        • Methods
      • BCFManager
        • Constructors
        • Methods
      • BCFMarkup
        • Constructors
        • Methods
      • BCFMarkupHeaderFile
        • Constructors
        • Methods
      • BCFMarkupViewpoint
        • Constructors
        • Methods
      • BCFSnapshot
        • Constructors
        • Methods
      • BCFTopic
        • Constructors
        • Methods
      • BCFViewpoint
        • Constructors
        • Methods
      • Box
        • Constructors
        • Properties
        • Methods
      • Camera
        • Methods
      • Color
        • Constructors
        • Properties
        • Methods
      • CommunicatorError
        • Constructors
        • Properties
      • CuttingManager
        • Methods
      • CuttingSection
        • Methods
      • ExplodeManager
        • Methods
      • FaceFaceDistanceItem
        • Properties
      • FilteredNodes
        • Constructors
        • Properties
      • FloorplanConfig
        • Properties
        • Methods
      • FloorplanManager
        • Methods
      • IncrementalPickConfig
        • Constructors
        • Properties
      • InternalLogicError
        • Constructors
        • Properties
      • InvalidIndexError
        • Constructors
        • Properties
      • InvalidNodeIdError
        • Constructors
        • Properties
      • InvalidNodeTypeError
        • Constructors
        • Properties
      • Light
        • Constructors
        • Properties
      • LineManager
        • Methods
      • LoadCancelledError
        • Constructors
        • Properties
      • LoadError
        • Constructors
        • Properties
      • LoadSubtreeConfig
        • Properties
        • Methods
      • MarkupManager
        • Methods
      • MarkupTypeManager
        • Methods
      • Matrix
        • Constructors
        • Properties
        • Methods
      • MeasureManager
        • Methods
      • MeshData
        • Methods
      • MeshInstanceData
        • Constructors
        • Methods
      • MissingModelError
        • Constructors
        • Properties
      • Model
        • Methods
      • NavCube
        • Methods
      • OperatorManager
        • Methods
      • OverlayManager
        • Methods
      • ParseError
        • Constructors
        • Properties
      • PickConfig
        • Constructors
        • Properties
        • Methods
      • PickOutsideCanvasError
        • Constructors
        • Properties
      • Plane
        • Properties
        • Methods
      • Point2
        • Constructors
        • Properties
        • Methods
      • Point3
        • Constructors
        • Properties
        • Methods
      • Point4
        • Constructors
        • Properties
        • Methods
      • Ray
        • Constructors
        • Properties
        • Methods
      • RefOnTopoItem
        • Properties
      • SelectionInvalidatedError
        • Constructors
        • Properties
      • SelectionManager
        • Properties
        • Methods
      • SheetManager
        • Constructors
        • Methods
      • SnapshotConfig
        • Constructors
        • Properties
      • SubentityAttributes
        • Constructors
        • Properties
        • Methods
      • SvgConfig
        • Properties
      • VerticalGradient
        • Constructors
        • Properties
      • View
        • Properties
        • Methods
      • ViewAxes
        • Properties
      • VisibilityState
        • Constructors
        • Properties
      • WebViewer
        • Constructors
        • Properties
        • Methods
      • XmlParseError
        • Constructors
        • Properties
      • Attribute
        • Methods
      • BcfNode
        • Properties
      • BloomLayerInfo
        • Properties
      • CallbackMap
        • Properties
      • ComparisonConfig
        • Properties
      • CullingVector
        • Properties
      • DeprecatedPromise
        • Properties
        • Methods
      • GetNodesBoundingConfig
        • Properties
      • GroundPlane
        • Properties
      • IdBooleanMap
      • IdColorMap
      • IdNumberMap
      • IdStringMap
      • ImageBasedLightingOrientation
        • Properties
      • ImageOptions
        • Properties
      • MarkupData
      • MeshDataCopy
        • Properties
      • MeshDataCopyElement
        • Properties
        • Methods
      • MeshDataCopyElementGroup
        • Properties
        • Methods
      • MeshDataCopyIterator
        • Methods
      • 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
    • ObjectConstructor
      • Methods
        • setPrototypeOf
    • Variables
  • Data Import
    • Converter Command Line Options
      • Error Codes
    • Converter
      • File List
        • libconverter.h
      • Classes and Data Structures
        • C
        • E
        • I
        • S
      • Functions
        • C
        • E
        • G
        • I
        • L
        • O
        • S
        • W
        • ~
    • Stream Cache C++
      • File List
        • sc_assemblytree.h
        • sc_store.h
        • sc_store_utils.h
        • sc_store_utils_text.h
      • Classes and Data Structures
        • A
        • B
        • C
        • D
        • E
        • F
        • G
        • I
        • K
        • L
        • M
        • N
        • P
        • R
        • S
        • T
        • U
        • V
      • Functions
        • A
        • B
        • C
        • D
        • E
        • F
        • G
        • I
        • L
        • M
        • N
        • O
        • P
        • Q
        • R
        • S
        • T
        • U
        • V
        • W
        • ~
    • Stream Cache Java
      • File List
        • SC.java
      • Classes
        • com::techsoft3d::communicator::authoring::SC
      • Functions
        • A
        • C
        • D
        • E
        • M
        • N
        • P
        • T
  • Servers
    • HOOPS Server REST API Reference
    • Stream Cache Server
      • File List
        • sc_server.h
      • Classes and Data Structures
        • :
      • Functions
        • I
        • O
        • S
        • T
        • ~
HOOPS Communicator
  • <no title>
Next

Getting Started

  • Technical Overview
  • Quickstart
  • Package Description
  • Supported Formats
  • Supported Platforms
  • Contact
  • License key
  • Frequently asked questions
  • Acknowledgements
  • Knowledge Base
  • Support
  • Downloads
  • Community Forum
  • Release notes
  • Public Roadmap

Tutorials

  • Environment setup
  • Building a basic application
  • Additive manufacturing
  • Inventory management
  • Product configurator
  • Build a streaming service

Programming Guide

  • Docker Support
    • Basic configuration
  • Viewing
    • Basic Setup
    • Configuration
    • Callbacks
    • Performance
    • Selection and picking
    • Animation
    • Operators
    • Scene Attributes
    • Model Attributes
    • Geometry
    • Markup
    • Data Model
    • Miscellaneous Topics
  • Data Import
    • Authoring
    • Converter Application
    • Converter Library
  • Servers
    • HOOPS Server
    • Stream Cache Server
    • Stream Cache Server
    • HOOPS Server
    • HTTP-Server
    • Rendering types
  • Communicator for MCAD
    • CAD Views
    • PMI
    • Metadata
    • Configurations
  • Communicator for BIM
    • BCF Format
    • Floorplan 2D
    • Supported formats
    • IFC types
    • IFC layers
    • IFC GlobalID
    • IFC Walk Operator
    • Importing DWGs
    • Sheets
    • Federated models in BIM

API References

  • Viewing
    • Variables
  • Data Import
    • Converter Command Line Options
    • Converter
    • Stream Cache C++
    • Stream Cache Java
  • Servers
    • HOOPS Server REST API Reference
    • Stream Cache Server
Next

© Copyright 2022, Tech Soft 3D

Built with Sphinx using a theme provided by Read the Docs.
Return to top