Customization
Adding URL parameters (so called url options) allows you to control different aspects of the space viewer: UI elements, environment, camera behavior, ...
There are three places you can put the url options:
In the url
https://viewer.rooom.com/space/f7ef4851b8?autostart=1&max_texture_size=1024In the
srcattribute of embedded iframes
html
<iframe src="https://viewer.rooom.com/space/f7ef4851b8?autostart=1&max_texture_size=1024"></iframe>- During initialization of the Viewer API
Options
General
| Name | Type | Default | Description |
|---|---|---|---|
| autostart | boolean | false | Setting to true will make the model load immediately once the page is ready, rather than waiting for a user to click the Play button. |
| preload | boolean | true | Setting to true will force all resources (textures) to download before the scene is displayed. |
| render_background | boolean | false | Setting to true will force to render the scene in background (Has impact on the performance). |
| lang | string | '' | Setting the language for UI elements & text and ignore the browser language (german = de / english = en / italian = it / ...) |
| fallback_lang | string | 'de' | Setting the language for UI elements and text, when the browser locale are not supported (german = de / english = en / italian = it / ...) |
| start_birdseye | number | 0 | Setting to 0 = disable birdseye (default), 1 = birdseye can we selected in the camera type selector, 2 = force birdseye |
| start_thirdperson | boolean | false | Setting to false force first person camera mode |
| quality | string | SD | Setting to UHD, HD or LD will set the default quality the viewer loads unless manually set with quality picker |
| inactivity_timeout | boolean | true | Setting to true will end the user session after 2 hours of inactivity |
| autostart_systemcheck | boolean | false | Setting to true will automatically run the System Check tool once the page is ready. |
Avatars
| Name | Type | Default | Description |
|---|---|---|---|
| avatars_visible | boolean | true | Setting to false will hide all avatars in the scene |
| avatars_colors | string | '' | Setting a comma separated list with hexcolors to define the colorpalette for avatar configurator |
| avatars_show_config | number | 0 | Setting to 0 will always hide the avatar config modal. Setting to 1 will show the modal the first time per browser session (using a cookie). Setting to 2 will always show the modal. |
| avatars_edit_button | boolean | true | Setting to false will hide avatar bubble. (Applies only to RPM avatars) |
| avatars_show_labels | string | 'nearby' | Setting to 'show', 'hide', 'nearby' or 'hover' will change the avatar labels behavior in the scene |
| avatars_labels_background | string | '999999CC' | Label background color as hex string 6+2 letters for color and alpha |
| avatars_labels_color | string | 'FFFFFF' | Label text color as hex string |
| avatars_labels_thickness | number | 1 | Label border thickness |
| avatars_labels_cornerRadius | number | 16 | Label border radius |
| avatars_labels_fontFamily | string | Source Sans Pro, Open Sans, Segoe UI, sans-serif | Label text font familiy |
| avatars_labels_fontSize | number | 16 | Label font size in px |
| avatars_labels_offset | number | 0 | Label offset above avatar in screenspace px |
| avatars_labels_offsetWorld | number | 0 | Label offset above avatar in worldunits |
| avatars_labels_prepend | string | '' | Optional text to prepend before avatars name |
| avatars_code | string | '' | Specify the code for the avatar, with information to colors, materials and accessories |
| avatars_name | string | '' | Specify the avatars name |
| avatars_max_visible | number | 5000 | Upper limit of visible avatars per scene |
| mobile_avatars_max_visible | number | 5000 | Upper limit of visible avatars per scene on mobile |
| avatars_meshes_max_visible | number | 50 | Upper limit of visible avatar meshes per scene. All other meshes will be shown as abstract meshes. |
| mobile_avatars_meshes_max_visible | number | 30 | Upper limit of visible avatar meshes per scene on mobile. All other meshes will be shown as abstract meshes. |
| avatars_base_meshes_max_visible | number | 200 | Upper limit of visible avatar base meshes (shadow/abstract mesh) per scene. |
| mobile_avatars_base_meshes_max_visible | number | 50 | Upper limit of visible avatar base meshes (shadow/abstract mesh) per scene on mobile devices. |
| avatars_labels_max_visible | number | 50 | Upper limit of visible avatar labels. |
| mobile_avatars_labels_max_visible | number | 25 | Upper limit of visible avatar labels on mobile devices. |
| avatars_external_id | string | '' | Specify an external id, will be used to identify avatars |
| avatars_gestures_list | string | '' | Setting any value will show avatars gestures only from this list |
| avatars_voicechat | string | 0 | '1'=voice chat enabled, '0'=voice chat disabled, 'moderator'=only moderators (hosts) can talk |
| avatars_voicechat_maxdistance | number | 30 | You can use it to handle the volume level on different distance |
| avatars_voicechat_mode | string | toggle | Setting to 'ptt' enables Push-to-talk mode. Toggle mode enabled by default |
| mobile_avatars_enabled | boolean | true | Setting to 0 will hide all avatars in the scene, only for mobile devices |
| allow_double_jump | boolean | true | Allow/Disallow double jump |
| allow_spatial_audio_toggle | boolean | true | Setting to false will hide the spacial audio switch |
Camera
| Name | Type | Default | Description |
|---|---|---|---|
| camera_tour | boolean | true | Setting to false will force to disable the existing camera-tour. |
| autowalk_tour | boolean | true | Setting to false will force to disable an existing auto camera-tour. |
| autowalk_autoplay | boolean | false | Setting to false will prevent autoplaying autowalk. |
| autowalk_constant_speed | number | 0 | Setting to a number higher than 0 will normalize camera speed between steps, ignoring existing duration values. value is in units/s |
| autowalk_close_path | boolean | false | Setting to true makes sure that end point is at the same location as the starting point, forming a closed path. required for looping animations |
| camera_walk | number | true | Setting to 0 will disable the use of the walk keys and right click to move. |
| camera_mode | string | 'default' | Specify the inverse input system for camera ('default' / 'inverse' / 'keywalk'). |
| camera_position | string | '' | Specify the start camera position (alpha, beta for birdseye or x,y,z for walk) |
| camera_target | string | '' | Specify the start camera target x, y ,z |
| camera_position_offset | number | 0.5 | Specify a random offset for camera position |
| camera_rotation | string | '' | ONLY WALK Specify the start camera rotation for walk camera |
| camera_zoom_auto | boolean | true | ONLY BIRDSEYE Setting to false will skip the automatic scaling from upperRadiusLimit (camera_zoom_max) and lowerRadiusLimit (camera_zoom_min) - Distance. |
| camera_zoom_min | number | 0.3 | ONLY BIRDSEYE Setting to a positive number will define the camera zoom in limit (minimum distance from the model). |
| camera_zoom_max | number | 200 | ONLY BIRDSEYE Setting to a positive number will define the camera zoom out limit (maximum distance from the model). |
| camera_zoom_start | number | 0 | ONLY BIRDSEYE Set the start zoom distance. (0 = optimal radius) |
| camera_clipping_auto | boolean | true | Setting to false will skip the automatic scaling from camera minZ und maxZ. |
| camera_clipping_min | number | 0.3 | Setting to a positive number will define the camera min clipping limit (near clipping plane). |
| camera_clipping_max | number | 200 | Setting to a positive number will define the camera max clipping limit (far clipping plane). |
| camera_capsule_radius | number | 0.4 | Specify the camera collision radius |
| camera_speed | number | 3 | Specify the walk camera speed |
| camera_teleport | boolean | true | Enables teleport movement with right click |
| camera_fov | number | 45 | Sets the field of view for active camera in degrees |
| camera_constraint_pitch_down | number | 0 | Setting alpha to [-90 – 90] (in degrees) will define the camera's pitch down rotation limit. Help |
| camera_constraint_pitch_up | number | 0 | Setting alpha to [-90 – 90] (in degrees) will define the camera's pitch up rotation limit. Help |
| camera_constraint_yaw_left | number | 0 | Setting beta to [-180 – 180] (in degrees) will define the camera's yaw left rotation limit. Help |
| camera_constraint_yaw_right | number | 0 | Setting beta to [-180 – 180] (in degrees) will define the camera's yaw right rotation limit. Help |
Object
| Name | Type | Default | Description |
|---|---|---|---|
| max_texture_size | number | 4096 | Setting to a positive number will limit all textures to that maximum resolution (longest side in pixels). This should be a "power of 2" value such as 32, 128, 256, 512, etc. |
| mobile_max_texture_size | number | 512 | Setting to a positive number will set the default texture size on mobile devices (longest side in pixels). This should be a "power of 2" value such as 32, 128, 256, 512, etc. |
| max_texture_memory | number | 4096 | This setting will limit the maximum texture memory in MB. This is a global setting for all textures. |
| mobile_max_texture_memory | number | 200 | This setting will limit the maximum texture memory in MB for mobile devices. This is a global setting for all textures. |
| highlight_color | string | '' | Setting the default highlight color as hexcode. |
Performance Optimizations
| Name | Type | Default | Description |
|---|---|---|---|
| perf_object_instancing | boolean | true | Specifies whether object instancing should be used or not |
| perf_texture_optimized | boolean | true | Setting to true will load the optimized textures (ktx2) - if file is available and the format is supported on client-browser. |
| perf_mesh_streaming | boolean | false | Setting to true will load objects based on the distance and size |
Environment
| Name | Type | Default | Description |
|---|---|---|---|
| mirror_floor | number | 1 | Setting to 2 will force enable the mirror effect on the floor, 1 is default per quality mode and 0 will force disable the effects. |
| fx_dof_enabled | boolean | false | Setting to true enables depth of field using below values. |
| fx_dof_focus_distance | number | 4000 | Specifies the focus distance for the depth of field effect. |
| fx_dof_focal_length | number | 200 | Specifies the focal length for the depth of field effect. |
| fx_dof_f_stop | number | 1 | Specifies the f stop for the depth of field effect. |
| fx_glowlayer_enabled | boolean | false | Setting to true enables glow-layer using below values. |
| fx_glowlayer_kernelsize | number | 10 | Specifies the glow-layer kernel size for the glow-layer effect. |
| fx_glowlayer_intensity | number | 1 | Specifies the glow-layer intensity for the glow-layer effect. |
| env_snow | boolean | false | Enable or disable snow (particle system) in the scene. |
| env_fog | boolean | false | Enable or disable fog in the scene. |
| env_fog_min | number | 30 | Specifies the minimum distance for fog. |
| env_fog_max | number | 500 | Specifies the maximum distance for fog. |
User-Interface
| Name | Type | Default | Description |
|---|---|---|---|
| ui_color_primary | string | '' | Setting to a hexadecimal color code (without the #) for primary colors. |
| ui_color_secondary | string | '' | Setting to a hexadecimal color code (without the #) for secondary colors. |
| ui_color_accent | string | '' | Setting to a hexadecimal color code (without the #) for accent colors. |
| ui_text_primary | string | '' | Setting to a hexadecimal color code (without the #) for primary text. |
| ui_text_secondary | string | '' | Setting to a hexadecimal color code (without the #) for secondary text. |
| ui_infos | boolean | true | Setting to false will hide the space info bar at the top of the viewer. |
| ui_infos_persist | boolean | false | Setting to true will show the model info bar at the top of the viewer in 3d mode too. |
| ui_header_btn_link | string | '' | Setting a link add a button in the top right corner, as a custom button. |
| ui_header_btn_image | string | '' | Setting a link to an image add for the button in the top right corner a icon. |
| ui_progress_minimal | boolean | false | Setting to true show only the progressbar in loading screen. |
| ui_progress_logo | string | '' | Setting to a url will change the image of the viewer loading screen. |
| ui_progress_bg | boolean | true | Setting to false remove the background on loading screen. |
| ui_logo | boolean | true | Setting to false remove the rooom logo. |
| ui_logo_link | boolean | true | Setting to false remove the link from the rooom logo. |
| ui_help | boolean | true | Setting to false will hide the Help button. |
| ui_hint | number | 1 | Setting to 0 will always hide the viewer hint overlay. Setting to 1 will show the hint the first time per browser session (using a cookie). Setting to 2 will always show the hint. |
| ui_fullscreen | boolean | true | Setting to false will hide the Fullscreen button. |
| ui_general_controls | boolean | true | Setting to false will hide main control buttons in the bottom right of the viewer (Help, Fullscreen). |
| ui_controls | boolean | true | Setting to false will hide all the viewer controls at the bottom of the viewer (Help, Fullscreen and Annotations). |
| ui_stop | boolean | false | Setting to true will hide the "Disable Viewer" button in the top right so that users cannot stop the 3D render once it is started. |
| ui_perspective | boolean | true | Setting to true will hide the "Change Perspective" button so the user can only switch between birdseye and walking. |
| ui_quality | boolean | true | Setting to false will hide the quality button for SD, HD, ... |
| ui_vr | boolean | true | Setting to false will hide the "Toggle VR" button. |
| ui_cardboard | boolean | true | Setting to false will hide the cardboard camera. |
| ui_first_person | boolean | true | Setting to true will enable first person camera mode. |
| ui_third_person | boolean | true | Setting to true will enable the third person and alternative third person camera modes. |
| ui_anaglyph | boolean | false | Setting to true enables anaglyph camera mode in UI |
| ui_minimap | boolean | false | Setting to true will show the Mini Map. |
| ui_minimap_pin_color | string | 'ffffff' | Setting a color to change the color from pin-point (Cone). |
| ui_minimap_pin_offset | string | '0,0' | Setting offset for pin position on minimap. |
| ui_minimap_offset | string | '60,6' | Setting offset for minimap position. |
| ui_minimap_pin_areascale | number | 1 | Setting the areascale for pin movements on custom minimap. |
| ui_minimap_pin_rotation | number | 0 | Setting rotation for pin on minimap (degree). |
| ui_measurement | boolean | false | Setting to true will enable the measurement feature. |
| ui_back_to_start | boolean | false | Setting to true will show a button in the right corner to jump back on the start position. |
| ui_stats | boolean | false | Setting to true will show the Performance Monitor (stats.js). |
| ui_share | boolean | true | Setting to true will show the share button. |
| ui_audio | boolean | false | Setting to false will hide the audio control button. |
| ui_scroll_catch | boolean | false | Setting to true enable using arrow keys for navigation in embedded viewer. |
| ui_user_counter | boolean | true | Setting to false hides the user counter. |