connected-spaces-platform.web 4.24.0 → 4.26.0

package/connectedspacesplatform.d.ts

@@ -127,7 +127,8 @@ export declare namespace Multiplayer {
         Reflection = 20,
         Fog = 21,
         ECommerce = 22,
-        FiducialMarker = 23
+        FiducialMarker = 23,
+        GaussianSplat = 24
     }
 }
 export declare namespace Multiplayer {
@@ -532,6 +533,24 @@ export declare namespace Multiplayer {
         Exponential2 = 2
     }
 }
+export declare namespace Multiplayer {
+    /**
+     * @description Enumerates the list of properties that can be replicated for a Gaussian Splat component.
+     */
+    enum GaussianSplatPropertyKeys {
+        Name = 0,
+        ExternalResourceAssetId = 1,
+        ExternalResourceAssetCollectionId = 2,
+        Position = 3,
+        Rotation = 4,
+        Scale = 5,
+        IsVisible = 6,
+        IsARVisible = 7,
+        IsShadowCaster = 8,
+        Tint = 9,
+        Num = 10
+    }
+}
 export declare namespace Multiplayer {
     /**
      * @description Enumerates the list of properties that can be replicated for an image space component.
@@ -853,7 +872,8 @@ export declare namespace Systems {
         SCRIPT_LIBRARY = 5,
         HOLOCAP_VIDEO = 6,
         HOLOCAP_AUDIO = 7,
-        AUDIO = 8
+        AUDIO = 8,
+        GAUSSIAN_SPLAT = 9
     }
 }
 export declare namespace Systems {
@@ -7094,6 +7114,126 @@ export declare namespace Multiplayer {
         delete(): void;
     }
 }
+export declare namespace Multiplayer {
+    /**
+  @ingroup GaussianSplatSpaceComponent
+   * @description Data representation of a GaussianSplatSpaceComponent.
+   * Gaussian Splatting is a technique for real-time 3D reconstruction and rendering of an object or environment using images taken from multiple points of view.
+   * Rather than representing the object as a mesh of triangles, which has a surface but nothing inside, it is instead represented as a volume,
+   * comprising a point cloud of splats (like coloured dots), each of which has a position, colour (with alpha) and covariance (scale on 3 axis).
+   */
+    class GaussianSplatSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IExternalResourceComponent, Multiplayer.IShadowCasterComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromComponentBase(baseInstance: Multiplayer.ComponentBase): Multiplayer.GaussianSplatSpaceComponent;
+        /**
+         * @description Constructs the Gaussian Splat component, and associates it with the specified Parent space entity.
+         * @param parent - The Space entity that owns this component.
+         */
+        static create_parent(parent: Multiplayer.SpaceEntity): GaussianSplatSpaceComponent;
+        /**
+         * @description Gets the ID of the asset associated with this component.
+         * NOTE: To retrieve this component's gaussian splat asset, both the Asset ID and the Asset Collection ID are required.
+         * @return The ID of the asset associated with this component.
+         */
+        getExternalResourceAssetId(): string;
+        /**
+         * @description Sets the ID of the asset associated with this component.
+         * NOTE: To retrieve this component's gaussian splat asset, both the Asset ID and the Asset Collection ID are required.
+         * @param value - The ID of the asset associated with this component.
+         */
+        setExternalResourceAssetId(value: string): void;
+        /**
+         * @description Gets the ID of the asset collection associated with this component.
+         * NOTE: To retrieve this component's gaussian splat asset, both the Asset ID and the Asset Collection ID are required.
+         * @return The ID of the asset collection associated with this component.
+         */
+        getExternalResourceAssetCollectionId(): string;
+        /**
+         * @description Sets the ID of the asset collection associated with this component.
+         * NOTE: To retrieve this component's gaussian splat asset, both the Asset ID and the Asset Collection ID are required.
+         * @param value - The ID of the asset collection associated with this component.
+         */
+        setExternalResourceAssetCollectionId(value: string): void;
+        /**
+         * \addtogroup ITransformComponent
+        @{
+        @copydoc IPositionComponent::GetPosition()
+         */
+        getPosition(): Common.Vector3;
+        /**
+        @copydoc IPositionComponent::SetPosition()
+         */
+        setPosition(value: Common.Vector3): void;
+        /**
+        @copydoc IRotationComponent::GetRotation()
+         */
+        getRotation(): Common.Vector4;
+        /**
+        @copydoc IRotationComponent::SetRotation()
+         */
+        setRotation(value: Common.Vector4): void;
+        /**
+        @copydoc IScaleComponent::GetScale()
+         */
+        getScale(): Common.Vector3;
+        /**
+        @copydoc IScaleComponent::SetScale()
+         */
+        setScale(value: Common.Vector3): void;
+        /**
+        @copydoc ITransformComponent::GetTransform()
+         */
+        getTransform(): Multiplayer.SpaceTransform;
+        /**
+        @copydoc ITransformComonent::SetTransform()
+         */
+        setTransform(value: Multiplayer.SpaceTransform): void;
+        /**
+        @}
+         * \addtogroup IVisibleComponent
+        @{
+        @copydoc IVisibleComponent::GetIsVisible()
+         */
+        getIsVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsVisible()
+         */
+        setIsVisible(value: boolean): void;
+        /**
+        @copydoc IVisibleComponent::GetIsARVisible()
+         */
+        getIsARVisible(): boolean;
+        /**
+        @copydoc IVisibleComponent::SetIsARVisible()
+         */
+        setIsARVisible(value: boolean): void;
+        /**
+        @}
+         * \addtogroup IShadowCasterComponent
+        @{
+        @copydoc IShadowCasterComponent::GetIsShadowCaster()
+         */
+        getIsShadowCaster(): boolean;
+        /**
+        @copydoc IShadowCasterComponent::SetIsShadowCaster()
+         */
+        setIsShadowCaster(value: boolean): void;
+        /**
+        @}
+         * @description Gets the tint that should be globally applied to the Gaussian Splat associated with this component.
+         * @return The global tint value, expected to be in RGB color space, with each value normalised between 0...1.
+         */
+        getTint(): Common.Vector3;
+        /**
+         * @description Sets the tint that should be globally applied to the Gaussian Splat.
+         * @param value - The tint value, expected to be in RGB color space, with each value normalised between 0...1.
+         * Defaults to 1,1,1.
+         */
+        setTint(tintValue: Common.Vector3): void;
+        delete(): void;
+    }
+}
 export declare namespace Multiplayer {
     /**
   @ingroup ImageSpaceComponent
@@ -8595,6 +8735,14 @@ export declare namespace Systems {
          * @param callback - Callback when asynchronous task finishes
          */
         addShopifyStore(storeName: string, spaceId: string, isEcommerceActive: boolean, privateAccessToken: string): Promise<Systems.AddShopifyStoreResult>;
+        /**
+         * @description Sets a store to be enabled or disabled in a space.
+         * @param storeName - The store name (URL) to the Shopify store. Do not include the '.shopify.com' part of the url.
+         * @param spaceId - ID of the space the store links to.
+         * @param isEcommerceActive - Bool to set the ecommerce system status to.
+         * @param callback - Callback when asynchronous task finishes
+         */
+        setECommerceActiveInSpace(storeName: string, spaceId: string, isEcommerceActive: boolean): Promise<Systems.AddShopifyStoreResult>;
         /**
          * @description Validates a shopify store given a store name and an access token.
          * @param storeName - The store name (URL) to the Shopify store. Do not include the '.shopify.com' part of the url.

package/connectedspacesplatform.js

@@ -418,6 +418,11 @@ function csp_multiplayer_FogModeFactory(nativePointer) {
     return nativePointer.pointer;
 }
 ProxyClassFactories["csp_multiplayer_FogMode"] = csp_multiplayer_FogModeFactory;
+function csp_multiplayer_GaussianSplatPropertyKeysFactory(nativePointer) {
+    return nativePointer.pointer;
+}
+ProxyClassFactories["csp_multiplayer_GaussianSplatPropertyKeys"] =
+    csp_multiplayer_GaussianSplatPropertyKeysFactory;
 function csp_multiplayer_ImagePropertyKeysFactory(nativePointer) {
     return nativePointer.pointer;
 }
@@ -987,6 +992,11 @@ function csp_multiplayer_FogSpaceComponentFactory(nativePointer) {
 }
 ProxyClassFactories["csp_multiplayer_FogSpaceComponent"] =
     csp_multiplayer_FogSpaceComponentFactory;
+function csp_multiplayer_GaussianSplatSpaceComponentFactory(nativePointer) {
+    return new Multiplayer.GaussianSplatSpaceComponent(nativePointer);
+}
+ProxyClassFactories["csp_multiplayer_GaussianSplatSpaceComponent"] =
+    csp_multiplayer_GaussianSplatSpaceComponentFactory;
 function csp_multiplayer_ImageSpaceComponentFactory(nativePointer) {
     return new Multiplayer.ImageSpaceComponent(nativePointer);
 }
@@ -1647,6 +1657,7 @@ export var Multiplayer;
         ComponentType[ComponentType["Fog"] = 21] = "Fog";
         ComponentType[ComponentType["ECommerce"] = 22] = "ECommerce";
         ComponentType[ComponentType["FiducialMarker"] = 23] = "FiducialMarker";
+        ComponentType[ComponentType["GaussianSplat"] = 24] = "GaussianSplat";
     })(ComponentType = Multiplayer.ComponentType || (Multiplayer.ComponentType = {}));
 })(Multiplayer || (Multiplayer = {}));
 (function (Multiplayer) {
@@ -2080,6 +2091,25 @@ export var Multiplayer;
         FogMode[FogMode["Exponential2"] = 2] = "Exponential2";
     })(FogMode = Multiplayer.FogMode || (Multiplayer.FogMode = {}));
 })(Multiplayer || (Multiplayer = {}));
+(function (Multiplayer) {
+    /**
+     * @description Enumerates the list of properties that can be replicated for a Gaussian Splat component.
+     */
+    let GaussianSplatPropertyKeys;
+    (function (GaussianSplatPropertyKeys) {
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["Name"] = 0] = "Name";
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["ExternalResourceAssetId"] = 1] = "ExternalResourceAssetId";
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["ExternalResourceAssetCollectionId"] = 2] = "ExternalResourceAssetCollectionId";
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["Position"] = 3] = "Position";
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["Rotation"] = 4] = "Rotation";
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["Scale"] = 5] = "Scale";
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["IsVisible"] = 6] = "IsVisible";
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["IsARVisible"] = 7] = "IsARVisible";
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["IsShadowCaster"] = 8] = "IsShadowCaster";
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["Tint"] = 9] = "Tint";
+        GaussianSplatPropertyKeys[GaussianSplatPropertyKeys["Num"] = 10] = "Num";
+    })(GaussianSplatPropertyKeys = Multiplayer.GaussianSplatPropertyKeys || (Multiplayer.GaussianSplatPropertyKeys = {}));
+})(Multiplayer || (Multiplayer = {}));
 (function (Multiplayer) {
     /**
      * @description Enumerates the list of properties that can be replicated for an image space component.
@@ -2424,6 +2454,7 @@ export var Multiplayer;
         EAssetType[EAssetType["HOLOCAP_VIDEO"] = 6] = "HOLOCAP_VIDEO";
         EAssetType[EAssetType["HOLOCAP_AUDIO"] = 7] = "HOLOCAP_AUDIO";
         EAssetType[EAssetType["AUDIO"] = 8] = "AUDIO";
+        EAssetType[EAssetType["GAUSSIAN_SPLAT"] = 9] = "GAUSSIAN_SPLAT";
     })(EAssetType = Systems.EAssetType || (Systems.EAssetType = {}));
 })(Systems || (Systems = {}));
 (function (Systems) {
@@ -16630,6 +16661,213 @@ export class CSPFoundation {
     }
     Multiplayer.FogSpaceComponent = FogSpaceComponent;
 })(Multiplayer || (Multiplayer = {}));
+(function (Multiplayer) {
+    /**
+  @ingroup GaussianSplatSpaceComponent
+   * @description Data representation of a GaussianSplatSpaceComponent.
+   * Gaussian Splatting is a technique for real-time 3D reconstruction and rendering of an object or environment using images taken from multiple points of view.
+   * Rather than representing the object as a mesh of triangles, which has a surface but nothing inside, it is instead represented as a volume,
+   * comprising a point cloud of splats (like coloured dots), each of which has a position, colour (with alpha) and covariance (scale on 3 axis).
+   */
+    class GaussianSplatSpaceComponent extends Multiplayer.ComponentBase {
+        /** @internal */
+        constructor(pointer) {
+            super(pointer);
+        }
+        static fromComponentBase(baseInstance) {
+            const nativeClassWrapper = baseInstance;
+            return new Multiplayer.GaussianSplatSpaceComponent(new NativePointer(nativeClassWrapper.pointer, nativeClassWrapper.ownsPointer));
+        }
+        /**
+         * @description Constructs the Gaussian Splat component, and associates it with the specified Parent space entity.
+         * @param parent - The Space entity that owns this component.
+         */
+        static create_parent(parent) {
+            var _ptr = Module._malloc(8);
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_Ctor_SpaceEntityP", "void", ["number", "number"], [_ptr, parent.pointer]);
+            var _nPtr = getNativePointer(_ptr);
+            return new GaussianSplatSpaceComponent(_nPtr);
+        }
+        /**
+         * @description Gets the ID of the asset associated with this component.
+         * NOTE: To retrieve this component's gaussian splat asset, both the Asset ID and the Asset Collection ID are required.
+         * @return The ID of the asset associated with this component.
+         */
+        getExternalResourceAssetId() {
+            let _result = Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_GetExternalResourceAssetIdC_StringRC", "number", ["number"], [this.pointer]);
+            const _resultString = Module.UTF8ToString(_result);
+            free(_result);
+            _result = _resultString;
+            return _result;
+        }
+        /**
+         * @description Sets the ID of the asset associated with this component.
+         * NOTE: To retrieve this component's gaussian splat asset, both the Asset ID and the Asset Collection ID are required.
+         * @param value - The ID of the asset associated with this component.
+         */
+        setExternalResourceAssetId(value) {
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_SetExternalResourceAssetId_void_StringRC", "void", ["number", "string"], [this.pointer, value]);
+        }
+        /**
+         * @description Gets the ID of the asset collection associated with this component.
+         * NOTE: To retrieve this component's gaussian splat asset, both the Asset ID and the Asset Collection ID are required.
+         * @return The ID of the asset collection associated with this component.
+         */
+        getExternalResourceAssetCollectionId() {
+            let _result = Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_GetExternalResourceAssetCollectionIdC_StringRC", "number", ["number"], [this.pointer]);
+            const _resultString = Module.UTF8ToString(_result);
+            free(_result);
+            _result = _resultString;
+            return _result;
+        }
+        /**
+         * @description Sets the ID of the asset collection associated with this component.
+         * NOTE: To retrieve this component's gaussian splat asset, both the Asset ID and the Asset Collection ID are required.
+         * @param value - The ID of the asset collection associated with this component.
+         */
+        setExternalResourceAssetCollectionId(value) {
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_SetExternalResourceAssetCollectionId_void_StringRC", "void", ["number", "string"], [this.pointer, value]);
+        }
+        /**
+         * \addtogroup ITransformComponent
+        @{
+        @copydoc IPositionComponent::GetPosition()
+         */
+        getPosition() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_GetPositionC_Vector3RC", "void", ["number", "number"], [_ret, this.pointer]);
+            var _nPtr = new Common.Vector3(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+        @copydoc IPositionComponent::SetPosition()
+         */
+        setPosition(value) {
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_SetPosition_void_Vector3RC", "void", ["number", "number"], [this.pointer, value.pointer]);
+        }
+        /**
+        @copydoc IRotationComponent::GetRotation()
+         */
+        getRotation() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_GetRotationC_Vector4RC", "void", ["number", "number"], [_ret, this.pointer]);
+            var _nPtr = new Common.Vector4(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+        @copydoc IRotationComponent::SetRotation()
+         */
+        setRotation(value) {
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_SetRotation_void_Vector4RC", "void", ["number", "number"], [this.pointer, value.pointer]);
+        }
+        /**
+        @copydoc IScaleComponent::GetScale()
+         */
+        getScale() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_GetScaleC_Vector3RC", "void", ["number", "number"], [_ret, this.pointer]);
+            var _nPtr = new Common.Vector3(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+        @copydoc IScaleComponent::SetScale()
+         */
+        setScale(value) {
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_SetScale_void_Vector3RC", "void", ["number", "number"], [this.pointer, value.pointer]);
+        }
+        /**
+        @copydoc ITransformComponent::GetTransform()
+         */
+        getTransform() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_GetTransformC_SpaceTransform", "void", ["number", "number"], [_ret, this.pointer]);
+            var _nPtr = new Multiplayer.SpaceTransform(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+        @copydoc ITransformComonent::SetTransform()
+         */
+        setTransform(value) {
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_SetTransform_void_SpaceTransformRC", "void", ["number", "number"], [this.pointer, value.pointer]);
+        }
+        /**
+        @}
+         * \addtogroup IVisibleComponent
+        @{
+        @copydoc IVisibleComponent::GetIsVisible()
+         */
+        getIsVisible() {
+            let _result = Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_GetIsVisibleC_bool", "boolean", ["number"], [this.pointer]);
+            return _result;
+        }
+        /**
+        @copydoc IVisibleComponent::SetIsVisible()
+         */
+        setIsVisible(value) {
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_SetIsVisible_void_bool", "void", ["number", "boolean"], [this.pointer, value]);
+        }
+        /**
+        @copydoc IVisibleComponent::GetIsARVisible()
+         */
+        getIsARVisible() {
+            let _result = Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_GetIsARVisibleC_bool", "boolean", ["number"], [this.pointer]);
+            return _result;
+        }
+        /**
+        @copydoc IVisibleComponent::SetIsARVisible()
+         */
+        setIsARVisible(value) {
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_SetIsARVisible_void_bool", "void", ["number", "boolean"], [this.pointer, value]);
+        }
+        /**
+        @}
+         * \addtogroup IShadowCasterComponent
+        @{
+        @copydoc IShadowCasterComponent::GetIsShadowCaster()
+         */
+        getIsShadowCaster() {
+            let _result = Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_GetIsShadowCasterC_bool", "boolean", ["number"], [this.pointer]);
+            return _result;
+        }
+        /**
+        @copydoc IShadowCasterComponent::SetIsShadowCaster()
+         */
+        setIsShadowCaster(value) {
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_SetIsShadowCaster_void_bool", "void", ["number", "boolean"], [this.pointer, value]);
+        }
+        /**
+        @}
+         * @description Gets the tint that should be globally applied to the Gaussian Splat associated with this component.
+         * @return The global tint value, expected to be in RGB color space, with each value normalised between 0...1.
+         */
+        getTint() {
+            var _ret = Module._malloc(8);
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_GetTintC_Vector3RC", "void", ["number", "number"], [_ret, this.pointer]);
+            var _nPtr = new Common.Vector3(getNativePointer(_ret));
+            Module._free(_ret);
+            return _nPtr;
+        }
+        /**
+         * @description Sets the tint that should be globally applied to the Gaussian Splat.
+         * @param value - The tint value, expected to be in RGB color space, with each value normalised between 0...1.
+         * Defaults to 1,1,1.
+         */
+        setTint(tintValue) {
+            Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_SetTint_void_Vector3RC", "void", ["number", "number"], [this.pointer, tintValue.pointer]);
+        }
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_multiplayer_GaussianSplatSpaceComponent_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
+    }
+    Multiplayer.GaussianSplatSpaceComponent = GaussianSplatSpaceComponent;
+})(Multiplayer || (Multiplayer = {}));
 (function (Multiplayer) {
     /**
   @ingroup ImageSpaceComponent
@@ -19895,6 +20133,32 @@ export class CSPFoundation {
             ]);
             return _promise;
         }
+        /**
+         * @description Sets a store to be enabled or disabled in a space.
+         * @param storeName - The store name (URL) to the Shopify store. Do not include the '.shopify.com' part of the url.
+         * @param spaceId - ID of the space the store links to.
+         * @param isEcommerceActive - Bool to set the ecommerce system status to.
+         * @param callback - Callback when asynchronous task finishes
+         */
+        async setECommerceActiveInSpace(storeName, spaceId, isEcommerceActive) {
+            var _resolve;
+            var _promise = new Promise((_r) => {
+                _resolve = _r;
+            });
+            var _callbackPtr;
+            var _callback = (_stateObject__, result) => {
+                var _resultPtr = getNativePointer(result);
+                var _resultInstance = new Systems.AddShopifyStoreResult(_resultPtr);
+                if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
+                    return;
+                }
+                _resolve(_resultInstance);
+                Module.removeFunction(_callbackPtr);
+            };
+            _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_systems_ECommerceSystem_SetECommerceActiveInSpace_void_StringRC_StringRC_boolC_SetECommerceActiveResultCallback", "void", ["number", "string", "string", "boolean", "number", "number"], [this.pointer, storeName, spaceId, isEcommerceActive, _callbackPtr, 0]);
+            return _promise;
+        }
         /**
          * @description Validates a shopify store given a store name and an access token.
          * @param storeName - The store name (URL) to the Shopify store. Do not include the '.shopify.com' part of the url.