Close #1020 Move "useXmpData" to EquirectangularAdapter config

mistic100 · Jul 24, 2023 · 9b83564 · 9b83564
1 parent bad91ca
commit 9b83564
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 23 deletions.
diff --git a/docs/guide/adapters/equirectangular.md b/docs/guide/adapters/equirectangular.md
@@ -11,14 +11,21 @@ There is no need to declare the equirectangular adapter as it is the default one
 ```js
 const viewer = new PhotoSphereViewer.Viewer({
     adapter: [PhotoSphereViewer.EquirectangularAdapter, {
-        resolution: 64, // default
+        useXmpData: true, // default
     }],
     panorama: 'path/panorama.jpg',
 });
 ```
 
 ## Configuration
 
+#### `useXmpData`
+
+-   type: `boolean`
+-   default `true`
+
+Read real image size from XMP data, must be kept `true` if the panorama has been cropped after shot. This is used for [cropped panorama](#cropped-panorama).
+
 #### `resolution`
 
 -   type: `number`

diff --git a/docs/guide/config.md b/docs/guide/config.md
@@ -246,16 +246,13 @@ Speed multiplicator for panorama moves. Used for click move, touch move and navb
 
 Speed multiplicator for panorama zooms. Used for mouse wheel, touch pinch and navbar buttons.
 
-#### `useXmpData`
+#### ~~`useXmpData`~~
 
--   type: `boolean`
--   default `true`
-
-Read real image size from XMP data, must be kept `true` if the panorama has been cropped after shot. This is used for [cropped panorama](./adapters/equirectangular.md#cropped-panorama).
+Deprecated : must be configured [on the adapter](./adapters/equirectangular.md#configuration).
 
 #### `panoData`
 
--   type: `object | function<Image, object>`
+-   type: `object | function<Image, PanoData, PanoData>`
 
 Overrides XMP data found in the panorama file (or if `useXmpData=false`).
 All parameters are optional.
@@ -277,7 +274,7 @@ panoData: {
 It can also be a function to dynamically compute the cropping config depending on the loaded image.
 
 ```js
-panoData: (image) => ({
+panoData: (image, xmpData) => ({
     fullWidth: image.width,
     fullHeight: Math.round(image.width / 2),
     croppedWidth: image.width,

diff --git a/packages/core/src/adapters/EquirectangularAdapter.ts b/packages/core/src/adapters/EquirectangularAdapter.ts
@@ -1,10 +1,10 @@
 import { BufferGeometry, MathUtils, Mesh, ShaderMaterial, SphereGeometry, Texture } from 'three';
+import { PSVError } from '../PSVError';
+import type { Viewer } from '../Viewer';
 import { SPHERE_RADIUS } from '../data/constants';
 import { SYSTEM } from '../data/system';
 import { PanoData, PanoDataProvider, TextureData } from '../model';
-import { PSVError } from '../PSVError';
-import { createTexture, firstNonNull, getConfigParser, getXMPValue, logWarn } from '../utils';
-import type { Viewer } from '../Viewer';
+import { createTexture, firstNonNull, getConfigParser, getXMPValue, isNil, logWarn } from '../utils';
 import { AbstractAdapter } from './AbstractAdapter';
 
 /**
@@ -16,6 +16,11 @@ export type EquirectangularAdapterConfig = {
      * @default 64
      */
     resolution?: number;
+    /**
+     * read real image size from XMP data
+     * @default true
+     */
+    useXmpData?: boolean;
     /**
      * used for equirectangular tiles adapter
      * @internal
@@ -29,6 +34,7 @@ type EquirectangularTexture = TextureData<Texture, string>;
 const getConfig = getConfigParser<EquirectangularAdapterConfig>(
     {
         resolution: 64,
+        useXmpData: true,
         blur: false,
     },
     {
@@ -58,6 +64,9 @@ export class EquirectangularAdapter extends AbstractAdapter<string, Texture> {
         super(viewer);
 
         this.config = getConfig(config);
+        if (!isNil(this.viewer.config.useXmpData)) {
+            this.config.useXmpData = this.viewer.config.useXmpData;
+        }
 
         this.SPHERE_SEGMENTS = this.config.resolution;
         this.SPHERE_HORIZONTAL_SEGMENTS = this.SPHERE_SEGMENTS / 2;
@@ -74,7 +83,7 @@ export class EquirectangularAdapter extends AbstractAdapter<string, Texture> {
     async loadTexture(
         panorama: string,
         newPanoData: PanoData | PanoDataProvider,
-        useXmpPanoData = this.viewer.config.useXmpData
+        useXmpPanoData = this.config.useXmpData
     ): Promise<EquirectangularTexture> {
         if (typeof panorama !== 'string') {
             return Promise.reject(new PSVError('Invalid panorama url, are you using the right adapter?'));
@@ -85,7 +94,7 @@ export class EquirectangularAdapter extends AbstractAdapter<string, Texture> {
         const img = await this.viewer.textureLoader.blobToImage(blob);
 
         if (typeof newPanoData === 'function') {
-            newPanoData = newPanoData(img);
+            newPanoData = newPanoData(img, xmpPanoData);
         }
 
         const panoData = {

diff --git a/packages/core/src/data/config.ts b/packages/core/src/data/config.ts
@@ -38,7 +38,7 @@ export const DEFAULTS: Required<ParsedViewerConfig> = {
     mousemove: true,
     mousewheelCtrlKey: false,
     touchmoveTwoFingers: false,
-    useXmpData: true,
+    useXmpData: null,
     panoData: null,
     requestHeaders: null,
     canvasBackground: '#000',
@@ -232,6 +232,12 @@ export const CONFIG_PARSERS: ConfigParsers<ViewerConfig, ParsedViewerConfig> = {
         }
         return navbar;
     },
+    useXmpData: (useXmpData) => {
+        if (useXmpData !== null) {
+            logWarn(`Global useXmpData is deprecated, it is now configured on the adapter.`);
+        }
+        return useXmpData;
+    },
 };
 
 /**

diff --git a/packages/core/src/model.ts b/packages/core/src/model.ts
@@ -103,7 +103,7 @@ export type PanoData = {
 /**
  * Function to compute panorama data once the image is loaded
  */
-export type PanoDataProvider = (image: HTMLImageElement) => PanoData;
+export type PanoDataProvider = (image: HTMLImageElement, xmpData?: PanoData) => PanoData;
 
 /**
  * Object defining options for {@link Viewer.setPanorama}
@@ -313,7 +313,7 @@ export type ViewerConfig = {
     mousewheelCtrlKey?: boolean;
     /** @default false */
     touchmoveTwoFingers?: boolean;
-    /** @default true */
+    /** @deprecated configure on EquirectangularAdapter */
     useXmpData?: boolean;
     panoData?: PanoData | PanoDataProvider;
     requestHeaders?: Record<string, string> | ((url: string) => Record<string, string>);

diff --git a/packages/core/src/services/ViewerState.ts b/packages/core/src/services/ViewerState.ts
@@ -81,7 +81,7 @@ export class ViewerState {
     };
 
     /**
-     *  panorama metadata, if supported
+     * panorama metadata, if supported
      */
     panoData: PanoData = {
         fullWidth: 0,

diff --git a/packages/equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts b/packages/equirectangular-tiles-adapter/src/EquirectangularTilesAdapter.ts
@@ -82,8 +82,9 @@ const getConfig = utils.getConfigParser<EquirectangularTilesAdapterConfig>(
         showErrorTile: true,
         baseBlur: true,
         antialias: true,
-        blur: false,
         debug: false,
+        blur: false,
+        useXmpData: false,
     },
     {
         resolution: (resolution) => {
@@ -138,8 +139,6 @@ export class EquirectangularTilesAdapter extends AbstractAdapter<
 
         this.config = getConfig(config);
 
-        this.viewer.config.useXmpData = false;
-
         this.SPHERE_SEGMENTS = this.config.resolution;
         this.SPHERE_HORIZONTAL_SEGMENTS = this.SPHERE_SEGMENTS / 2;
         this.NB_VERTICES = 2 * this.SPHERE_SEGMENTS * NB_VERTICES_BY_SMALL_FACE
@@ -221,6 +220,7 @@ export class EquirectangularTilesAdapter extends AbstractAdapter<
             if (!this.adapter) {
                 this.adapter = new EquirectangularAdapter(this.viewer, {
                     blur: this.config.baseBlur,
+                    useXmpData: false,
                 });
             }
 

diff --git a/packages/equirectangular-video-adapter/src/EquirectangularVideoAdapter.ts b/packages/equirectangular-video-adapter/src/EquirectangularVideoAdapter.ts
@@ -12,6 +12,7 @@ const getConfig = utils.getConfigParser<EquirectangularVideoAdapterConfig>(
         resolution: 64,
         autoplay: false,
         muted: false,
+        useXmpData: false,
         blur: false,
     },
     {

diff --git a/packages/little-planet-adapter/src/LittlePlanetAdapter.ts b/packages/little-planet-adapter/src/LittlePlanetAdapter.ts
@@ -1,4 +1,4 @@
-import type { Position, Size, TextureData, Viewer } from '@photo-sphere-viewer/core';
+import type { EquirectangularAdapterConfig, Position, Size, TextureData, Viewer } from '@photo-sphere-viewer/core';
 import { EquirectangularAdapter, events } from '@photo-sphere-viewer/core';
 import { BufferGeometry, Euler, MathUtils, Matrix4, Mesh, PlaneGeometry, ShaderMaterial, Texture } from 'three';
 
@@ -17,8 +17,8 @@ export class LittlePlanetAdapter extends EquirectangularAdapter {
 
     private uniforms: ShaderMaterial['uniforms'];
 
-    constructor(viewer: Viewer) {
-        super(viewer, undefined);
+    constructor(viewer: Viewer, config?: EquirectangularAdapterConfig) {
+        super(viewer, config);
 
         this.viewer.state.littlePlanet = true;