forked from JeremyHeleine/Photo-Sphere-Viewer
-
-
Notifications
You must be signed in to change notification settings - Fork 686
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
27 changed files
with
988 additions
and
232 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| # OverlaysPlugin <Badge text="NEW"/> | ||
|
|
||
| <Badges module="overlays-plugin"/> | ||
|
|
||
| ::: module | ||
| <ApiButton page="modules/OverlaysPlugin.html"/> | ||
| Display additional images and videos on top of the panorama. | ||
| ::: | ||
|
|
||
| [[toc]] | ||
|
|
||
| ## Usage | ||
|
|
||
| Overlays are images and videos "glued" to the panorama. Contrary to [markers](./markers.md) they are part of the 3D scene and not drawn on top of the viewer. | ||
|
|
||
| Two kinds of overlays are supported : | ||
|
|
||
| - full size equirectangular/cubemap : will cover the entire panorama | ||
| - positionned rectangle : the image/video has a defined position and size (always in radians/degrees) | ||
|
|
||
| ```js | ||
| const viewer = new PhotoSphereViewer.Viewer({ | ||
| plugins: [ | ||
| [PhotoSphereViewer.OverlaysPlugin, { | ||
| overlays: [ | ||
| { | ||
| id: 'fullsize', | ||
| path: 'path/to/overlay.png', | ||
| }, | ||
| { | ||
| id: 'positionned', | ||
| path: 'path/to/image.jpg', | ||
| yaw: '-20deg', | ||
| pitch: '10deg', | ||
| width: '40deg', | ||
| height: '20deg', | ||
| opacity: 0.5, | ||
| }, | ||
| { | ||
| id: 'video', | ||
| type: 'video', | ||
| path: 'path/to/video.mp4', | ||
| yaw: '20deg', | ||
| pitch: '10deg', | ||
| width: '40deg', | ||
| height: '20deg', | ||
| }, | ||
| ], | ||
| }], | ||
| ], | ||
| }); | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
||
| TODO | ||
|
|
||
| ### Comparison with markers | ||
|
|
||
| This example show the difference between a positionned overlay and `image` and `imageLayer` markers. | ||
|
|
||
| TODO | ||
|
|
||
| ## Configuration | ||
|
|
||
| #### `overlays` | ||
|
|
||
| - type: `OverlayConfig[]` | ||
| - updatable: no | ||
|
|
||
| The list of overlays, see bellow. Can be updated with various [methods](#methods). | ||
|
|
||
| #### `autoclear` | ||
|
|
||
| - type: `boolean` | ||
| - default: `true` | ||
| - updatable: yes | ||
|
|
||
| Automatically remove all overlays when the panorama changes. | ||
|
|
||
| ### Overlays | ||
|
|
||
| Overlays can be a single image/video for a spherical gerometry or six images for a cube geometry (no videos). | ||
|
|
||
| #### `id` (recommended) | ||
|
|
||
| - type: `string` | ||
| - default: random value | ||
|
|
||
| Used to remove the overlay with `removeOverlay()` method. | ||
|
|
||
| #### `type` | ||
|
|
||
| - type: `image | video` | ||
| - default: `image` | ||
|
|
||
| #### `opacity` | ||
|
|
||
| - type: `number` | ||
| - default: `1` | ||
|
|
||
| #### `zIndex` | ||
|
|
||
| - type: `number` | ||
| - default: `0` | ||
|
|
||
| #### Spherical overlays | ||
|
|
||
| #### `path` (required) | ||
|
|
||
| - type: `string` | ||
|
|
||
| Path to the image or video. | ||
|
|
||
| #### `yaw`, `pitch`, `width`, `height` | ||
|
|
||
| - type: `number | string` | ||
|
|
||
| Definition of the position and size of the overlay, if none of the four properties are configured, the overlay will cover the full sphere, respecting the [panorama data](../guide/adapters/equirectangular.md#cropped-panorama) if applicable. | ||
|
|
||
| #### Cube overlays | ||
|
|
||
| #### `path` (required) | ||
|
|
||
| - type: `CubemapPanorama` | ||
|
|
||
| Check the [cubemap adapter page](../guide/adapters/cubemap.md#panorama-options) for the possible syntaxes. All six faces are required. | ||
|
|
||
| ## Methods | ||
|
|
||
| #### `addOverlay(config)` | ||
|
|
||
| Adds a new overlay. | ||
|
|
||
| #### `removeOverlay(id)` | ||
|
|
||
| Removes an overlay. | ||
|
|
||
| #### `clearOverlays()` | ||
|
|
||
| Removes all overlays. | ||
|
|
||
| #### `getVideo(id)` | ||
|
|
||
| Returns the controller of a video overlay (native HTMLVideoElement) in order to change its state, volume, etc. | ||
|
|
||
| ```js | ||
| overlaysPlugin.getVideo('my-video').muted = false; | ||
| ``` | ||
|
|
||
| ## Events | ||
|
|
||
| #### `overlay-click(overlayId)` | ||
|
|
||
| Triggered when an overlay is clicked. | ||
|
|
||
| ```js | ||
| overlaysPlugin.addEventListener('overlay-click', ({ overlayId }) => { | ||
| console.log(`Clicked on overlay ${overlayId}`); | ||
| }); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.