SeeMyModel Button element that enables users to view models from api.seemymodel.com in AR mode.
SeeMyModel element that shows group of models from api.seemymodel.com in 3D Viewer in browser and in AR mode.
| Name | Description | Type | Default |
| folder-access-key | ID of the group folder | string | "" |
| model-access-key | ID of the model in the group that should be presented at first position | string | "" |
| ar-placement | Placement of the model when ar mode is activated, default: floor | "floor" | "wall" | "floor" |
| disable-occlusion | Set to true to disable occlusion in AR on Android SceneViewer | boolean | false |
| auto-run-ar | undefined | boolean | false |
| touch-action | Specifies in which axis element can be scrolled with touch controls:
- pan-y - touch user can vertically scroll element, starting gesture in horizontal axis results in interaction with the model;
- pan-x - opossite of pan-y;
- none - element cannot be scrolled by touch gestures; | "pan-y" | "pan-x" | "none" | "none" |
| auto-rotate | Enables auto rotation | boolean | false |
| auto-rotate-delay | Number in ms after which object starts to rotate, measured from last user interaction | number | 3000 |
| rotation-per-second | Auto rotation speed, in radians, degress or percents (100% is equal to pi/32 radians), e.g. "90deg", "0.25rad", "500%" | string | "100%" |
| interaction-prompt | Specifies when interaction prompt should be visible:
- auto - after time set via interaction-prompt-threshold has elapsed;
- when-focused - same as auto but an element must have received focus first;
- none - never; | "none" | "auto" | "auto" |
| interaction-prompt-threshold | Specifies how long element should wait before showing interaction-prompt | number | 3000 |
| camera-orbit | Orbital position of the camera in form: "theta phi radius"
- theta - polar angle in radians "rad" or degrees "deg", or "auto" which equals to 0deg;
- phi - azimuthal angle in radians "rad" or degrees "deg", or auto which equals to 75deg;
- radius - distance from target in meters "m", centimeters "cm", millimeters "mm" or percentages "%"
(100% should fit the model inside the viewer) or "auto" which equals to "105%";
Every property also accepts css functions: calc() and env() | string | "auto auto auto" |
| camera-target | Point that camera orbits around in form: "X Y Z".
Each value should be specified in meters "m", centimeters "cm" or millimeters "mm".
Each value can also accept "auto" which is equal to the center of the model bounding box | string | "auto auto auto" |
| max-camera-orbit | Maximum values for the camera-orbit | string | "Infinity 180deg 300%" |
| min-camera-orbit | Minimum values for the camera-orbit | string | "-Infinity 0deg auto" |
| field-of-view | Vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg".
Must be in range (0deg, 180deg) | string | "auto" |
| max-field-of-view | Maximum vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg".
Must be in range (0deg, 180deg) | string | "auto" |
| min-field-of-view | Minimum vertical field of view of the camera in degress "deg" or radians "rad".
Must be in range (0deg, 180deg) | string | "auto" |
| disable-panning-camera | Disable ability for user to pan the camera around with Right Mouse Button or with two fingers on touch devices | boolean | false |
| tutorial-mode | Specifies when tutorial should be visible | "onFirstVisit" | "always" | "never" | undefined |
| preview-mode | Optional, set it to run viewer in 'preview-mode` in which viewer simulates being run on selected platform
WARNING: in `preview-mode` augmented reality functionality is disabled | "pc" | "mobile" | undefined |
| ar-button-color | Optional, choose custom ar button color, in hex format e.g. "#ffffff" | string | undefined |
| show-poster | Optional, whether to show poster before model loads | boolean | undefined |
| reveal-mode | Optional, reveal mode
- `auto` - model loads immiedietely when component is in view and shows as soon as possible
- `interaction` - model loads when user clicks on component
- `interactionWithPreload` - model loads immiedietely when componenent is in view but shows only after user clicks on component | "auto" | "interaction" | "interactionWithPreload" | undefined |
| skybox-image | Optional, url to skybox hdr image | string | undefined |
| environment-image | Optional, url to skybox hdr image | string | undefined |
| disable-external-configuration | Set to true to disable configuration via remote REST API | boolean | false |
| locale | Component's language, default: `auto`, possible values: `auto`, `en`, `pl`.
`auto` detects user browser's language and sets its langauge if supported, `en` otherwise | string | "auto" |
| Name | Attribute | Description | Type | Default |
| folderAccessKey | folder-access-key | ID of the group folder | string | "" |
| modelAccessKey | model-access-key | ID of the model in the group that should be presented at first position | string | "" |
| arPlacement | ar-placement | Placement of the model when ar mode is activated, default: floor | "floor" | "wall" | "floor" |
| disableOcclusion | disable-occlusion | Set to true to disable occlusion in AR on Android SceneViewer | boolean | false |
| autoRunAR | auto-run-ar | undefined | boolean | false |
| touchAction | touch-action | Specifies in which axis element can be scrolled with touch controls:
- pan-y - touch user can vertically scroll element, starting gesture in horizontal axis results in interaction with the model;
- pan-x - opossite of pan-y;
- none - element cannot be scrolled by touch gestures; | "pan-y" | "pan-x" | "none" | "none" |
| autoRotate | auto-rotate | Enables auto rotation | boolean | false |
| autoRotateDelay | auto-rotate-delay | Number in ms after which object starts to rotate, measured from last user interaction | number | 3000 |
| rotationPerSecond | rotation-per-second | Auto rotation speed, in radians, degress or percents (100% is equal to pi/32 radians), e.g. "90deg", "0.25rad", "500%" | string | "100%" |
| interactionPrompt | interaction-prompt | Specifies when interaction prompt should be visible:
- auto - after time set via interaction-prompt-threshold has elapsed;
- when-focused - same as auto but an element must have received focus first;
- none - never; | "none" | "auto" | "auto" |
| interactionPromptThreshold | interaction-prompt-threshold | Specifies how long element should wait before showing interaction-prompt | number | 3000 |
| cameraOrbit | camera-orbit | Orbital position of the camera in form: "theta phi radius"
- theta - polar angle in radians "rad" or degrees "deg", or "auto" which equals to 0deg;
- phi - azimuthal angle in radians "rad" or degrees "deg", or auto which equals to 75deg;
- radius - distance from target in meters "m", centimeters "cm", millimeters "mm" or percentages "%"
(100% should fit the model inside the viewer) or "auto" which equals to "105%";
Every property also accepts css functions: calc() and env() | string | "auto auto auto" |
| cameraTarget | camera-target | Point that camera orbits around in form: "X Y Z".
Each value should be specified in meters "m", centimeters "cm" or millimeters "mm".
Each value can also accept "auto" which is equal to the center of the model bounding box | string | "auto auto auto" |
| maxCameraOrbit | max-camera-orbit | Maximum values for the camera-orbit | string | "Infinity 180deg 300%" |
| minCameraOrbit | min-camera-orbit | Minimum values for the camera-orbit | string | "-Infinity 0deg auto" |
| fieldOfView | field-of-view | Vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg".
Must be in range (0deg, 180deg) | string | "auto" |
| maxFieldOfView | max-field-of-view | Maximum vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg".
Must be in range (0deg, 180deg) | string | "auto" |
| minFieldOfView | min-field-of-view | Minimum vertical field of view of the camera in degress "deg" or radians "rad".
Must be in range (0deg, 180deg) | string | "auto" |
| disablePanningCamera | disable-panning-camera | Disable ability for user to pan the camera around with Right Mouse Button or with two fingers on touch devices | boolean | false |
| styles | undefined | undefined | CSSResult | "style" |
| tutorialMode | tutorial-mode | Specifies when tutorial should be visible | "onFirstVisit" | "always" | "never" | undefined |
| isTutorialDialogVisible | undefined | undefined | boolean | undefined |
| previewMode | preview-mode | Optional, set it to run viewer in 'preview-mode` in which viewer simulates being run on selected platform
WARNING: in `preview-mode` augmented reality functionality is disabled | "pc" | "mobile" | undefined |
| arButtonColor | ar-button-color | Optional, choose custom ar button color, in hex format e.g. "#ffffff" | string | undefined |
| showPoster | show-poster | Optional, whether to show poster before model loads | boolean | undefined |
| revealMode | reveal-mode | Optional, reveal mode
- `auto` - model loads immiedietely when component is in view and shows as soon as possible
- `interaction` - model loads when user clicks on component
- `interactionWithPreload` - model loads immiedietely when componenent is in view but shows only after user clicks on component | "auto" | "interaction" | "interactionWithPreload" | undefined |
| skyboxImage | skybox-image | Optional, url to skybox hdr image | string | undefined |
| environmentImage | environment-image | Optional, url to skybox hdr image | string | undefined |
| disableExternalConfiguration | disable-external-configuration | Set to true to disable configuration via remote REST API | boolean | false |
| locale | locale | Component's language, default: `auto`, possible values: `auto`, `en`, `pl`.
`auto` detects user browser's language and sets its langauge if supported, `en` otherwise | string | "auto" |
SeeMyModel element that shows models from api.seemymodel.com in 3D Viewer in browser and in AR mode.
| Name | Description | Type | Default |
| access-key | ID of the arModel | string | "" |
| model-access-key | ID of the arModel | string | "" |
| ar-placement | Placement of the model when ar mode is activated, default: floor | "floor" | "wall" | "floor" |
| disable-occlusion | Set to true to disable occlusion in AR on Android SceneViewer | boolean | false |
| auto-run-ar | undefined | boolean | false |
| touch-action | Specifies in which axis element can be scrolled with touch controls:
- pan-y - touch user can vertically scroll element, starting gesture in horizontal axis results in interaction with the model;
- pan-x - opossite of pan-y;
- none - element cannot be scrolled by touch gestures; | "pan-y" | "pan-x" | "none" | "none" |
| auto-rotate | Enables auto rotation | boolean | false |
| auto-rotate-delay | Number in ms after which object starts to rotate, measured from last user interaction | number | 3000 |
| rotation-per-second | Auto rotation speed, in radians, degress or percents (100% is equal to pi/32 radians), e.g. "90deg", "0.25rad", "500%" | string | "100%" |
| interaction-prompt | Specifies when interaction prompt should be visible:
- auto - after time set via interaction-prompt-threshold has elapsed;
- when-focused - same as auto but an element must have received focus first;
- none - never; | "none" | "auto" | "auto" |
| interaction-prompt-threshold | Specifies how long element should wait before showing interaction-prompt | number | 3000 |
| camera-orbit | Orbital position of the camera in form: "theta phi radius"
- theta - polar angle in radians "rad" or degrees "deg", or "auto" which equals to 0deg;
- phi - azimuthal angle in radians "rad" or degrees "deg", or auto which equals to 75deg;
- radius - distance from target in meters "m", centimeters "cm", millimeters "mm" or percentages "%"
(100% should fit the model inside the viewer) or "auto" which equals to "105%";
Every property also accepts css functions: calc() and env() | string | "auto auto auto" |
| camera-target | Point that camera orbits around in form: "X Y Z".
Each value should be specified in meters "m", centimeters "cm" or millimeters "mm".
Each value can also accept "auto" which is equal to the center of the model bounding box | string | "auto auto auto" |
| max-camera-orbit | Maximum values for the camera-orbit | string | "Infinity 180deg 300%" |
| min-camera-orbit | Minimum values for the camera-orbit | string | "-Infinity 0deg auto" |
| field-of-view | Vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg".
Must be in range (0deg, 180deg) | string | "auto" |
| max-field-of-view | Maximum vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg".
Must be in range (0deg, 180deg) | string | "auto" |
| min-field-of-view | Minimum vertical field of view of the camera in degress "deg" or radians "rad".
Must be in range (0deg, 180deg) | string | "auto" |
| disable-panning-camera | Disable ability for user to pan the camera around with Right Mouse Button or with two fingers on touch devices | boolean | false |
| tutorial-mode | Specifies when tutorial should be visible | "onFirstVisit" | "always" | "never" | undefined |
| preview-mode | Optional, set it to run viewer in 'preview-mode` in which viewer simulates being run on selected platform
WARNING: in `preview-mode` augmented reality functionality is disabled | "pc" | "mobile" | undefined |
| ar-button-color | Optional, choose custom ar button color, in hex format e.g. "#ffffff" | string | undefined |
| show-poster | Optional, whether to show poster before model loads | boolean | undefined |
| reveal-mode | Optional, reveal mode
- `auto` - model loads immiedietely when component is in view and shows as soon as possible
- `interaction` - model loads when user clicks on component
- `interactionWithPreload` - model loads immiedietely when componenent is in view but shows only after user clicks on component | "auto" | "interaction" | "interactionWithPreload" | undefined |
| skybox-image | Optional, url to skybox hdr image | string | undefined |
| environment-image | Optional, url to skybox hdr image | string | undefined |
| disable-external-configuration | Set to true to disable configuration via remote REST API | boolean | false |
| locale | Component's language, default: `auto`, possible values: `auto`, `en`, `pl`.
`auto` detects user browser's language and sets its langauge if supported, `en` otherwise | string | "auto" |
| Name | Attribute | Description | Type | Default |
| legacyAccessKeyAttribute | access-key | ID of the arModel | string | "" |
| modelAccessKey | model-access-key | ID of the arModel | string | "" |
| arPlacement | ar-placement | Placement of the model when ar mode is activated, default: floor | "floor" | "wall" | "floor" |
| disableOcclusion | disable-occlusion | Set to true to disable occlusion in AR on Android SceneViewer | boolean | false |
| autoRunAR | auto-run-ar | undefined | boolean | false |
| touchAction | touch-action | Specifies in which axis element can be scrolled with touch controls:
- pan-y - touch user can vertically scroll element, starting gesture in horizontal axis results in interaction with the model;
- pan-x - opossite of pan-y;
- none - element cannot be scrolled by touch gestures; | "pan-y" | "pan-x" | "none" | "none" |
| autoRotate | auto-rotate | Enables auto rotation | boolean | false |
| autoRotateDelay | auto-rotate-delay | Number in ms after which object starts to rotate, measured from last user interaction | number | 3000 |
| rotationPerSecond | rotation-per-second | Auto rotation speed, in radians, degress or percents (100% is equal to pi/32 radians), e.g. "90deg", "0.25rad", "500%" | string | "100%" |
| interactionPrompt | interaction-prompt | Specifies when interaction prompt should be visible:
- auto - after time set via interaction-prompt-threshold has elapsed;
- when-focused - same as auto but an element must have received focus first;
- none - never; | "none" | "auto" | "auto" |
| interactionPromptThreshold | interaction-prompt-threshold | Specifies how long element should wait before showing interaction-prompt | number | 3000 |
| cameraOrbit | camera-orbit | Orbital position of the camera in form: "theta phi radius"
- theta - polar angle in radians "rad" or degrees "deg", or "auto" which equals to 0deg;
- phi - azimuthal angle in radians "rad" or degrees "deg", or auto which equals to 75deg;
- radius - distance from target in meters "m", centimeters "cm", millimeters "mm" or percentages "%"
(100% should fit the model inside the viewer) or "auto" which equals to "105%";
Every property also accepts css functions: calc() and env() | string | "auto auto auto" |
| cameraTarget | camera-target | Point that camera orbits around in form: "X Y Z".
Each value should be specified in meters "m", centimeters "cm" or millimeters "mm".
Each value can also accept "auto" which is equal to the center of the model bounding box | string | "auto auto auto" |
| maxCameraOrbit | max-camera-orbit | Maximum values for the camera-orbit | string | "Infinity 180deg 300%" |
| minCameraOrbit | min-camera-orbit | Minimum values for the camera-orbit | string | "-Infinity 0deg auto" |
| fieldOfView | field-of-view | Vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg".
Must be in range (0deg, 180deg) | string | "auto" |
| maxFieldOfView | max-field-of-view | Maximum vertical field of view of the camera in degress "deg" or radians "rad". Can be set to "auto" which equals to "45deg".
Must be in range (0deg, 180deg) | string | "auto" |
| minFieldOfView | min-field-of-view | Minimum vertical field of view of the camera in degress "deg" or radians "rad".
Must be in range (0deg, 180deg) | string | "auto" |
| disablePanningCamera | disable-panning-camera | Disable ability for user to pan the camera around with Right Mouse Button or with two fingers on touch devices | boolean | false |
| styles | undefined | undefined | CSSResult | "style" |
| tutorialMode | tutorial-mode | Specifies when tutorial should be visible | "onFirstVisit" | "always" | "never" | undefined |
| isTutorialDialogVisible | undefined | undefined | boolean | undefined |
| previewMode | preview-mode | Optional, set it to run viewer in 'preview-mode` in which viewer simulates being run on selected platform
WARNING: in `preview-mode` augmented reality functionality is disabled | "pc" | "mobile" | undefined |
| arButtonColor | ar-button-color | Optional, choose custom ar button color, in hex format e.g. "#ffffff" | string | undefined |
| showPoster | show-poster | Optional, whether to show poster before model loads | boolean | undefined |
| revealMode | reveal-mode | Optional, reveal mode
- `auto` - model loads immiedietely when component is in view and shows as soon as possible
- `interaction` - model loads when user clicks on component
- `interactionWithPreload` - model loads immiedietely when componenent is in view but shows only after user clicks on component | "auto" | "interaction" | "interactionWithPreload" | undefined |
| skyboxImage | skybox-image | Optional, url to skybox hdr image | string | undefined |
| environmentImage | environment-image | Optional, url to skybox hdr image | string | undefined |
| disableExternalConfiguration | disable-external-configuration | Set to true to disable configuration via remote REST API | boolean | false |
| locale | locale | Component's language, default: `auto`, possible values: `auto`, `en`, `pl`.
`auto` detects user browser's language and sets its langauge if supported, `en` otherwise | string | "auto" |