Logo

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
    • easy_convert.js
    • Running Converter programmatically
    • Viewing Stream Cache files
      • Interacting with the sample models
    • ESM header example
  • 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
        • Linux
        • Windows Server 2012 R2 / Windows Server 2008 R2 (Amazon EC2 GPU instance) [hardware accelerated graphics]
      • Amazon EC2 recommendations
      • Windows redistributables
      • Linux dependencies
      • Web Viewer

Tutorials

  • Environment Setup
    • Prerequisites
    • Development approach
    • Installing Node.js and using NPM
    • package.json
    • Copying the HOOPS Web Viewer JS 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
      • Project Setup
      • Instantiating the WebViewer
      • Setting the cameras
      • Adding the Navigation Cube and Axis Triad
      • Instancing
    • Loading models and geometry
      • Printing plane
    • Selection
      • Selection handles
    • Auto-arrange
    • Instancing
    • Loading additional models
  • 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

  • Fundamentals
    • Engineering Data
    • BIM Data
    • Visualization
    • Server Component
  • 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
    • Using HOOPS Web Components
      • Web Components Introduction
        • General Information
        • Introduction
        • Using Our Demo App
        • Development environment
      • Using the Web Components UI
        • Minimal setup
        • Adding a button
        • Using the model tree
        • HOOPS layout
      • Using the UI Kit with React
        • Project setup
        • Customizing appearance
        • Adding the model tree
    • 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
    • Operators
      • Standard operators
        • Overview
        • Built-in operators
        • Activating a predefined operator
        • Operator categories
      • Custom Operators
        • Registering an operator
        • Activating an operator
        • Event propagation
      • Geometry Handles
        • Introduction
        • Handle operator
    • 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
    • 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
        • Communicator.Matrix
        • 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
    • 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
    • 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
      • Using multiple views
        • API changes related to this feature
        • Limitations
      • 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 Visualize Web 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
      • Conversion Examples
        • Export to StreamCache
        • Export to PNG with custom camera
        • Export to PNG with pre-defined view
        • Export to shattered parts
        • Export to HTML with a template
        • Export to PDF with a template
      • License key
      • Linking to the Converter library
      • Customizing Converter
        • demo_converter
        • mini_converter
      • Example usage
      • Importing multiple files
    • Configuration Settings
  • Streaming Servers
    • Overview
      • Stream Cache Server
      • HOOPS Server
      • HTTP-Server
      • Rendering types
        • Client-Side Rendering (CSR)
        • Server-Side Rendering (SSR)
        • SCS - Single File Based Rendering
      • Using SSL
    • 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 cross-platform with PM2
        • Running as a Linux daemon
        • Running as a Windows service
        • 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
    • Custom I/O for Stream Cache
      • The abstract classes
      • Node SC server REST I/O
        • Usage with the Node server
        • The API
  • HOOPS Visualize Web 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
  • HOOPS Visualize Web 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
      • Spatial Relationships
      • IFC Layers
      • IFC GlobalID
      • IFC Walk Operator
    • Revit
    • DWG
      • Importing DWGs
      • Sheets
    • Federated models in BIM

API References

  • Web Viewer API Reference
    • Namespaces
      • Animation
        • Enumerations
        • Classes
        • Interfaces
        • Type Aliases
        • Functions
      • Bcf
        • Enumerations
        • Classes
        • Interfaces
        • Type Aliases
        • Variables
        • Functions
      • Bim
        • Enumerations
        • Interfaces
      • core
        • Index
        • References
      • Event
        • Classes
        • Functions
      • Floorplan
        • Enumerations
        • Classes
        • Functions
      • Markup
        • Namespaces
        • Classes
        • Interfaces
      • Operators
        • Namespaces
        • Classes
        • Interfaces
      • Overlay
        • Classes
      • Sc
        • Enumerations
        • Classes
        • Interfaces
        • Type Aliases
        • Variables
        • Functions
      • Selection
        • Enumerations
        • Classes
        • Interfaces
        • Type Aliases
        • Functions
      • Util
        • Enumerations
        • Classes
        • Interfaces
        • Type Aliases
        • Functions
    • Enumerations
      • AntiAliasingMode
        • AntiAliasingMode
        • Enumeration Members
      • AttributeType
        • AttributeType
        • Enumeration Members
      • Axis
        • Axis
        • Enumeration Members
      • BasicUnit
        • BasicUnit
        • Enumeration Members
      • BlurIntervalUnit
        • BlurIntervalUnit
        • Enumeration Members
      • BoundingPreviewMode
        • BoundingPreviewMode
        • Enumeration Members
      • BranchVisibility
        • BranchVisibility
        • Enumeration Members
      • BuiltinOverlayIndex
        • BuiltinOverlayIndex
        • Enumeration Members
      • Button
        • Button
        • Enumeration Members
      • Buttons
        • Buttons
        • Enumeration Members
      • CullingVectorSpace
        • CullingVectorSpace
        • Enumeration Members
      • DepthRange
        • DepthRange
        • Enumeration Members
      • DrawMode
        • DrawMode
        • Enumeration Members
      • DrawStrategy
        • DrawStrategy
        • Enumeration Members
      • ElementType
        • ElementType
        • Enumeration Members
      • EventType
        • EventType
        • Enumeration Members
      • FaceWinding
        • FaceWinding
        • Enumeration Members
      • FileType
        • FileType
        • Enumeration Members
      • FilterId
        • FilterId
      • FloorplanOrientation
        • FloorplanOrientation
        • Enumeration Members
      • HandleEventType
        • HandleEventType
        • Enumeration Members
      • HandleType
        • HandleType
        • Enumeration Members
      • ImageFormat
        • ImageFormat
        • Enumeration Members
      • InfoType
        • InfoType
        • Enumeration Members
      • InstanceModifier
        • InstanceModifier
        • Enumeration Members
      • KeyCode
        • KeyCode
        • Enumeration Members
      • KeyInputType
        • KeyInputType
        • Enumeration Members
      • KeyModifiers
        • KeyModifiers
        • Enumeration Members
      • LayerId
        • LayerId
      • LinePatternLengthUnit
        • LinePatternLengthUnit
        • Enumeration Members
      • MeshInstanceCreationFlags
        • MeshInstanceCreationFlags
        • Enumeration Members
      • MouseInputType
        • MouseInputType
        • Enumeration Members
      • NodeSource
        • NodeSource
        • Enumeration Members
      • NodeType
        • NodeType
        • Enumeration Members
      • OperatorId
        • OperatorId
        • Enumeration Members
      • OrbitFallbackMode
        • OrbitFallbackMode
        • Enumeration Members
      • OverlayAnchor
        • OverlayAnchor
        • Enumeration Members
      • OverlayUnit
        • OverlayUnit
        • Enumeration Members
      • PmiSubType
        • PmiSubType
        • Enumeration Members
      • PmiTopoRef
        • PmiTopoRef
        • Enumeration Members
      • PmiType
        • PmiType
        • Enumeration Members
      • PointShape
        • PointShape
        • Enumeration Members
      • PointSizeUnit
        • PointSizeUnit
        • Enumeration Members
      • Projection
        • Projection
        • Enumeration Members
      • RelationshipType
        • RelationshipType
        • Enumeration Members
      • RendererType
        • RendererType
        • Enumeration Members
      • ScreenConfiguration
        • ScreenConfiguration
        • Enumeration Members
      • SelectionHighlightMode
        • SelectionHighlightMode
        • Enumeration Members
      • SelectionMask
        • SelectionMask
        • Enumeration Members
      • SelectionMode
        • SelectionMode
        • Enumeration Members
      • SelectionType
        • SelectionType
        • Enumeration Members
      • SimpleReflectionAttenuationUnit
        • SimpleReflectionAttenuationUnit
        • Enumeration Members
      • SnapshotLayer
        • SnapshotLayer
        • Enumeration Members
      • StreamingMode
        • StreamingMode
        • Enumeration Members
      • TextureModifier
        • TextureModifier
        • Enumeration Members
      • TextureParameterization
        • TextureParameterization
        • Enumeration Members
      • TextureTiling
        • TextureTiling
        • Enumeration Members
      • TouchInputType
        • TouchInputType
        • Enumeration Members
      • TransparencyMode
        • TransparencyMode
        • Enumeration Members
      • TreeWalkMode
        • TreeWalkMode
        • Enumeration Members
      • ViewOrientation
        • ViewOrientation
        • Enumeration Members
      • WalkDirection
        • WalkDirection
        • Enumeration Members
      • WalkMode
        • WalkMode
        • Enumeration Members
      • XRayGroup
        • XRayGroup
        • Enumeration Members
    • Classes
      • AssemblyDataParseError
        • AssemblyDataParseError
        • Constructors
      • AxisTriad
        • AxisTriad
        • Methods
      • Box
        • Box
        • Constructors
        • Properties
        • Methods
      • Camera
        • Camera
        • Constructors
        • Methods
      • Color
        • Color
        • Constructors
        • Properties
        • Methods
      • CommunicatorError
        • CommunicatorError
        • Constructors
      • CuttingManager
        • CuttingManager
        • Methods
      • CuttingPlane
        • CuttingPlane
        • Constructors
        • Properties
        • Methods
      • CuttingSection
        • CuttingSection
        • Methods
      • DirectionalLight
        • DirectionalLight
        • Constructors
        • Properties
      • ExplodeManager
        • ExplodeManager
        • Methods
      • FaceFaceDistanceItem
        • FaceFaceDistanceItem
        • Constructors
        • Properties
      • FaceMeshData
        • FaceMeshData
        • Constructors
        • Properties
      • FilteredNodes
        • FilteredNodes
        • Constructors
        • Properties
      • IncrementalPickConfig
        • IncrementalPickConfig
        • Constructors
        • Properties
      • InternalLogicError
        • InternalLogicError
        • Constructors
      • InvalidIndexError
        • InvalidIndexError
        • Constructors
      • InvalidNodeIdError
        • InvalidNodeIdError
        • Constructors
        • Properties
      • InvalidNodeTypeError
        • InvalidNodeTypeError
        • Constructors
        • Properties
      • Light
        • Light
        • Constructors
        • Properties
      • LineManager
        • LineManager
        • Methods
      • LoadCancelledError
        • LoadCancelledError
        • Constructors
      • LoadError
        • LoadError
        • Constructors
      • LoadSubtreeConfig
        • LoadSubtreeConfig
        • Constructors
        • Properties
        • Methods
      • MarkupManager
        • MarkupManager
        • Accessors
        • Methods
      • MarkupTypeManager
        • MarkupTypeManager
        • Constructors
        • Methods
      • Matrix
        • Matrix
        • Constructors
        • Properties
        • Methods
      • MeasureManager
        • MeasureManager
        • Accessors
        • Methods
      • MeshData
        • MeshData
        • Constructors
        • Methods
      • MeshInstanceData
        • MeshInstanceData
        • Constructors
        • Properties
        • Methods
      • MissingModelError
        • MissingModelError
        • Constructors
      • Model
        • Model
        • Methods
      • NavCube
        • NavCube
        • Methods
      • OperatorManager
        • OperatorManager
        • Methods
      • ParseError
        • ParseError
        • Constructors
      • PickConfig
        • PickConfig
        • Constructors
        • Properties
        • Accessors
        • Methods
      • PickOutsideCanvasError
        • PickOutsideCanvasError
        • Constructors
      • Plane
        • Plane
        • Constructors
        • Properties
        • Methods
      • Point2
        • Point2
        • Constructors
        • Properties
        • Methods
      • Point3
        • Point3
        • Constructors
        • Properties
        • Methods
      • Point4
        • Point4
        • Constructors
        • Properties
        • Methods
      • PointLight
        • PointLight
        • Constructors
        • Properties
      • PointMeshData
        • PointMeshData
        • Constructors
        • Properties
      • PolylineMeshData
        • PolylineMeshData
        • Constructors
        • Properties
      • Ray
        • Ray
        • Constructors
        • Properties
        • Methods
      • RefOnTopoItem
        • RefOnTopoItem
        • Constructors
        • Properties
      • SelectionInvalidatedError
        • SelectionInvalidatedError
        • Constructors
      • SheetManager
        • SheetManager
        • Constructors
        • Methods
      • SnapshotConfig
        • SnapshotConfig
        • Constructors
        • Properties
      • SubentityAttributes
        • SubentityAttributes
        • Constructors
        • Properties
        • Methods
      • SvgConfig
        • SvgConfig
        • Constructors
        • Properties
      • VerticalGradient
        • VerticalGradient
        • Constructors
        • Properties
      • View
        • View
        • Properties
        • Accessors
        • Methods
      • ViewAxes
        • ViewAxes
        • Constructors
        • Properties
      • VisibilityState
        • VisibilityState
        • Constructors
        • Properties
      • WebViewer
        • WebViewer
        • Constructors
        • Properties
        • Accessors
        • Methods
      • XmlParseError
        • XmlParseError
        • Constructors
    • Interfaces
      • Attribute
        • Attribute
        • Methods
      • BloomLayerInfo
        • BloomLayerInfo
        • Properties
      • CallbackMap
        • CallbackMap
        • Properties
      • ComparisonConfig
        • ComparisonConfig
        • Properties
      • CullingVector
        • CullingVector
        • Properties
      • CuttingPlaneData
        • CuttingPlaneData
        • Properties
      • FaceFaceDistanceObject
        • FaceFaceDistanceObject
        • Properties
      • GetNodesBoundingConfig
        • GetNodesBoundingConfig
        • Properties
      • GroundPlane
        • GroundPlane
        • Properties
      • IAssemblyTree
        • IAssemblyTree
        • Methods
      • IBox
        • IBox
        • Properties
      • ICallbackManager
        • ICallbackManager
        • Methods
      • IColor
        • IColor
        • Properties
      • ICuttingManager
        • ICuttingManager
        • Methods
      • ICuttingSection
        • ICuttingSection
        • Methods
      • IdBooleanMap
        • IdBooleanMap
      • IdColorMap
        • IdColorMap
      • IdNumberMap
        • IdNumberMap
      • IdStringMap
        • IdStringMap
      • ImageBasedLightingOrientation
        • ImageBasedLightingOrientation
        • Properties
      • ImageOptions
        • ImageOptions
        • Properties
      • IMaterial
        • IMaterial
        • Properties
      • IModel
        • IModel
        • Methods
      • IModelStructure
        • IModelStructure
        • Methods
      • IPoint2
        • IPoint2
        • Properties
      • IPoint3
        • IPoint3
        • Properties
      • IPoint4
        • IPoint4
        • Properties
      • IRay
        • IRay
        • Properties
      • IScEngine
        • IScEngine
        • Methods
      • IView
        • IView
        • Properties
        • Methods
      • IWebViewer
        • IWebViewer
        • Properties
        • Methods
      • MarkupData
        • MarkupData
      • MeshDataCopy
        • MeshDataCopy
        • Properties
      • MeshDataCopyElement
        • MeshDataCopyElement
        • Properties
        • Methods
      • MeshDataCopyElementGroup
        • MeshDataCopyElementGroup
        • Properties
        • Methods
      • MeshDataCopyIterator
        • MeshDataCopyIterator
        • Methods
      • MeshDataCopyVertex
        • MeshDataCopyVertex
        • Properties
      • MetallicRoughnessValue
        • MetallicRoughnessValue
        • Properties
      • ObjectConstructor
        • ObjectConstructor
        • Methods
      • RelationshipInfo
        • RelationshipInfo
        • Properties
      • SimpleReflectionAttenuation
        • SimpleReflectionAttenuation
        • Properties
      • StringStringMap
        • StringStringMap
      • TextureOptions
        • TextureOptions
        • Properties
      • UnitElement
        • UnitElement
        • Properties
      • ViewConfig
        • ViewConfig
        • Properties
      • WebViewerConfig
        • WebViewerConfig
        • Properties
    • Type Aliases
      • BimId
        • BimId
      • BodyId
        • BodyId
      • BuiltInOperatorId
        • BuiltInOperatorId
      • CadViewId
        • CadViewId
      • Degrees
        • Degrees
      • ExchangeId
        • ExchangeId
      • ExternalModelName
        • ExternalModelName
      • FilterName
        • FilterName
      • GenericId
        • GenericId
      • GenericType
        • GenericType
      • HtmlId
        • HtmlId
      • ImageId
        • ImageId
      • LayerName
        • LayerName
      • LightKey
        • LightKey
      • LinePattern
        • LinePattern
      • MassageModelNameFunc
        • MassageModelNameFunc
      • MaterialParam
        • MaterialParam
      • Matrix12
        • Matrix12
      • Matrix16
        • Matrix16
      • Matrix9
        • Matrix9
      • MeshId
        • MeshId
      • ModelNameToScsFileFunc
        • ModelNameToScsFileFunc
      • NodeDrawMode
        • NodeDrawMode
      • NodeId
        • NodeId
      • NodeIdOffset
        • NodeIdOffset
      • PartId
        • PartId
      • Pixels
        • Pixels
      • PmiId
        • PmiId
      • Radians
        • Radians
      • Rgbas
        • Rgbas
      • ScsUri
        • ScsUri
      • SheetId
        • SheetId
      • UserDataIndex
        • UserDataIndex
      • Uuid
        • Uuid
      • Uvs
        • Uvs
      • Vector3
        • Vector3
      • Vector3s
        • Vector3s
      • Vector4
        • Vector4
      • Vector4s
        • Vector4s
      • XmlFilename
        • XmlFilename
      • XRayTransparencyMode
        • XRayTransparencyMode
    • Variables
      • DefaultTransitionDuration
        • DefaultTransitionDuration
      • EmptyModelName
        • EmptyModelName
      • InvalidNodeId
        • InvalidNodeId
      • NoOverrideDrawMode
        • NoOverrideDrawMode
      • Ohm
        • Ohm
      • Subscript1
        • Subscript1
      • Subscript2
        • Subscript2
      • Subscript3
        • Subscript3
      • SubscriptNeg
        • SubscriptNeg
    • Functions
      • closestPointFromPointToSegment
        • closestPointFromPointToSegment
      • closestPointScalarFromPointToSegment
        • closestPointScalarFromPointToSegment
      • computeAngleBetweenVector
        • computeAngleBetweenVector
      • computeOffaxisRotation
        • computeOffaxisRotation
      • computePointToLineDistance
        • computePointToLineDistance
      • createUuid
        • createUuid
      • degreesToRadians
        • degreesToRadians
      • distanceLineLine
        • distanceLineLine
      • formatWithUnit
        • formatWithUnit
      • generateArcPoints
        • generateArcPoints
      • generatePointsOnCircle
        • generatePointsOnCircle
      • get3dBaseFromVector
        • get3dBaseFromVector
      • getLongUnitString
        • getLongUnitString
      • getOrthogonalVector
        • getOrthogonalVector
      • intersect3d2Planes
        • intersect3d2Planes
      • intersectionPlaneLine
        • intersectionPlaneLine
      • intersectionPlaneLine2
        • intersectionPlaneLine2
      • isIColor
        • isIColor
      • isIPoint2
        • isIPoint2
      • isIPoint3
        • isIPoint3
      • isIPoint4
        • isIPoint4
      • isPointInRect2d
        • isPointInRect2d
      • isPointOnLineSegment
        • isPointOnLineSegment
      • isPointOnLineSegment2d
        • isPointOnLineSegment2d
      • lineLineIntersect
        • lineLineIntersect
      • oneVectorCross
        • oneVectorCross
      • radiansToDegrees
        • radiansToDegrees
      • sortVerticesCounterClockwise
        • sortVerticesCounterClockwise
    • References
      • BimMask
      • Milliseconds
      • OverlayId
      • OverlayIndex
      • ScModelName
      • ScsBuffer
      • TextureFlags
      • ViewKey
  • Web Components Reference
    • Viewer and Utilities Tags
    • UI Kit Tags
    • React Adapters
    • Services
  • Data Import
    • Converter Application
      • 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_io.h
        • sc_store.h
        • sc_store_utils.h
        • sc_store_utils_text.h
      • Functions
        • A
        • B
        • C
        • D
        • E
        • F
        • G
        • H
        • 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
        • S

Additional Resources

  • Release Notes
    • HOOPS Visualize Web 2025.8.0
      • Technology Update
      • Package Changes
      • Enhancements
      • API Changes
      • Fixed Bugs
    • HOOPS Visualize Web 2025.7.0
      • Package Changes
        • Package Name Change
      • Enhancements
        • WebViewer Updates
      • Fixed Bugs
    • HOOPS Communicator 2025.6.1
      • Package Changes
    • HOOPS Communicator 2025.6.0
      • API Changes
      • Enhancements
        • WebViewer Updates
      • Fixed Bugs
    • HOOPS Communicator 2025.5.1
      • Package Changes
    • HOOPS Communicator 2025.5.0
      • Enhancements
        • WebViewer Updates
      • Fixed Bugs
    • HOOPS Communicator 2025.4.1
      • Package Changes
    • HOOPS Communicator 2025.4.0
      • Technology Updates
        • Functional Changes
        • Third-Party Library Updates
      • Enhancements
      • Fixed Bugs
    • HOOPS Communicator 2025.3.1
      • Package Changes
    • HOOPS Communicator 2025.3.0
      • Technology Update
        • Platform Changes
      • Enhancements
      • Fixed Bugs
    • HOOPS Communicator 2025.2.0
      • Enhancements
      • Fixed Bugs
    • HOOPS Communicator 2025.1.0
      • Package Changes
      • Enhancements
        • Fixed Bugs
    • HOOPS Communicator 2024.8.0
      • Enhancements
      • Documentation Changes
        • HOOPSY
      • Fixed Bugs
    • HOOPS Communicator 2024.7.1
      • Technology Update
    • HOOPS Communicator 2024.7.0
      • Enhancements
      • API Changes
      • Fixed Bugs
    • HOOPS Communicator 2024.6.1
      • Fixed Bugs
    • HOOPS Communicator 2024.6.0
      • Enhancements
      • API Changes
      • Fixed Bugs
    • HOOPS Communicator 2024.5.0
      • Functional Changes
      • Fixed Bugs
    • HOOPS Communicator 2024.4.0
      • Enhancements
      • Functional Changes
      • Deprecation
      • API Changes
      • Fixed Bugs
      • Documentation Update
    • HOOPS Communicator 2024.3.1
      • Fixed Bugs
    • HOOPS Communicator 2024.3.0
      • Fixed Bugs
    • HOOPS Communicator 2024.2.0
      • Enhancements
      • Functional Changes
      • Documentation Updates
      • Fixed Bugs
    • HOOPS Communicator 2024.1.0
      • Enhancements
      • Functional Changes
      • Fixed Bugs
    • HOOPS Communicator 2024
      • Enhancements
      • Fixed bugs
    • HOOPS Communicator 2023 SP2 U2
      • Enhancements
      • Fixed Bugs
    • HOOPS Communicator 2023 SP2 U1
      • Enhancements
      • Fixed Bugs
    • HOOPS Communicator 2023 SP2
      • Fixed Bugs
    • HOOPS Communicator 2023 SP1 U11
      • Fixed Bugs
    • HOOPS Communicator 2023 SP1 U1
      • Enhancements
      • Fixed Bugs
    • HOOPS Communicator 2023 SP1
      • Enhancements
      • Fixed Bugs
    • HOOPS Communicator 2023 U1
      • Enhancements
      • Fixed bugs
    • HOOPS Communicator 2023
      • Enhancements
      • Fixed bugs
    • HOOPS Communicator 2022 SP2 U1
      • Enhancements
      • Fixed bugs list
    • HOOPS Communicator 2022 SP2
      • Update supported formats
      • Enhancements
      • Fixed bugs list
    • HOOPS Communicator 2022 SP1 U1
      • Functional changes
      • Fixed bugs list
    • HOOPS Communicator 2022 SP1
      • Update supported formats
      • Enhancements
      • Functional changes
      • Fixed bugs list
    • HOOPS Communicator 2022 U1
      • Update supported formats
      • Fixed bugs list
    • HOOPS Communicator 2022
      • Update supported formats
      • Enhancements
      • Functional changes
      • Fixed bugs list
    • HOOPS Communicator 2021 SP2 U2
      • Update supported formats
      • Enhancements
      • Functional changes
      • Fixed bugs list
    • HOOPS Communicator 2021 SP2 U1
      • Update supported formats
      • Enhancements
      • Fixed bugs list
    • HOOPS Communicator 2021 SP2
      • Update supported formats
      • Enhancements
      • Functional changes
      • Fixed bugs list
    • HOOPS Communicator 2021 SP1 U1
      • Update supported formats
      • Enhancements
      • Fixed bugs
    • HOOPS Communicator 2021 SP1
      • Update supported formats
      • Enhancements
      • Functional changes
      • Fixed bugs
    • HOOPS Communicator 2021 U1
      • Fixed bugs list
    • HOOPS Communicator 2021
      • Enhancements
      • Fixed bugs
  • Public Roadmap
  • Frequently Asked Questions
  • License Key
    • Evaluation license
    • Commercial license
    • Updating your license
  • Acknowledgments
    • 3Dconnexion 0.6.1
    • base64.h 1.0
    • Boost 1.57
    • Bowser 1.x.x
    • canvg 1.4
    • Clipper2 6.4.2
    • Commander.js 2.20.3
    • Eigen 3.2
    • Express 4.21.2
    • FileSaver.js 2.0.0
    • html2canvas-pro 1.5.8
    • iScroll 5.2.0
    • jQuery 3.5.1
    • jQuery-minicolors 2.2.3
    • jQuery UI 1.11.4
    • jQuery-ui-touchpunch 0.2.3
    • js-base64 1.3
    • jsziptools 2.10.1
    • keymaster 1.6.2
    • KTX 4.4.0
    • LambdaOptions 1.0
    • libcurl 8.4
    • EGL 1.5
    • libglvnd 2.1.0
    • libjpeg-turbo 1.4.0
    • libpng 1.6.37
    • libwebsockets 2.0.1
    • LZ4 r127
    • mobile-detect-js 0.2.3
    • morgan 1.9.1
    • node-http-proxy 1.18.1
    • NoWide 2.6
    • OpenSSL 3.0.9
    • promise-polyfill 2.1.0
    • pugixml 1.13
    • rapidJSON 1.0
    • rapidXML 1.13
    • SDL2 2.0.10
    • STB Image 2.26
    • uuid 3.3.3
    • v8 v8-7.8.279
    • v8pp v8pp-1.5.1
    • winston 3.2.1
    • zlib 1.3.1
    • Zstandard 1.4.5
  • Package Description
  • Downloads
  • Archives
    • 2025
    • 2024
    • 2023
    • 2022
    • 2021
    • 2020
    • 2019
    • 2018
    • 2017
    • 2016
    • 2015
    • 2

Support

  • Developer Support
  • Knowledge Base
  • Community Forum
  • Contact Us
HOOPS Visualize Web
  • @ts3d-hoops/web-viewer
  • Util
Previous Next

Util

Enumerations

  • TimerIdleType

Classes

  • ActionQueue
  • CurrentAction
  • Lazy
  • StateMachine
  • Timer

Interfaces

  • OpenPromise
  • StateMachineAction
  • TrackedOpenPromise
  • UnsafePromise

Type Aliases

  • Action
  • ActionLike
  • ActionResult
  • LazyLike
  • StateReducer

Functions

  • _timerStressTest
  • copyMap
  • copySet
  • createCylinderMeshDataFromArc
  • createOpenPromise
  • createTrackedOpenPromise
  • createUnsafePromise
  • delayCall
  • exchangeIdEqual
  • filterInPlace
  • generateConeCylinderMeshData
  • generateSphereMeshData
  • isCircleElement
  • isFace
  • isLineElement
  • isOtherEdgeElement
  • isPlaneElement
  • setSubtraction
  • setToArray
  • sleep
  • toSet
  • TypeAssert
  • TypeAssertNever
  • waitForAll
Previous Next

© Copyright 2025, Tech Soft 3D

Welcome Conversation saved
HOOPSY BETA

Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Visualize Web or choose a sample question below to start a conversation:

What is HOOPS Visualize Web?
What are the latest release notes for HOOPS Visualize Web?
How do I start evaluating HOOPS Visualize Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...
Return to top