Speckle 3D Viewer
How to navigate and use speckle's online 3d viewer • Last modified on 7/5/2019 • edit

This small tutorial is assuming you're comfortable around the online interface of speckle. If you haven't even heard about it, then please read the following section.

Loading Streams

If you have a bunch of geometry that you're passing around with speckle, you can most probably view it online in the 3d viewer. It's quite easy:

  • under the viewer section, search for a stream and click add
  • from the stream overview / stream details section click on the rotate icon

3d viewer start

Furthermore, once in the 3d viewer, you can load as many streams as you want or need. Just search for them and click on the plus sign! To remove a stream, just click the remove button.

Here's a few navigation basics:

  • spacebar will zoom to the current scene's extents
  • double click on a mouse-overed object to zoom to it
  • right click and drag to pan
  • left click and drag to rotate
  • scrollwheel to zoom in and out

Grouping & Filtering

Speckle allows you to group your objects by any common property. This adds a bit of legibility to the default gray view. To do so, in the viewer controls, go to the middle tab. Here you will be able to select by filed or property to group your objects.

Some of the predefined filters are:

  • speckle_type: what type of object this is, within the speckle worldview
  • layer_name and layer_guid: if the stream contains layers, these will be used to group objects

All other fields are populated based on your the properties of the objects currently loaded. In the example below, the stream comes from Revit.

3d viewer groups

You will notice that if an object does not have the property you want to filter by, it will be included in the Orphaned Objects group. All other objects will be randomly grouped (and coloured) by that specific field.

Next to each group, there are two buttons:

  • one allows you to isolate the objects in that group (hides all other objects),
  • or simply toggle that specific layer's visibility.

If the property value you want to group objects by is numeric, you will see something else happening:

3d viewer groups

Specifically, a different type of UI will pop up, which allows you to filter objects based on a specified numeric range. So, for example, if your objects have a volume property, or an Air Flow property, which is expressed by a number, the viewer will allow you to filter the current objects in a way that feels more appropriate given the nature of the property.

Inspecting objects

Finally, you can inspect any object's properties and fields, one by one. First, go to the last tab in the viewer controls. Next, select an object from the viewer by simply... clicking on it! If you want to look at multiple objects at the same time, hold down left shift and click some more objects!

3d viewer groups

You can now unfold in the tree view to the left to inspect whatever metadata and other properties are associated with this object. That's it - this covers pretty much all the things the speckle viewer can do for you (so far).