@micrio/client 5.1.18 → 5.1.19

package/micrio.min.d.ts

@@ -1,6 +1,6 @@
 declare module '@micrio/client' {
 	import type { Readable, Writable } from 'svelte/store';
-	export const VERSION = "5.1.18";
+	export const VERSION = "5.1.19";
 	export type PREDEFINED = [string, Models.ImageInfo.ImageInfo, Models.ImageData.ImageData | undefined];
 	export const isFetching: (uri: string) => boolean;
 	export const getLocalData: (id: string) => PREDEFINED | undefined;
@@ -278,7 +278,6 @@ declare module '@micrio/client' {
 		getXY: (x: number, y: number, abs?: boolean, radius?: number, rotation?: number, noTrueNorth?: boolean) => Float64Array;
 		/** Get the current image scale */
 		getScale: () => number;
-		getQuad(cX: number, cY: number, w: number, h: number, rotX?: number, rotY?: number, rotZ?: number, scaleX?: number, scaleY?: number): Float32Array;
 		/** Get a custom matrix for 360 placed embeds
 		 * @param x The X coordinate
 		 * @param y The Y coordinate
@@ -288,6 +287,8 @@ declare module '@micrio/client' {
 		 * @param rotY The object Y rotation in radians
 		 * @param rotZ The object Z rotation in radians
 		 * @param transY Optional Y translation in 3d space
+		 * @param scaleX Optional X scaling
+		 * @param scaleY Optional Y scaling
 		 * @returns The resulting 4x4 matrix
 		 */
 		getMatrix(x: number, y: number, scale?: number, radius?: number, rotX?: number, rotY?: number, rotZ?: number, transY?: number, scaleX?: number, scaleY?: number): Float32Array;
@@ -435,7 +436,6 @@ declare module '@micrio/client' {
 		getOmniRotation(): number;
 		/** [Omni] Get the corresponding frame number to current rotation */
 		getOmniFrame(rot?: number): number | undefined;
-		getOmniXY(x: number, y: number, z: number): Float64Array;
 		setOmniSettings(): void;
 	}
 	export const BASEPATH_V5: string;
@@ -2187,7 +2187,9 @@ declare module '@micrio/client' {
 		static jsonCache: Map<string, Object>;
 		/** All available canvases */
 		readonly canvases: MicrioImage[];
-		/** Current main {@link MicrioImage} store Writable. Its value can be referred to using the {@link $current} property */
+		/** Current main {@link MicrioImage} store Writable. Its value can be referred to using the {@link $current} property.
+		 * A lot of the app is reactive to this, so only set this using <micr-io>.open();
+		 */
 		readonly current: Writable<MicrioImage | undefined>;
 		/** Currently visible canvases */
 		readonly visible: Writable<MicrioImage[]>;
@@ -2238,6 +2240,11 @@ declare module '@micrio/client' {
 		 * @param img The currently visible {@link MicrioImage}
 		*/
 		close(img: MicrioImage): void;
+		/** Parse a gallery string ([micrioId,width?,height?,type?,format?], ';'-separated)
+		 * and load all relevant image data needed.
+		 * A gallery is basically one giant wide MicrioImage, that has each individual gallery
+		 * image embedded within itself.
+		*/
 		private loadGallery;
 		gridInfoData: {
 			images: Models.ImageInfo.ImageInfo[];