@sapui5/sap.ui.vk 1.138.0 → 1.139.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/sap.ui.vk",
-  "version": "1.138.0",
+  "version": "1.139.0",
   "description": "SAPUI5 Library sap.ui.vk",
   "homepage": "https://sap.github.io/ui5-tooling/pages/SAPUI5/",
   "author": "SAP SE (https://www.sap.com)",

package/src/sap/ui/vk/.library

@@ -7,7 +7,7 @@
 
         (c) Copyright 2009-2015 SAP SE. All rights reserved
     </copyright>
-    <version>1.138.0</version>
+    <version>1.139.0</version>
 
     <documentation>SAPUI5 Visualization Toolkit.</documentation>
 
@@ -35,6 +35,14 @@
             <libraryName>sap.ui.richtexteditor</libraryName>
             <lazy>true</lazy>
         </dependency>
+        <dependency>
+            <libraryName>sap.ui.comp</libraryName>
+            <lazy>true</lazy>
+        </dependency>
+        <dependency>
+            <libraryName>sap.f</libraryName>
+            <lazy>true</lazy>
+        </dependency>
     </dependencies>
 
     <appData>

package/src/sap/ui/vk/AnimationPlayback.js

@@ -27,7 +27,7 @@ sap.ui.define([
 	 *
 	 * @private
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.base.EventProvider
 	 * @alias sap.ui.vk.AnimationPlayback
 	 */

package/src/sap/ui/vk/AnimationPlayer.js

@@ -31,7 +31,7 @@ sap.ui.define([
 	 *
 	 * @public
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.core.Element
 	 * @alias sap.ui.vk.AnimationPlayer
 	 * @since 1.67.0

package/src/sap/ui/vk/AnimationSequence.js

@@ -33,7 +33,7 @@ sap.ui.define([
 	 *
 	 * @private
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.base.Object
 	 * @alias sap.ui.vk.AnimationSequence
 	 * @implements sap.ui.vk.IJointCollection

package/src/sap/ui/vk/AnimationTimeSlider.js

@@ -26,7 +26,7 @@ sap.ui.define([
 	 * @extends sap.m.Slider
 	 *
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/vk/AnimationTrack.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @param {boolean} parameters.infinite infinite flag
 	 *
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.base.Object
 	 * @alias sap.ui.vk.AnimationTrack
 	 *

package/src/sap/ui/vk/Annotation.js

@@ -40,7 +40,7 @@ sap.ui.define([
 	 *
 	 * @public
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.core.Control
 	 * @alias sap.ui.vk.Annotation
 	 * @since 1.76.0

package/src/sap/ui/vk/BaseNodeProxy.js

@@ -36,7 +36,7 @@ sap.ui.define([
 	 * @public
 	 * @abstract
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.base.Object
 	 * @implements sap.ui.base.Poolable, sap.ui.vk.BaseNodeProxy
 	 * @alias sap.ui.vk.BaseNodeProxy

package/src/sap/ui/vk/Camera.js

@@ -23,7 +23,7 @@ sap.ui.define([
 	 * @public
 	 * @abstract
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.base.ManagedObject
 	 * @alias sap.ui.vk.Camera
 	 * @since 1.52.0

package/src/sap/ui/vk/ContentConnector.js

@@ -7,23 +7,23 @@
 
 // Provides object sap.ui.vk.ContentConnector.
 sap.ui.define([
-	"sap/ui/base/Object",
+	"sap/base/Log",
 	"sap/ui/base/ManagedObjectObserver",
 	"sap/ui/core/Element",
-	"./Messages",
-	"./getResourceBundle",
 	"./ContentResource",
+	"./ContentType",
 	"./Core",
-	"sap/base/Log"
+	"./getResourceBundle",
+	"./Messages"
 ], function(
-	BaseObject,
+	Log,
 	ManagedObjectObserver,
 	Element,
-	Messages,
-	getResourceBundle,
 	ContentResource,
+	ContentType,
 	vkCore,
-	Log
+	getResourceBundle,
+	Messages
 ) {
 	"use strict";
 
@@ -40,7 +40,7 @@ sap.ui.define([
 	 * @param {object} [mSettings] Initial settings for the new ContentConnector object.
 	 * @public
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.core.Element
 	 * @alias sap.ui.vk.ContentConnector
 	 */
@@ -719,7 +719,79 @@ sap.ui.define([
 		return result;
 	};
 
-	var resolvers = [
+	// This function handles the cases when the content resource source type is "auto". In this case
+	// it is expected that the content resource has a source URL that points to a remote server that
+	// provides information about the content resource. The function sends a request to the server
+	// to get the content type and returns the content manager class name and dimension based on the
+	// content type.
+	//
+	// If the request fails or the content type is not recognized, the function returns `null`
+	// indicating that the next resolver should be tried.
+	async function autoResolver(contentResource) {
+		const sourceType = contentResource.getSourceType()?.toLowerCase();
+		const source = contentResource.getSource();
+		const veId = contentResource.getVeid() ?? "";
+
+		if (sourceType !== "auto" || typeof source !== "string" || veId === "") {
+			return null;
+		}
+
+		const url = `${source}${source.endsWith("/") ? "" : "/"}scenes/${veId}/info`;
+
+		try {
+			const response = await fetch(url);
+
+			if (!response.ok) {
+				return null;
+			}
+
+			const { contentType } = await response.json();
+
+			switch (contentType) {
+				case ContentType.IMAGE2D:
+				case ContentType.IMAGE360:
+				case ContentType.MATERIAL:
+				case ContentType.MODEL3D:
+				case ContentType.NAVIGATION:
+				case ContentType.SYMBOL:
+					contentResource.setEffectiveSourceType("stream");
+
+					return {
+						dimension: 3,
+						contentManagerClassName: "sap.ui.vk.threejs.ContentManager"
+					};
+
+				case ContentType.DRAWING2D:
+				case ContentType.ECAD:
+					contentResource.setEffectiveSourceType(contentType === ContentType.ECAD
+						? "ecad"
+						: "stream2d"
+					);
+
+					return {
+						dimension: 2,
+						contentManagerClassName: "sap.ui.vk.svg.ContentManager"
+					};
+
+				case ContentType.PDF:
+					contentResource.setEffectiveSourceType("stream");
+
+					return {
+						dimension: 2,
+						contentManagerClassName: "sap.ui.vk.pdf.ContentManager"
+					};
+
+				default:
+					return null;
+			}
+		} catch (e) {
+			Log.error("Failed to resolve content resource type automatically.", e, "sap.ui.vk.ContentConnector");
+		}
+
+		return null;
+	}
+
+	const resolvers = [
 		{
 			pattern: /(^threejs[:.])|(^(threejs|stream|vds4)$)/,
 			dimension: 3,
@@ -744,7 +816,8 @@ sap.ui.define([
 			pattern: /^(pdf)$/,
 			dimension: 2,
 			contentManagerClassName: "sap.ui.vk.pdf.ContentManager"
-		}
+		},
+		autoResolver
 	];
 
 	/**
@@ -768,53 +841,42 @@ sap.ui.define([
 	 *     </pre>
 	 * @private
 	 */
-	var resolveContentManager = function(contentResource) {
-		return new Promise(function(resolve, reject) {
-			var entries = resolvers.slice();
-			var test = function(index) {
-				if (index >= entries.length) {
-					reject();
-					return;
+	async function resolveContentManager(contentResource) {
+		const sourceType = contentResource.getSourceType()?.toLowerCase();
+
+		let resolver = null;
+
+		for (const entry of resolvers.slice()) {
+			if (typeof entry === "function") {
+				try {
+					resolver = await entry(contentResource);
+					break;
+				} catch {
+					continue;
 				}
-				var resolver = entries[index];
-				(function() {
-
-					var sourceType = contentResource.getSourceType();
-					if (sourceType) {
-						sourceType = sourceType.toLowerCase();
-					}
-
-					if (typeof resolver === "function") {
-						return resolver(contentResource);
-					} else if (typeof resolver.pattern === "string") {
-						var patternLowerCase = resolver.pattern.toLowerCase();
-						if (patternLowerCase === sourceType) {
-							return Promise.resolve(resolver);
-						}
-					} else if (resolver.pattern instanceof RegExp) {
+			} else if (typeof entry.pattern === "string") {
+				if (entry.pattern.toLowerCase() === sourceType) {
+					resolver = entry;
+					break;
+				}
+			} else if (entry.pattern instanceof RegExp) {
+				if (entry.pattern.test(sourceType)) {
+					resolver = entry;
+					break;
+				}
+			}
+		}
 
-						if (resolver.pattern.test(sourceType)) {
-							return Promise.resolve(resolver);
-						}
-					}
-					// Skip to the next resolver.
-					return Promise.reject();
-				})().then(
-					function(value) { // onFulfilled
-						resolve({
-							dimension: value.dimension,
-							contentManagerClassName: value.contentManagerClassName,
-							settings: value.settings
-						});
-					},
-					function() {      // onRejected
-						test(index + 1);
-					}
-				);
+		if (resolver == null) {
+			return null;
+		} else {
+			return {
+				dimension: resolver.dimension,
+				contentManagerClassName: resolver.contentManagerClassName,
+				settings: resolver.settings
 			};
-			test(0);
-		});
-	};
+		}
+	}
 
 	/**
 	 * Adds a new content manager resolver.
@@ -1045,8 +1107,8 @@ sap.ui.define([
 	/**
 	 * Collects information about content resource types.
 	 *
-	 * Content resources can be 2D and 3D models. Depending of content type different rendering technologies
-	 * should be used, e.g. DVL, ThreeJS or native browser capabilities, e.g. for raster 2D files.
+	 * Content resources can be 2D and 3D models, PDFs, raster images. Depending on content type different rendering
+	 * technologies should be used, e.g. DVL, ThreeJS or native browser capabilities, e.g. for raster 2D files.
 	 *
 	 * This method has a side effect - it assigns content manager resolvers to the content resources.
 	 *
@@ -1063,7 +1125,7 @@ sap.ui.define([
 	 * @private
 	 * @since 1.50.0
 	 */
-	ContentConnector.prototype._collectContentResourceSourceTypeInformation = function(contentResources) {
+	ContentConnector.prototype._collectContentResourceSourceTypeInformation = async function(contentResources) {
 		var noSourceTypes = false;
 		var unknownSourceTypes = false;
 		var dimensions = {};
@@ -1075,44 +1137,36 @@ sap.ui.define([
 			contentResource.getContentResources().forEach(flatten);
 		});
 
-		return Promise
-			.all(
-				flatList.map(
-					function(contentResource) {
-						return resolveContentManager(contentResource)
-							.then(
-								function(resolver) { // onFulfilled
-									dimensions[resolver.dimension] = true;
-									contentManagerClassNames[resolver.contentManagerClassName] = true;
-									return resolver;
-								},
-								function() { // onRejected
-									if (contentResource.getSourceType()) {
-										unknownSourceTypes = true;
-									} else {
-										noSourceTypes = true;
-									}
-									return false;
-								}
-							);
-					}
-				)
-			)
-			.then(function(results) {
-				for (var i = 0, count = flatList.length; i < count; ++i) {
-					if (results[i]) {
-						// Assign the resolver to the content resource.
-						// It might be used by those content managers that support additional settings.
-						flatList[i]._contentManagerResolver = results[i];
-					}
+		const resolvers = await Promise.all(flatList.map(async function(contentResource) {
+			const resolver = await resolveContentManager(contentResource);
+
+			if (resolver == null) {
+				if (contentResource.getSourceType()) {
+					unknownSourceTypes = true;
+				} else {
+					noSourceTypes = true;
 				}
-				return {
-					noSourceTypes: noSourceTypes,
-					unknownSourceTypes: unknownSourceTypes,
-					dimensions: Object.getOwnPropertyNames(dimensions).sort(),
-					contentManagerClassNames: Object.getOwnPropertyNames(contentManagerClassNames)
-				};
-			});
+			} else {
+				dimensions[resolver.dimension] = true;
+				contentManagerClassNames[resolver.contentManagerClassName] = true;
+			}
+			return resolver;
+		}));
+
+		for (const [i, resolver] of resolvers.entries()) {
+			if (resolver != null) {
+				// Assign the resolver to the content resource.
+				// It might be used by those content managers that support additional settings.
+				flatList[i]._contentManagerResolver = resolver;
+			}
+		}
+
+		return {
+			noSourceTypes: noSourceTypes,
+			unknownSourceTypes: unknownSourceTypes,
+			dimensions: Object.getOwnPropertyNames(dimensions).toSorted().map(Number),
+			contentManagerClassNames: Object.getOwnPropertyNames(contentManagerClassNames)
+		};
 	};
 
 	/**

package/src/sap/ui/vk/ContentManager.js

@@ -26,7 +26,7 @@ sap.ui.define([
 	 * @protected
 	 * @abstract
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.base.ManagedObject
 	 * @alias sap.ui.vk.ContentManager
 	 * @since 1.50.0

package/src/sap/ui/vk/ContentResource.js

@@ -27,7 +27,7 @@ sap.ui.define([
 	 * @param {object} [oScope] scope An object for resolving string-based type and formatter references in bindings.
 	 * @public
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.base.ManagedObject
 	 * @alias sap.ui.vk.ContentResource
 	 */
@@ -44,6 +44,7 @@ sap.ui.define([
 
 				/**
 				 * The source type of the content resource. Valid types:
+				 *
 				 * <ul>
 				 *   <li>vds</li>
 				 *   <li>vds4</li>
@@ -54,18 +55,26 @@ sap.ui.define([
 				 *   <li>jpeg</li>
 				 *   <li>gif</li>
 				 *   <li>bmp</li>
-				 *   <li>tif*</li>
-				 *   <li>tiff*</li>
+				 *   <li>tif</li>
+				 *   <li>tiff</li>
 				 *   <li>stream</li>
 				 *   <li>stream2d</li>
 				 *   <li>ecad</li>
 				 *   <li>pdf</li>
+				 *   <li>auto</li>
 				 * </ul>
+				 *
 				 * The source type may be omitted if this is a grouping content node.
-				 * </br>NOTE: The tif and tiff image formats are not supported on all browsers.
-				 *       Source type "vds" initializes deprecated DVL namespace and uses legacy library to load and display VDS file content.
-				 *       If source type of "vds4" is used then new namespace based on Threejs rendering model will be used to load and display VDS file content.
-				 *       Since DVL namespace is deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model.
+				 * <p>
+				 * If the <code>source</code> property points to an IPD Visualization service the
+				 * <code>sourceType</code> property can be assigned value <code>auto</code>. The
+				 * actual <code>sourceType</code> property will be detected by making a request to
+				 * the backend.
+				 * <p>
+				 * NOTE: The tif and tiff image formats are not supported on all browsers.
+				 * Source type "vds" initializes deprecated DVL namespace and uses legacy library to load and display VDS file content.
+				 * If source type of "vds4" is used then new namespace based on Threejs rendering model will be used to load and display VDS file content.
+				 * Since DVL namespace is deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model.
 				 */
 				sourceType: "string",
 
@@ -220,6 +229,8 @@ sap.ui.define([
 
 		constructor: function(sId, mSettings, oScope) {
 			ManagedObject.apply(this, arguments);
+
+			this._effectiveSourceType = undefined;
 		}
 	});
 
@@ -307,5 +318,13 @@ sap.ui.define([
 		return categories;
 	};
 
+	ContentResource.prototype.getEffectiveSourceType = function() {
+		return this._effectiveSourceType ?? this.getSourceType();
+	};
+
+	ContentResource.prototype.setEffectiveSourceType = function(effectiveSourceType) {
+		this._effectiveSourceType = effectiveSourceType;
+	};
+
 	return ContentResource;
 });

package/src/sap/ui/vk/ContentType.js

@@ -0,0 +1,41 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+
+        (c) Copyright 2009-2015 SAP SE. All rights reserved
+    
+ */
+
+sap.ui.define([
+	"sap/ui/base/DataType"
+], function(
+	DataType
+) {
+	"use strict";
+
+	/**
+	 * Defines the type of content in a scene.
+	 *
+	 * See VisualContentType in IPD Visualization API.
+	 *
+	 * @enum {string}
+	 * @alias sap.ui.vk.ContentType
+	 * @private
+	 * @since 1.139.0
+	 */
+	const ContentType = {
+		MODEL3D: "3DModel",
+		IMAGE2D: "2DImage",
+		IMAGE360: "360Image",
+		DRAWING2D: "2DDrawing",
+		NAVIGATION: "Navigation",
+		FOLDER: "Folder",
+		SYMBOL: "Symbol",
+		MATERIAL: "Material",
+		PDF: "PDF",
+		ECAD: "ECAD"
+	};
+
+	DataType.registerEnum("sap.ui.vk.ContentType", ContentType);
+
+	return ContentType;
+});

package/src/sap/ui/vk/Core.js

@@ -39,7 +39,7 @@ sap.ui.define([
 	 * @final
 	 * @private
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.base.ManagedObject
 	 * @alias sap.ui.vk.Core
 	 * @since 1.50.0

package/src/sap/ui/vk/DownloadManager.js

@@ -37,7 +37,7 @@ sap.ui.define([
 	 * 				If left undefined, the number of retry attempts will default to 1. Passing in 0 disables any retry attempts.
 	 * @private
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.base.EventProvider
 	 * @alias sap.ui.vk.DownloadManager
 	 * @since 1.32.0

package/src/sap/ui/vk/DrawerToolbar.js

@@ -117,7 +117,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 *
 	 * @public
 	 * @alias sap.ui.vk.DrawerToolbar
@@ -1116,8 +1116,6 @@ sap.ui.define([
 		var ecadSeparator = new ToolbarSeparator();
 		ecadSeparator.vitId = DrawerToolbarButton.EcadSeparator;
 
-		this._ecadItems = [rotateCCW, rotateCW, flip, ecadSeparator];
-
 		var crossSectionSeparator = new ToolbarSeparator();
 		crossSectionSeparator.vitId = DrawerToolbarButton.CrossSectionSeparator;
 
@@ -1183,7 +1181,46 @@ sap.ui.define([
 			this._pageNavigation
 		];
 
-		this._notPdfItems = [zoom, items[9], items[13], this._togglePmiButton, this._togglePmiButtonSeparator, this._measurementsSeparator, this._measurementsToggleButton, this._fitToView, fullscreen];
+		this._notPdfItems = [
+			zoom,
+			this._gestureButtonsSeparator,
+			this._fitToViewSeparator,
+			this._togglePmiButton,
+			this._togglePmiButtonSeparator,
+			this._measurementsSeparator,
+			this._measurementsToggleButton,
+			this._fitToView,
+			this._fitToViewSeparator,
+			this._rectSelectionButton,
+			this._rectSelectSeparator,
+			fullscreen
+		];
+
+		this._ecadItems = [
+			rotateCCW,
+			rotateCW,
+			flip,
+			ecadSeparator
+		];
+
+		this._notEcadItems = [
+			this._togglePmiButton,
+			this._togglePmiButtonSeparator,
+			this._gestureButtons[0], // turntable
+			this._gestureButtons[1], // orbit
+			this._measurementsToggleButton,
+			this._measurementsSeparator,
+			crossSectionToggleButton,
+			crossSectionSeparator,
+			predefinedViews,
+			predefinedViewsSeparator,
+			this._zoomInButton,
+			this._zoomOutButton,
+			this._zoomToFitPageButton,
+			this._zoomToFitPageWidthButton,
+			pageNavigationSeparator,
+			this._pageNavigation
+		];
 
 		items.forEach(function(item) {
 			this._itemsVisibility.set(item, true);
@@ -1409,7 +1446,7 @@ sap.ui.define([
 			}.bind(this));
 
 			this._itemTurntable.setVisible(is3D && this._itemsVisibility.get(this._itemTurntable));
-			this._itemPan.setVisible(!isPanoramic && !isPdf && !isEcad && this._itemsVisibility.get(this._itemPan));
+			this._itemPan.setVisible(!isPanoramic && !isPdf && this._itemsVisibility.get(this._itemPan));
 
 			this._items3D.forEach(function(item) {
 				item.setVisible(is3D && !isPanoramic && this._itemsVisibility.get(item));
@@ -1423,22 +1460,12 @@ sap.ui.define([
 				i.setVisible(!isPdf && this._itemsVisibility.get(i));
 			});
 
+			// show ECAD controls for ECAD scenes and hide for other scene types
+			this._ecadItems.forEach((item) => item.setVisible(isEcad && this._itemsVisibility.get(item)));
+			// for ECAD scenes -> hide non ECAD controls and don't touch them otherwise
 			if (isEcad) {
-				this._itemZoom.setVisible(false);
-				this._fitToView.setVisible(false);
-				this._fitToViewSeparator.setVisible(false);
-				this._togglePmiButton.setVisible(false);
-				this._togglePmiButtonSeparator.setVisible(false);
-				this._gestureButtonsSeparator.setVisible(false);
-				this._measurementsToggleButton.setVisible(false);
-				this._measurementsSeparator.setVisible(false);
-				this._rectSelectionButton.setVisible(false);
-				this._rectSelectSeparator.setVisible(false);
+				this._notEcadItems.forEach((item) => item.setVisible(false));
 			}
-			this._ecadItems.forEach(function(item) {
-				item.setVisible(isEcad);
-			});
-
 
 			this._ignoreVisibilityChange = false;
 

package/src/sap/ui/vk/DvlException.js

@@ -18,7 +18,7 @@ sap.ui.define(["sap/ui/base/Exception"], function(Exception) {
 	 * @param {string} message The error message.
 	 * @private
 	 * @author SAP SE
-	 * @version 1.138.0
+	 * @version 1.139.0
 	 * @extends sap.ui.base.Exception
 	 * @alias sap.ui.vk.DvlException
 	 */