HOOPS Communicator Documentation

API Search || Global Search

Search

Preparing search index...
The search index is not available

Menu

Getting Started

Technical Overview
Quickstart
Package Description
Supported Formats
Supported Platforms
Contact
License Key
FAQ
Acknowledgements

Tutorials

Building A Basic App

1. Introduction
2. Project Layou
3. Hello, Web Viewer
4. Custom Operator Basics
5. Advanced Operator Concepts
6. Interacting with the Model Tree
7. Color and Transparency
8. Geometry Creation and Textures
9. Model Loading and Aggregation
10. Connection to the HOOPS Server

Additive Manufacturing

1. Introduction
2. Project Layout
3. Setting up Views
4. Creating the Printing Plane
5. Setting the Selection Callback
6. Adding a Handles Operator
7. Syncing Multiple Views
8. The Auto-Arrange Function
9. The Instance Operator
10. Adding Additional Models

Inventory Management

1. Introduction
2. Project Layout
3. The Model XML File
4. Setting up the Main Viewer
5. Loading Models
6. Linking to Application Data
7. Creating the Display Filter
8. Adding Color Gradients
9. Adding the UI Event Listeners

Product Configurator

1. Introduction
2. Project Layout
3. Setting up the Viewers
4. Loading Models
5. Adding Component Selections to the Assembly View
6. Incorporating Model Relationships
7. Clearing the Build

Building Your Own Streaming Service

1. Introduction
2. Setup
3. Creating a Simple File Server
4. Creating the Application Server
5. Spawning Streaming Servers
6. Liveliness Updates
7. Creating Viewers
8. Removing Viewers
9. SSR Support
10. Monitoring Server Load
11. Conclusion and Next Steps

Programming Guide

Viewing

Selection and Picking

Operators

Custom Operators
Geometry Handles

Scene Attributes

Camera
Draw Modes
Cutting Planes
Explode
Effects
Overlays
Lights
Axis Triad and NavCube

Model Attributes

Materials

Basics
Textures
Physically Based Rendering

Instance Modifiers

Geometry

Meshes
Point Clouds

Markup

Markup Basics
Advanced Markup
Measurement

Data Model

Layers and Filters

Stream Cache

Overview
Loading
Loading Subtrees
Shattered Workflows
SC and PRC

Miscellaneous Topics

User Interface
Image and SVG Generation
Promises
Typescript

Data Import

CAD Conversion

Converter Application

XML Batch Conversion

Stream Cache Workflows

Monolithic HTML Export

Connecting to External Data

XML Assembly Tree Format
Exchange to SC Mapping

Converter Library

Overview
Conversion Examples

Authoring

Creating SC Models
Assembly Tree Node IDs
Working With Units
Examples

Servers

HOOPS Server

Basic Setup
Configuration
Machine Setup
Advanced Setup
Deployment Scenarios
Monitoring and Troubleshooting
Amazon EC2 Quick Start

Stream Cache Server

Overview
Liveliness Pinging
Command Line Options
Library

Communicator for MCAD

Overview
CAD Views
PMI
Metadata
Configurations

Communicator for BIM

Overview
BCF Format
2D Floorplan

API Reference

Viewing

Web Viewer API Reference
Web Viewer Deprecated List

Data Import

Converter Command Line Options
Converter
Stream Cache C++
Stream Cache Java

Servers

HOOPS Server
Stream Cache Server

Legacy

SC Server - CSharp
SC Server - Java

Communicator.Markup.Shape

Shape

Enumerations

EndcapType

Classes

Circle
CircleCollection
EndcapShape
FilledShape
Line
LineCollection
Polygon
PolygonCollection
Polyline
PolylineCollection
Rectangle
RectangleBase
RectangleCollection
StrokedShape
Text
TextBox
TextBoxBase
TextBoxCollection
TextCollection
TextMarkupBase

HOOPS Communicator 2022 SP1 www.techsoft3d.com developer.techsoft3d.com