Skip to content

Commit

Permalink
break 3d stuff to its own page
Browse files Browse the repository at this point in the history
  • Loading branch information
Colin McFadden committed Dec 7, 2024
1 parent 3f7ae85 commit 9852283
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 32 deletions.
1 change: 1 addition & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ module.exports = {
sidebarDepth: 2, // optional, defaults to 1
children: [
'/curating',
'/3dmodels'
]
},
{
Expand Down
32 changes: 32 additions & 0 deletions docs/3dmodels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 3D Models

Elevator supports two different 3D viewers, the [3DHop](https://3dhop.net) viewer from the [Visual Computing Lab](http://vcg.isti.cnr.it) at CNR-ISTI, as well as [Voyager](https://smithsonian.github.io/dpo-voyager/) from the Smithsonian. 3DHop is the default, but Voyager can be enabled on an instance-by-instance basis in the Instance Settings.

The default mode for Voyager is a 3D model viewer with some basic tools for sliding and measurement. However, Voyager supports much more sophisticated annotation and tour-building. Currently, using these steps with Elevator requires a few extra steps. Eventually we hope to streamline these.

## Model Prep

Begin by uploading your model into an Elevator asset. In general, models should be zip files container OBJ, MTL and texture files.

Once Elevator processes your model (this can take a few minutes) you should be able to see a basic 3D view on the asset page.

Now, use the "download derivatives" button and download the GLB-Large file.

!["GLB Large Download"](./glb-large.png)

## Tour/Annotation Creation

In your browser, load the [Voyager Story Standalone](https://3d.si.edu/voyager-story-standalone) application. This is the tool for building tours. Drag and drop your GLB file into the Story tool. When it prompts you for a derivative quality, select "High".

Now, add any tours, annotations, or other features to your model. Currently, the "articles" feature isn't supported, but we're looking at options for that going forward. Instead, you can link to other websites to share more content - you can use the "extended" annotation type and then put links in the "Lead" section, using standard HTML:
```
<a href="http://www.whyshouldivisit.com">Why Should I Visit?</a>
```

When you've completed your work, click the download button in the upper right to download the finished scene. That will download a zip file.

## Adding the Scene to Elevator

Go back into the Edit view for your asset. Unzip the file that was downloaded by Voyager Story. Find the "scene.svx.json" file and open it in a text editor like VSCode, TextEdit or Notepad.

Copy and paste all of the contents from this file into the "SVX" sidecar box in Elevator. Save your asset. Now reload the asset view - your story should appear.
32 changes: 0 additions & 32 deletions docs/curating.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,35 +39,3 @@ If an upload fails for some reason, simply refresh the asset and select the file
After a file is uploaded, a small preview will be displayed. You may add an additional description about the file if you’d like.


# 3D Models

Elevator supports two different 3D viewers, the [3DHop](https://3dhop.net) viewer from the [Visual Computing Lab](http://vcg.isti.cnr.it) at CNR-ISTI, as well as [Voyager](https://smithsonian.github.io/dpo-voyager/) from the Smithsonian. 3DHop is the default, but Voyager can be enabled on an instance-by-instance basis in the Instance Settings.

The default mode for Voyager is a 3D model viewer with some basic tools for sliding and measurement. However, Voyager supports much more sophisticated annotation and tour-building. Currently, using these steps with Elevator requires a few extra steps. Eventually we hope to streamline these.

## Model Prep

Begin by uploading your model into an Elevator asset. In general, models should be zip files container OBJ, MTL and texture files.

Once Elevator processes your model (this can take a few minutes) you should be able to see a basic 3D view on the asset page.

Now, use the "download derivatives" button and download the GLB-Large file.

!["GLB Large Download"](./glb-large.png)

## Tour/Annotation Creation

In your browser, load the [Voyager Story Standalone](https://3d.si.edu/voyager-story-standalone) application. This is the tool for building tours. Drag and drop your GLB file into the Story tool. When it prompts you for a derivative quality, select "High".

Now, add any tours, annotations, or other features to your model. Currently, the "articles" feature isn't supported, but we're looking at options for that going forward. Instead, you can link to other websites to share more content - you can use the "extended" annotation type and then put links in the "Lead" section, using standard HTML:
```
<a href="http://www.whyshouldivisit.com">Why Should I Visit?</a>
```

When you've completed your work, click the download button in the upper right to download the finished scene. That will download a zip file.

## Adding the Scene to Elevator

Go back into the Edit view for your asset. Unzip the file that was downloaded by Voyager Story. Find the "scene.svx.json" file and open it in a text editor like VSCode, TextEdit or Notepad.

Copy and paste all of the contents from this file into the "SVX" sidecar box in Elevator. Save your asset. Now reload the asset view - your story should appear.

0 comments on commit 9852283

Please sign in to comment.