Parameters

The embed mode of the supports the following configuration parameters:

• resolution: allowed values are 512 (SD), 1024 (HD), 2048 (UHD). Default: 1024
• hide_bg: If set to 1 the player will use a solid color as a background instead of the default environment.
• bg_color: Sets the color of the 3D environment to the given hex color. Note that this parameter overrides the background color defined in the Background Color Extension of the SmartVu®. Allowed values: 6-digit HEX color without #-sign, e.g. FFFFFF for white, or transparent
• plane: Sets the color of the 3D floor to the given hex color. Allowed values: 6-digit HEX color without #-sign, e.g. FFFFFF for white.
• autoplay: If set to 1, the 3D preview on the page will start immediately. The play button will not be displayed.
• autopause: If set to 1, the player pauses when idle to save CPU and battery.
• autorotate: If set to 1, the 3D model starts spinning when the user is idle for 5 seconds.
• autorotate_speed: Relative speed, default: 1. Use lower value (e.g. 0.5) for faster rotation and higher value (e.g. 2) for slower rotation.
• hide_sidebar: If set to 1, the sidebar and its widgets of your SmartVu® will not be displayed. Note that this parameter overrides the sidebar behaviour defined in the SmartVu® Editor.
• hide_applink: If set to 1, the "Open in App"-button in the bottom left corner of the 3D view will not be displayed.
• openinapp (Deprecated): If set to 1, the "Open in App"-button in the bottom left corner of the 3D view will be displayed.
• hide_navigation: If set to 1, the default navigation UI elements are hidden, e.g. the "Back" button only works in Embed mode
• enable_shadows: If set to 1, shadows will be enabled on all devices. By default, shadows are disabled on all mobile devices. Note that this setting may cause a significant drop in performance for slower devices, so you should only set it for very simple models or if you plan to target desktop users exclusively.
• enable_xr: pass enable_xr=0 to disable the AR button
• enable_mirror: display a mirror surface below the model
• enable_ao: enable ambient occlusion for the displayed model
• format: aura or glb, glb is default. Pass aura to use the new AuraWeb format
• initial_hotspot: pass the hotspot the SmartVu® starts with, e.g. &initial_hotspot=footsteps-00
• aa: number of post-processing samples, range between 0 and 8. pass 0 to disable post-processing; default=2
• exposure: global exposure of the scene – will not be applied if post-processing is disabled, default=1.0
• contrast: global contrast of the scene – will not be applied if post-processing is disabled, default=1.0

Web Viewer v1.8.6 and higher:

• brand_color: Sets the text and button color of the UI elements, e.g. Popups. Allowed values: 6-digit HEX color without #-sign, e.g. FFFFFF for white. Default: white.
• brand_bg: Sets the background color of the UI elements, e.g. Popups. Allowed values: 6-digit HEX color without #-sign, e.g. FFFFFF for white. Default: #121A27

Web Viewer v1.8.14 and higher:

• force_sidebar: If set to 1, the SmartVu sidebar UI is forced to be in its initial state (also requires the sidebar to be enabled for the SmartVu in studio)

3D Viewer v3.1 and higher:

• see Disabling Device Types

These parameters are added to the URL after a question mark and separated by ampersands (“&”). Please refer to the next section for a couple of examples.

Javascript API

Methods

{ 
  method: 'vf.activate_trigger', 
  id: [id of trigger]
}

{ 
  method: 'vf.set_ego_limites', 
  start_angle: 0, 
  min_angle: -90, 
  max_angle: 90 
}

{ 
  method: 'vf.set_texture', 
  id: [id of texture], 
  url: [url of texture], 
  alpha: [true|false]
}

{ 
  method: 'vf.show_object', 
  path: [path to object]
}

{ 
  method: 'vf.hide_object', 
  path: [path to object]
}

{ method: 'vf.pause', ui: [true|false] }

{ method: 'vf.unpause' }

{ method: 'vf.ui.list_triggers' }

{ 
  method: 'vf.navigate_back'
}

{
  method: 'vf.set_background',
  color: [HEX COLOR]
}

{ 
  method: 'vf.set_material_color', 
  id: [name of the material], 
  color: [HEX COLOR]
}

{ 
  method: 'vf.allow_rotation', 
  state: [true|null]
}

Example call from Javascript to an iframe via jQuery:

$("iframe.vuframe")[0].contentWindow.postMessage({method:"vf.activate_trigger", id: tourStop.trigger },'*');

Callbacks

Using Javascript's PostMessage method the Vuframe® Embeddable Viewer will deliver events to the parent page in the following format:

{
  event_id: 'vf.<event_id>',
  params: {
      v1: 'value1', 
      v2: 'value2'
  }
}

{
  trigger_type: '',
  trigger_id: ''
}

{
  context: ''
}

{
  context: ''
}

{
  title: ''
}

{
triggers: [
    {
    path: 'root/child/trigger1',
    type: 'EVENT'
    }
  ]
}

{
  title: ''
}

How to listen for callbacks?

window.addEventListener('message', this.onApiCallback, false)

function onApiCallback(e)
{
        if (e.data.event_id === 'vf.did_activate_trigger')
        {
            // do something
        }
}

Examples

Copy these HTML tags and paste them on your website to embed your SmartVu®. Note that you will need to replace “<embed_code>” with the embed code of your Smartvu or 3D model in order for these tags to work.

Example #1: Embed page with a solid pink background:

<iframe frameborder=0 src="https://embed.vuframe.com/<embed_code>?hide_bg=1&bg_color=FF00FF" />

Example #2: Embed page that automatically loads 3D content. The "Open in App"-button and the sidebar will not be displayed:

<iframe frameborder=0 src="https://embed.vuframe.com/<embed_code>?autoplay=1&hide_applink=1&hide_sidebar=1" />

Troubleshooting

If you run into any issues, you can always contact us to get support.