Configure a 3D model for the Parts, Cross-Section & Variation features of saVRee's 3D Viewer

Configure a 3D model for the Parts, Cross-Section & Variation features of saVRee's 3D Viewer

Overview

There are the three main 3D Model Features for the saVRee 3D Viewer:

  1. Show/Hide Parts
  2. Cross-Section
  3. Variations

Here is an example model you can reference throughout this documentation:

https://savree.com/en/3d-interface-builder/embed/419e0035bc78d5e9

You can also download the 3D model with the naming convention example here:

1. Show/Hide Parts
      a. Shows and hide specific objects or a group of objects.



2. Cross-Section View
      a. Displays an object or group of objects in a cross-section view.



3. Variations

      a. Switch between different variations of a 3D model.



  • Each of these features needs to be configured on the 3D model itself. To enable these features each part of the model will need to be named according to saVRee's naming convention.

  • Each feature has a required naming convention to follow. All three features can be enabled on one model, or just one or two.

Definitions:

Part or Component
A set or group of objects
 
Object
An individual 3d object or material

Naming Convention Format


Name

The first section of the naming convention is the 'name'. This is the name that would be shown within the list of parts or variations of your 3D viewer interface.

Options

The second section of the naming convention are the 'options'. These include the show/hide parts, cross-section or variations features of your 3D model. The options include ' F' for full-view,  'C' for cross-section, and 'V' for variations.
Options are case-insensitive so you can also use lowercase 'f', 'c', or 'v'.

Separators

In between the 'name' and 'options' sections are separators, which are colons, ':' . These separate the two main sections of the part name and must be included for the part to work as intended in your 3D interface.

After the second ' : ' separator, you will often have a set of letters of numbers created by your 3D software, such as '001'. This will not show on the 3D viewer interface and acts only as a unique id for that 3D part within the software.

Show/Hide Parts  

This feature is activated by naming a 3D part using the convention format (name:options:).

The text within the 'name' section will appear in the Show/Hide menu.

Removing 3D Parts from all menus

If you want a 3D part from your model to show in the 3D viewer but NOT listed in the Show/Hide Parts or any other menu, then exclude any ':' separators in the part name. This part will still show in the 3D space but will not appear on the list of Parts or any other menu.

For example:
A 3D object named 'Ring:' would show in the 3D viewer and in the Parts list menu.


A 3D object named 'Ring' would show in the 3D viewer ONLY and NOT in the Parts list menu.

Important Note
The Show/Hide Parts checkbox must be selected within saVRee's Interface Builder to activate this feature. 

  Cross-Section & Full View

These features are activated by the letters 'C' for cross-section or 'F' for full view, which are added to the options section of the part name format.


Each letter controls a specific view function:

  • Part names that have the letter 'F' in the options section:

    • For objects that should appear ONLY in Full View.

    • Examples

      • Blue Cubes:FV13:

      • Blue Cubes:FV13:.001

      • Label:F:

  • Part names that have the letter 'C' in the options section:

    • For objects that should appear ONLY in Cross-Section View.

    • Examples

      • Blue Cubes:CV13:.003

      • Green Cubes:CV13:.003

      • Label:C:

  • Part names with neither the letter 'F' nor the letter 'C' in the options section:

    • For objects that should ALWAYS be shown; i.e. appear in BOTH the Full View and Cross-Section View.

    • These are also referred to as common parts.

    • Example

      • Ring:

 


Important Note:   The Cross-Section View checkbox must be selected within saVRee's Interface Builder to activate this feature.  

Variations  

In the third section about model Variations, we will use a 3D model of some Cubes & Pyramids as the example. The model has three variations (previously called configurations) that we want to switch between.

 

It also has the Show/Hide Parts & Cross-Section View features that were covered in Sections 1 and 2.

 

Here are the components of each Variation:




To break this down further, the below table categorizes each part by the relevant feature:

Variation

Full View Objects

Cross-Section Objects

Common Objects

Cubes
(Variation 1)

Blue Cubes:FV13:
Blue Cubes:FV13:.001
Blue Cubes:FV13:.002

Green Cubes:FV13:
Green Cubes:FV13:.001
Green Cubes:FV13:.002

Red Cubes:FV13:
Red Cubes:FV13:.001
Red Cubes:FV13:.002

Label:V1:

Label:F:
Blue Cubes:CV13:.003
Blue Cubes:CV13:.004
Blue Cubes:CV13:.005

Green Cubes:CV13:.003
Green Cubes:CV13:.004
Green Cubes:CV13:.005

Red Cubes:CV13:.003
Red Cubes:CV13:.004
Red Cubes:CV13:.005

Label:V1:

Label:C:

Ring


Pyramids
(Variation 2)

Blue Pyramids:FV23:.002

Blue Pyramids:FV23:.004

Green Pyramids:FV23:.001

Green Pyramids:FV23:.003

Label:V2:

Label:F:

Blue Pyramids:CV23:.005

Blue Pyramids:CV23:.007

Green Pyramids:CV23:.006

Green Pyramids:CV23:.008

Label:V2:

Label:C:

Ring

All Shapes
(Variation 3)

Blue Cubes:FV13:

Blue Cubes:FV13:.001

Blue Cubes:FV13:.002


Green Cubes:FV13:

Green Cubes:FV13:.001

Green Cubes:FV13:.002


Red Cubes:FV13:

Red Cubes:FV13:.001

Red Cubes:FV13:.002


Blue Pyramids:FV23:.002

Blue Pyramids:FV23:.004

Green Pyramids:FV23:.001

Green Pyramids:FV23:.003

Label:V3:

Label:F:
Blue Cubes:CV13:.003
Blue Cubes:CV13:.004
Blue Cubes:CV13:.005

Green Cubes:CV13:.003
Green Cubes:CV13:.004
Green Cubes:CV13:.005

Red Cubes:CV13:.003
Red Cubes:CV13:.004
Red Cubes:CV13:.005

Blue Pyramids:CV23:.005

Blue Pyramids:CV23:.007

Green Pyramids:CV23:.006

Green Pyramids:CV23:.008

Label:V3:

Label:C:

Ring

 

Dummy Cubes

Next, we need to communicate to the viewer the Variation which we want to be able to select.
In our Cubes & Pyramids example, this follow as:

Cubes = 1

Pyramids = 2

All Shapes = 3

 

To do that, we need to use dummy objects (aka ghost cubes or dummy cubes).

 

We add these three cubes in the 3D scene and give each of them a name that follow the following convention:

 

The letter 'D' followed by the variation number.

For our example:

Cubes:D1:

Pyramids:D2:

All Shapes:D3:

The viewer will automatically hide each object that has the dummy object naming style (i.e. Cubes:D1:) but are important for the the 3D Viewer to work properly. 


Set the default variation when the 3D model first loads

To set a specific variation to the default when the 3D model first loads, use the letter 'A' instead of 'D' for the dummy object. For instance, in the Cubes & Pyramids example, we want 'All Shapes:D3:' to be the default on first load, so we then simply need to change the letter 'D' to 'A'.

The final object name would be 'All Shapes:A3:', as you can see in the below image which highlights the variation dummy objects.

 


Summary Table

FeatureOptionDescriptionExample
Partsname:option:Naming format to include parts in menu list.name:FV1:
Cross-sectionFFor objects that should appear ONLY in Full View.name:F:
name:FV1:
name:FV12:
CFor objects that should appear ONLY in Cross-Section View.name:C:
name:CV1:
name:CV12:
VariationsVFor objects that should appear ONLY in named variations.name:V1:
name:V2:
name:V12:
name:V12345:
name:FV1:
name:CV1:
DDummy objects for displaying desired variations.name:D:
name:D1:
name:D2:
ASet default variation for when viewer loads.name:A:
name:A1:
name:A2:
Always show object in menu list
(Common Parts)		Include ':' separator in object nameFor objects that should ALWAYS be shown;
i.e. appear in BOTH the Full View and Cross-Section View.
Also shown in menu lists.		name:
name::
name:F:
name:C:
name:V1:
name:V2:
name:V12:
Hide 3D object from menu listNo ':' separator in object nameRemove 3D part from menu list (still shown in 3D space).name
Name




    • Related Articles

    • Interface Builder FAQs

      What is an interface? In saVRee's terns, an interface is a the interactive viewer surrounding your 3D model. This can include PDFs, images, videos, or external links that are all within the same iframe of your 3D model. Can I embed my 3D Interface ...