connected-spaces-platform.web 5.11.0 → 5.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -969,9 +969,20 @@ export declare namespace Systems {
969
969
  }
970
970
  export declare namespace Systems {
971
971
  /**
972
- * @description Defines how to alpha value is interpreted
973
- * The alpha value is taken from the fourth component of the base color for metallic-roughness material model
974
- */
972
+ * @description Enum representing the shader type of a material.
973
+ @details This enum is to be used in conjunction with materials, which are managed via the AssetSystem.
974
+ */
975
+ enum EShaderType {
976
+ Standard = 0,
977
+ AlphaVideo = 1
978
+ }
979
+ }
980
+ export declare namespace Systems {
981
+ /**
982
+ * @description Defines how the alpha value of a material is interpreted.
983
+ @details The alpha value is taken from the fourth component of the base color for metallic-roughness material model.
984
+ * This enum is to be used in conjunction with materials, which are managed via the AssetSystem.
985
+ */
975
986
  enum EAlphaMode {
976
987
  Opaque = 0,
977
988
  Mask = 1,
@@ -980,10 +991,27 @@ export declare namespace Systems {
980
991
  }
981
992
  export declare namespace Systems {
982
993
  /**
983
- * @description Enum representing the shader type of a material. Currently not in use.
984
- */
985
- enum EShaderType {
986
- Standard = 0
994
+ * @description Defines how the alpha value of a material is interpreted.
995
+ @details The alpha value is taken from the fourth component of the base color for metallic-roughness material model, unless the shader supports
996
+ * EColorChannel.
997
+ * This enum is to be used in conjunction with materials, which are managed via the AssetSystem.
998
+ */
999
+ enum EBlendMode {
1000
+ Normal = 0,
1001
+ Additive = 1
1002
+ }
1003
+ }
1004
+ export declare namespace Systems {
1005
+ /**
1006
+ * @description Defines where the alpha value is read from.
1007
+ @details The alpha value is usually taken from the fourth component of the base color but this allows is to be read from another channel.
1008
+ * This enum is to be used in conjunction with materials, which are managed via the AssetSystem.
1009
+ */
1010
+ enum EColorChannel {
1011
+ R = 0,
1012
+ G = 1,
1013
+ B = 2,
1014
+ A = 3
987
1015
  }
988
1016
  }
989
1017
  export declare namespace Systems {
@@ -1762,6 +1790,12 @@ export declare class CSPFoundation {
1762
1790
  * @return The EndpointURIs class with current endpoint data
1763
1791
  */
1764
1792
  static getEndpoints(): EndpointURIs;
1793
+ /**
1794
+ * @description Create an EndpointsURIs object containing URIs to the various services needed by CSP.
1795
+ * @param endpointRootURI - URI to the root of the cloud services.
1796
+ * @return EndpointURIs class with deduced endpoint URIs.
1797
+ */
1798
+ static createEndpointsFromRoot(endpointRootURI: string): EndpointURIs;
1765
1799
  /**
1766
1800
  * @description Sets a class containing all relevant Client info currently set for Foundation.
1767
1801
  * Used internally to generate ClientUserAgentString.
@@ -4575,13 +4609,6 @@ export declare namespace Multiplayer {
4575
4609
  * @return The id of the leader.
4576
4610
  */
4577
4611
  getLeaderId(): bigint;
4578
- /**
4579
- * @description Finds a component by the given id.
4580
- * /// Searchs through all components of all entites so should be used sparingly.
4581
- * /// @param Id The id of the component to find.
4582
- * @return A pointer to the found component which can be nullptr if the component is not found.
4583
- */
4584
- findComponentById(id: number): Multiplayer.ComponentBase;
4585
4612
  /**
4586
4613
  * @description Retrieve the state of the patch rate limiter. If true, patches are limited for each individual entity to a fixed rate.
4587
4614
  * @return True if enabled, false otherwise.
@@ -5160,36 +5187,55 @@ export declare namespace Systems {
5160
5187
  }
5161
5188
  export declare namespace Systems {
5162
5189
  /**
5163
- @ingroup Asset System
5190
+ @ingroup Asset System.
5164
5191
  * @description Base class for a material.
5165
5192
  */
5166
5193
  class Material extends NativeClassWrapper implements INativeResource {
5167
5194
  /** @internal */
5168
5195
  constructor(pointer: NativePointer);
5169
5196
  /**
5170
- * @description Gets the user-defined name of the material
5171
- * @return Csp::common::string&
5197
+ * @description Gets the user-defined name of the material.
5198
+ * @return Returns the material name.
5172
5199
  */
5173
5200
  getName(): string;
5174
5201
  /**
5175
- * @description Gets the collection id for the material
5176
- * @return Const csp::common::string&
5202
+ * @description Gets the shader type of the material.
5203
+ * @return Returns the shader type.
5204
+ */
5205
+ getShaderType(): Systems.EShaderType;
5206
+ /**
5207
+ * @description Gets the version of the material.
5208
+ * @return Returns the version of the material.
5209
+ */
5210
+ getVersion(): number;
5211
+ /**
5212
+ * @description Gets the collection id for the material.
5213
+ * @return Returns the collection id.
5177
5214
  */
5178
5215
  getMaterialCollectionId(): string;
5179
5216
  /**
5180
- * @description Gets the id for the material
5181
- * @return Const csp::common::string&
5217
+ * @description Gets the id for the material.
5218
+ * @return Returns the material id.
5182
5219
  */
5183
5220
  getMaterialId(): string;
5184
5221
  /**
5185
- * @description Constructor which links the material to an asset
5222
+ * @description Constructs a material bound to an AssetCollection and Asset.
5186
5223
  * @param name - The name of the material.
5187
- * @param materialCollectionId - The asset collection where the material info is stored
5188
- * @param materialId - The asset where the material info is stored
5224
+ * @param materialCollectionId - The asset collection which references the associated material asset.
5225
+ * @param materialId - The asset where the material info is stored.
5189
5226
  */
5190
5227
  static create_name_materialCollectionId_materialId(name: string, materialCollectionId: string, materialId: string): Material;
5191
- static create(): Material;
5228
+ /**
5229
+ * @description Constructs a versioned material bound to an AssetCollection and Asset.
5230
+ * @param name - The name of the material.
5231
+ * @param materialCollectionId - The asset collection which references the associated material asset.
5232
+ * @param materialId - The asset where the material info is stored.
5233
+ * @param type - The material shader type.
5234
+ * @param version - The material version.
5235
+ */
5236
+ static create_name_materialCollectionId_materialId_type_version(name: string, materialCollectionId: string, materialId: string, type: Systems.EShaderType, version: number): Material;
5192
5237
  delete(): void;
5238
+ static create(): Material;
5193
5239
  }
5194
5240
  }
5195
5241
  export declare namespace Systems {
@@ -6139,6 +6185,25 @@ export declare namespace Systems {
6139
6185
  set shareScreen(value: boolean);
6140
6186
  }
6141
6187
  }
6188
+ export declare namespace Systems {
6189
+ /**
6190
+ * @description Data structure for a custom service proxy posting, giving service name, operation name, set help and parameters
6191
+ */
6192
+ class TokenInfoParams extends NativeClassWrapper implements INativeResource {
6193
+ /** @internal */
6194
+ constructor(pointer: NativePointer);
6195
+ static create(): TokenInfoParams;
6196
+ delete(): void;
6197
+ get serviceName(): string;
6198
+ set serviceName(value: string);
6199
+ get operationName(): string;
6200
+ set operationName(value: string);
6201
+ get setHelp(): boolean;
6202
+ set setHelp(value: boolean);
6203
+ get parameters(): Common.Map<string, string>;
6204
+ set parameters(value: Common.Map<string, string>);
6205
+ }
6206
+ }
6142
6207
  export declare namespace Systems {
6143
6208
  /**
6144
6209
  * @description A basic class abstraction for a user profile, including User Id and name, a display name, avatar information
@@ -9030,14 +9095,6 @@ export declare namespace Multiplayer {
9030
9095
  * @param value - The type of video source used by this component.
9031
9096
  */
9032
9097
  setVideoPlayerSourceType(value: Multiplayer.VideoPlayerSourceType): void;
9033
- /**
9034
- * @description Gets the Id of the mesh component that the video should be rendered to
9035
- */
9036
- getMeshComponentId(): number;
9037
- /**
9038
- * @description Sets the Id of the mesh component that the video should be rendered to
9039
- */
9040
- setMeshComponentId(id: number): void;
9041
9098
  /**
9042
9099
  * \addtogroup IVisibleComponent
9043
9100
  @{
@@ -9357,6 +9414,135 @@ export declare namespace Systems {
9357
9414
  delete(): void;
9358
9415
  }
9359
9416
  }
9417
+ export declare namespace Systems {
9418
+ /**
9419
+ @ingroup Asset System
9420
+ * @description Data class which represents an Alpha Video material.
9421
+ */
9422
+ class AlphaVideoMaterial extends Systems.Material implements INativeResource {
9423
+ /** @internal */
9424
+ constructor(pointer: NativePointer);
9425
+ static fromMaterial(baseInstance: Systems.Material): Systems.AlphaVideoMaterial;
9426
+ /**
9427
+ * @description Sets the color texture.
9428
+ @details The first three components (RGB) MUST be encoded with the sRGB transfer function. They specify the color of the material.
9429
+ * If the fourth component (A) is present, it represents the linear alpha coverage of the material.
9430
+ * Otherwise, the alpha coverage is equal to 1.0.
9431
+ * The material.blendMode property defines how the alpha is blended when alphaMode is set to BLEND.
9432
+ * The material.readAlphaFromChannel property defines which color channel to read the alpha values from.
9433
+ * The stored texels MUST NOT be premultiplied.
9434
+ * @param texture - The material color texture.
9435
+ @pre If the fourth component (A) is undefined, the texture MUST be sampled as having 1.0 in all components.
9436
+ */
9437
+ setColorTexture(texture: Systems.TextureInfo): void;
9438
+ /**
9439
+ * @description Gets the color texture.
9440
+ * @return The material color texture.
9441
+ */
9442
+ getColorTexture(): Systems.TextureInfo;
9443
+ /**
9444
+ * @description Sets the doubleSided property which specifies whether the material is double sided.
9445
+ @details When this value is false, back-face culling is enabled, i.e., only front-facing triangles are rendered.
9446
+ * When this value is true, back-face culling is disabled and double sided lighting is enabled.
9447
+ * @param doubleSided - The double sided value.
9448
+ */
9449
+ setDoubleSided(doubleSided: boolean): void;
9450
+ /**
9451
+ * @description Gets the double sided value.
9452
+ * @return The double sided value.
9453
+ */
9454
+ getDoubleSided(): boolean;
9455
+ /**
9456
+ * @description Sets whether the material is emissive, if not material should be lit by the scene lighting.
9457
+ * @param isEmissive - The emissive value.
9458
+ */
9459
+ setIsEmissive(isEmissive: boolean): void;
9460
+ /**
9461
+ * @description Gets whether the material is emissive, if not material should be lit by the scene lighting.
9462
+ * @return Bool
9463
+ */
9464
+ getIsEmissive(): boolean;
9465
+ /**
9466
+ * @description Sets the color channel to read the alpha values from.
9467
+ * @param colorChannel - The color channel to read the alpha values from.
9468
+ */
9469
+ setReadAlphaFromChannel(colorChannel: Systems.EColorChannel): void;
9470
+ /**
9471
+ * @description Gets the color channel to read the alpha values from.
9472
+ * @return The color channel to read the alpha values from.
9473
+ */
9474
+ getReadAlphaFromChannel(): Systems.EColorChannel;
9475
+ /**
9476
+ * @description Sets the mode to use for alpha blending.
9477
+ * @param mode - The mode to use for alpha blending.
9478
+ */
9479
+ setBlendMode(mode: Systems.EBlendMode): void;
9480
+ /**
9481
+ * @description Gets the alpha blend mode.
9482
+ * @return The alpha blend mode.
9483
+ */
9484
+ getBlendMode(): Systems.EBlendMode;
9485
+ /**
9486
+ * @description Sets the fresnel factor.
9487
+ * @param factor - The fresnel factor.
9488
+ */
9489
+ setFresnelFactor(factor: number): void;
9490
+ /**
9491
+ * @description Gets the fresnel factor.
9492
+ * @return The fresnel factor.
9493
+ */
9494
+ getFresnelFactor(): number;
9495
+ /**
9496
+ * @description Set the Material tint.
9497
+ * @param tint - The tint value.
9498
+ */
9499
+ setTint(tint: Common.Vector3): void;
9500
+ /**
9501
+ * @description Get the Material tint.
9502
+ * @return The tint value.
9503
+ */
9504
+ getTint(): Common.Vector3;
9505
+ /**
9506
+ * @description Set the alpha factor.
9507
+ * @param factor - The alpha factor.
9508
+ */
9509
+ setAlphaFactor(factor: number): void;
9510
+ /**
9511
+ * @description Get the alpha factor.
9512
+ * @return The alpha factor.
9513
+ */
9514
+ getAlphaFactor(): number;
9515
+ /**
9516
+ * @description Set the emissive intensity.
9517
+ * @param intensity - The emissive intensity.
9518
+ */
9519
+ setEmissiveIntensity(intensity: number): void;
9520
+ /**
9521
+ * @description Get the emissive intensity.
9522
+ * @return The emissive intensity.
9523
+ */
9524
+ getEmissiveIntensity(): number;
9525
+ /**
9526
+ * @description Set the alpha mask.
9527
+ * @param mask - The alpha mask.
9528
+ */
9529
+ setAlphaMask(mask: number): void;
9530
+ /**
9531
+ * @description Get the alpha mask.
9532
+ * @return The alpha mask.
9533
+ */
9534
+ getAlphaMask(): number;
9535
+ /**
9536
+ * @description Constructor which links the material to an asset.
9537
+ * @param name - The name of the material.
9538
+ * @param materialCollectionId - The asset collection which holds the associated material asset.
9539
+ * @param materialId - The asset where the material info is stored.
9540
+ */
9541
+ static create_name_materialCollectionId_materialId(name: string, materialCollectionId: string, materialId: string): AlphaVideoMaterial;
9542
+ delete(): void;
9543
+ static create(): AlphaVideoMaterial;
9544
+ }
9545
+ }
9360
9546
  export declare namespace Systems {
9361
9547
  /**
9362
9548
  @ingroup Asset System
@@ -9650,12 +9836,13 @@ export declare namespace Systems {
9650
9836
  /**
9651
9837
  * @description Creates a new material backed by an AssetCollection/Asset.
9652
9838
  * @param name - The name of the new material.
9839
+ * @param shaderType - The type of shader model the material is associated with.
9653
9840
  * @param spaceId - The space id this material is associated with.
9654
9841
  * @param metadata - The metadata to be associated with the created material.
9655
9842
  * @param assetTags - Tags to be associated with the created material.
9656
9843
  * @param callback - Callback when asynchronous task finishes.
9657
9844
  */
9658
- createMaterial(name: string, spaceId: string, metadata: Common.Map<string, string>, assetTags: Common.Array<string>): Promise<Systems.GLTFMaterialResult>;
9845
+ createMaterial(name: string, shaderType: Systems.EShaderType, spaceId: string, metadata: Common.Map<string, string>, assetTags: Common.Array<string>): Promise<Systems.MaterialResult>;
9659
9846
  /**
9660
9847
  * @description Updates an existing material's properties.
9661
9848
  * The material should be retrieved through GetMaterials or GetMaterial.
@@ -9664,27 +9851,27 @@ export declare namespace Systems {
9664
9851
  * @param material - The material to update
9665
9852
  * @param callback - Callback when asynchronous task finishes.
9666
9853
  */
9667
- updateMaterial(material: Systems.GLTFMaterial): Promise<Systems.NullResult>;
9854
+ updateMaterial(material: Systems.Material): Promise<Systems.NullResult>;
9668
9855
  /**
9669
9856
  * @description Deletes a given material.
9670
9857
  * The material should be retrieved through GetMaterials or GetMaterial.
9671
9858
  * @param material - The material to delete
9672
9859
  * @param callback - Callback when asynchronous task finishes.
9673
9860
  */
9674
- deleteMaterial(material: Systems.GLTFMaterial): Promise<Systems.NullResult>;
9861
+ deleteMaterial(material: Systems.Material): Promise<Systems.NullResult>;
9675
9862
  /**
9676
9863
  * @description Gets all materials associated with the given space.
9677
9864
  * @param spaceId - The space id the material is associated with.
9678
9865
  * @param callback - Callback when asynchronous task finishes.
9679
9866
  */
9680
- getMaterials(spaceId: string): Promise<Systems.GLTFMaterialsResult>;
9867
+ getMaterials(spaceId: string): Promise<Systems.MaterialsResult>;
9681
9868
  /**
9682
9869
  * @description Gets a material using its AssetCollection and Asset Id.
9683
9870
  * @param assetCollectionId - The asset collection id this material is associated with.
9684
9871
  * @param assetId - The asset id this material is associated with.
9685
9872
  * @param callback - Callback when asynchronous task finishes.
9686
9873
  */
9687
- getMaterial(assetCollectionId: string, assetId: string): Promise<Systems.GLTFMaterialResult>;
9874
+ getMaterial(assetCollectionId: string, assetId: string): Promise<Systems.MaterialResult>;
9688
9875
  /**
9689
9876
  * @description Sets a callback for an asset changed event. Triggered when assets, such as textures or meshes, are modified
9690
9877
  * @param callback - Callback to receive data for the asset that has been changed.
@@ -9715,212 +9902,215 @@ export declare namespace Systems {
9715
9902
  constructor(pointer: NativePointer);
9716
9903
  static fromMaterial(baseInstance: Systems.Material): Systems.GLTFMaterial;
9717
9904
  /**
9718
- * Sets how to alpha value is interpreted
9719
- * @param mode - EAlphaMode
9905
+ * @description Sets the alpha mode which determines how the alpha value is interpreted.
9906
+ * @param mode - The alpha mode to set.
9720
9907
  */
9721
9908
  setAlphaMode(mode: Systems.EAlphaMode): void;
9722
9909
  /**
9723
- * Gets how to alpha value is interpreted
9724
- * @return EAlphaMode
9910
+ * @description Gets the alpha mode which determines how the alpha value is interpreted.
9911
+ * @return The alpha mode.
9725
9912
  */
9726
9913
  getAlphaMode(): Systems.EAlphaMode;
9727
9914
  /**
9728
- * @description Sets the alpha cutoff value
9729
- * When alphaMode is set to MASK the alphaCutoff property specifies the cutoff threshold.
9915
+ * @description Sets the alpha cutoff value.
9916
+ @details When alphaMode is set to MASK the alphaCutoff property specifies the cutoff threshold.
9730
9917
  * If the alpha value is greater than or equal to the alphaCutoff value then it is rendered as fully opaque,
9731
- * otherwise, it is rendered as fully transparent. alphaCutoff value is ignored for other modes.
9732
- * @param cutoff - Float
9918
+ * otherwise, it is rendered as fully transparent. The alphaCutoff value is ignored for other modes.
9919
+ * @param cutoff - The alpha cutoff value to set.
9733
9920
  */
9734
9921
  setAlphaCutoff(cutoff: number): void;
9735
9922
  /**
9736
- * Gets the alpha cutoff value
9737
- * @return Float
9923
+ * @description Gets the alpha cutoff value.
9924
+ * @return The alpha cutoff value.
9738
9925
  */
9739
9926
  getAlphaCutoff(): number;
9740
9927
  /**
9741
9928
  * @description Sets the doubleSided property which specifies whether the material is double sided.
9742
- * When this value is false, back - face culling is enabled, i.e., only front-facing triangles are rendered.
9929
+ @details When this value is false, back - face culling is enabled, i.e., only front-facing triangles are rendered.
9743
9930
  * When this value is true, back - face culling is disabled and double sided lighting is enabled.
9744
- * @param doubleSided - Bool
9931
+ * @param doubleSided - The double sided value to set.
9745
9932
  */
9746
9933
  setDoubleSided(doubleSided: boolean): void;
9747
9934
  /**
9748
- * @description Gets the double sided value
9749
- * @return Bool
9935
+ * @description Gets the double sided value.
9936
+ * @return The double sided value.
9750
9937
  */
9751
9938
  getDoubleSided(): boolean;
9752
9939
  /**
9753
9940
  * @description Sets the factors for the base color of the material.
9754
- * This value defines linear multipliers for the sampled texels of the base color texture.
9755
- * @param factor - Const csp::common::vector4&
9941
+ @details This value defines linear multipliers for the sampled texels of the base color texture.
9942
+ * @param factor - The base color factor to set.
9756
9943
  */
9757
9944
  setBaseColorFactor(factor: Common.Vector4): void;
9758
9945
  /**
9759
- * @description Gets the factor of the base color texture
9760
- * @return Csp::common::vector4&
9946
+ * @description Gets the factor of the base color texture.
9947
+ * @return The base color factor.
9761
9948
  */
9762
9949
  getBaseColorFactor(): Common.Vector4;
9763
9950
  /**
9764
9951
  * @description Sets the factor for the metalness of the material.
9765
- * This value defines a linear multiplier for the sampled metalness values of the metallic-roughness texture.
9766
- * @param factor - Float
9952
+ @details This value defines a linear multiplier for the sampled metalness values of the metallic-roughness texture.
9953
+ * @param factor - The metallic factor to set.
9767
9954
  */
9768
9955
  setMetallicFactor(factor: number): void;
9769
9956
  /**
9770
- * @description Gets the factor of the metallic texture
9771
- * @return Float
9957
+ * @description Gets the factor of the metallic texture.
9958
+ * @return The metallic factor.
9772
9959
  */
9773
9960
  getMetallicFactor(): number;
9774
9961
  /**
9775
9962
  * @description Sets the factor for the roughness of the material.
9776
- * This value defines a linear multiplier for the sampled roughness values of the metallic-roughness texture.
9777
- * @param factor - Float
9963
+ @details This value defines a linear multiplier for the sampled roughness values of the metallic-roughness texture.
9964
+ * @param factor - The roughness factor to set.
9778
9965
  */
9779
9966
  setRoughnessFactor(factor: number): void;
9780
9967
  /**
9781
- * @description Gets the factor of the roughness texture
9782
- * @return Float
9968
+ * @description Gets the factor of the roughness texture.
9969
+ * @return The roughness factor.
9783
9970
  */
9784
9971
  getRoughnessFactor(): number;
9785
9972
  /**
9786
9973
  * @description Sets factors for the emissive color of the material.
9787
- * This value defines linear multipliers for the sampled texels of the emissive texture.
9788
- * @param factor - Const csp::common::vector3&
9974
+ @details This value defines linear multipliers for the sampled texels of the emissive texture.
9975
+ * @param factor - The emissive factor to set.
9789
9976
  */
9790
9977
  setEmissiveFactor(factor: Common.Vector3): void;
9791
9978
  /**
9792
- * @description Gets the factor of the emissive color texture
9793
- * @return Csp::common::vector3&
9979
+ * @description Gets the factor of the emissive color texture.
9980
+ * @return The emissive factor.
9794
9981
  */
9795
9982
  getEmissiveFactor(): Common.Vector3;
9796
9983
  /**
9797
- * @description Sets the base color texture. The first three components (RGB) MUST be encoded with the sRGB transfer function.
9798
- * They specify the base color of the material.
9984
+ * @description Sets the base color texture.
9985
+ @details The first three components (RGB) MUST be encoded with the sRGB transfer function. They specify the base color of the material.
9799
9986
  * If the fourth component (A) is present, it represents the linear alpha coverage of the material.
9800
9987
  * Otherwise, the alpha coverage is equal to 1.0. The material.alphaMode property specifies how alpha is interpreted.
9801
9988
  * The stored texels MUST NOT be premultiplied.
9802
9989
  * When undefined, the texture MUST be sampled as having 1.0 in all components.
9803
- * @param texture - Const textureinfo&
9990
+ * @param texture - The base color texture to set.
9804
9991
  */
9805
9992
  setBaseColorTexture(texture: Systems.TextureInfo): void;
9806
9993
  /**
9807
- * @description Gets the base color texture
9808
- * @return Const textureinfo&
9994
+ * @description Gets the base color texture.
9995
+ * @return The base color texture.
9809
9996
  */
9810
9997
  getBaseColorTexture(): Systems.TextureInfo;
9811
9998
  /**
9812
9999
  * @description Sets the metallic-roughness texture.
9813
- * The metalness values are sampled from the B channel.
10000
+ @details The metalness values are sampled from the B channel.
9814
10001
  * The roughness values are sampled from the G channel.
9815
10002
  * These values MUST be encoded with a linear transfer function.
9816
10003
  * If other channels are present (R or A), they MUST be ignored for metallic-roughness calculations.
9817
10004
  * When undefined, the texture MUST be sampled as having 1.0 in G and B components.
9818
- * @param texture - Const textureinfo&
10005
+ * @param texture - The metallic-roughness texture to set.
9819
10006
  */
9820
10007
  setMetallicRoughnessTexture(texture: Systems.TextureInfo): void;
9821
10008
  /**
9822
- * @description Gets the metallic-roughness texture
9823
- * @return Const textureinfo&
10009
+ * @description Gets the metallic-roughness texture.
10010
+ * @return The metallic-roughness texture.
9824
10011
  */
9825
10012
  getMetallicRoughnessTexture(): Systems.TextureInfo;
9826
10013
  /**
9827
10014
  * @description Sets the tangent space normal texture.
9828
- * The texture encodes RGB components with linear transfer function.
10015
+ @details The texture encodes RGB components with linear transfer function.
9829
10016
  * Each texel represents the XYZ components of a normal vector in tangent space.
9830
10017
  * The normal vectors use the convention +X is right and +Y is up. +Z points toward the viewer.
9831
10018
  * If a fourth component (A) is present, it MUST be ignored. When undefined, the material does not have a tangent space normal texture.
9832
- * @param texture - Const textureinfo&
10019
+ * @param texture - The normal texture to set.
9833
10020
  */
9834
10021
  setNormalTexture(texture: Systems.TextureInfo): void;
9835
10022
  /**
9836
10023
  * @description Gets the tangent space normal texture.
9837
- * @return Const textureinfo&
10024
+ * @return The normal texture.
9838
10025
  */
9839
10026
  getNormalTexture(): Systems.TextureInfo;
9840
10027
  /**
9841
10028
  * @description Sets the occlusion texture.
9842
- * The occlusion values are linearly sampled from the R channel.
10029
+ @details The occlusion values are linearly sampled from the R channel.
9843
10030
  * Higher values indicate areas that receive full indirect lighting and lower values indicate no indirect lighting.
9844
10031
  * If other channels are present (GBA), they MUST be ignored for occlusion calculations.
9845
10032
  * When undefined, the material does not have an occlusion texture.
9846
- * @param texture - Const textureinfo&
10033
+ * @param texture - The occlusion texture to set.
9847
10034
  */
9848
10035
  setOcclusionTexture(texture: Systems.TextureInfo): void;
9849
10036
  /**
9850
- * @description Gets the occlusion texture
9851
- * @return Const textureinfo&
10037
+ * @description Gets the occlusion texture.
10038
+ * @return The occlusion texture.
9852
10039
  */
9853
10040
  getOcclusionTexture(): Systems.TextureInfo;
9854
10041
  /**
9855
10042
  * @description Sets the emissive texture.
9856
- * It controls the color and intensity of the light being emitted by the material.
10043
+ @details It controls the color and intensity of the light being emitted by the material.
9857
10044
  * This texture contains RGB components encoded with the sRGB transfer function.
9858
10045
  * If a fourth component (A) is present, it MUST be ignored.
9859
10046
  * When undefined, the texture MUST be sampled as having 1.0 in RGB components.
9860
- * @param texture - Const textureinfo&
10047
+ * @param texture - The emissive texture to set.
9861
10048
  */
9862
10049
  setEmissiveTexture(texture: Systems.TextureInfo): void;
9863
10050
  /**
9864
- * @description Gets the emissive texture
9865
- * @return Const textureinfo&
10051
+ * @description Gets the emissive texture.
10052
+ * @return The emissive texture.
9866
10053
  */
9867
10054
  getEmissiveTexture(): Systems.TextureInfo;
9868
10055
  /**
9869
- * @description Constructor which links the material to an asset
10056
+ * @description Constructor which links the material to an asset.
9870
10057
  * @param name - The name of the material.
9871
- * @param assetCollectionId - The asset collection where the material info is stored
9872
- * @param assetId - The asset where the material info is stored
10058
+ * @param materialCollectionId - The asset collection which holds the associated material asset.
10059
+ * @param materialId - The asset where the material info is stored.
9873
10060
  */
9874
- static create_name_assetCollectionId_assetId(name: string, assetCollectionId: string, assetId: string): GLTFMaterial;
9875
- static create(): GLTFMaterial;
10061
+ static create_name_materialCollectionId_materialId(name: string, materialCollectionId: string, materialId: string): GLTFMaterial;
9876
10062
  delete(): void;
10063
+ static create(): GLTFMaterial;
9877
10064
  }
9878
10065
  }
9879
10066
  export declare namespace Systems {
9880
10067
  /**
9881
10068
  @ingroup Asset System
9882
- * @description Data class used to contain information when attempting to download material data.
10069
+ * @description Data class used to contain information when attempting to download LOD chain data.
9883
10070
  */
9884
- class GLTFMaterialResult extends Systems.ResultBase implements INativeResource {
10071
+ class LODChainResult extends Systems.ResultBase implements INativeResource {
9885
10072
  /** @internal */
9886
10073
  constructor(pointer: NativePointer);
9887
- static fromResultBase(baseInstance: Systems.ResultBase): Systems.GLTFMaterialResult;
10074
+ static fromResultBase(baseInstance: Systems.ResultBase): Systems.LODChainResult;
9888
10075
  /**
9889
- * @description Retreives the GLTFMaterial from the result.
10076
+ * @description Retreives the LODChain from the result.
9890
10077
  */
9891
- getGLTFMaterial(): Systems.GLTFMaterial;
10078
+ getLODChain(): Systems.LODChain;
9892
10079
  delete(): void;
9893
10080
  }
9894
10081
  }
9895
10082
  export declare namespace Systems {
9896
10083
  /**
9897
10084
  @ingroup Asset System
9898
- * @description Data class used to contain information when attempting to download a collection of material data.
10085
+ * @description Result data class that contains downloaded material data.
9899
10086
  */
9900
- class GLTFMaterialsResult extends Systems.ResultBase implements INativeResource {
10087
+ class MaterialResult extends Systems.ResultBase implements INativeResource {
9901
10088
  /** @internal */
9902
10089
  constructor(pointer: NativePointer);
9903
- static fromResultBase(baseInstance: Systems.ResultBase): Systems.GLTFMaterialsResult;
10090
+ static fromResultBase(baseInstance: Systems.ResultBase): Systems.MaterialResult;
9904
10091
  /**
9905
- * @description Retreives the GLTFMaterial from the result.
10092
+ * @description Retrieves the Material from the result.
10093
+ * @return Returns a pointer to the Material object. The caller should take ownership of the pointer.
9906
10094
  */
9907
- getGLTFMaterials(): Common.Array<Systems.GLTFMaterial>;
10095
+ getMaterial(): Systems.Material;
9908
10096
  delete(): void;
9909
10097
  }
9910
10098
  }
9911
10099
  export declare namespace Systems {
9912
10100
  /**
9913
10101
  @ingroup Asset System
9914
- * @description Data class used to contain information when attempting to download LOD chain data.
10102
+ * @description Result data class that contains a collection of downloaded material data.
9915
10103
  */
9916
- class LODChainResult extends Systems.ResultBase implements INativeResource {
10104
+ class MaterialsResult extends Systems.ResultBase implements INativeResource {
9917
10105
  /** @internal */
9918
10106
  constructor(pointer: NativePointer);
9919
- static fromResultBase(baseInstance: Systems.ResultBase): Systems.LODChainResult;
10107
+ static fromResultBase(baseInstance: Systems.ResultBase): Systems.MaterialsResult;
9920
10108
  /**
9921
- * @description Retreives the LODChain from the result.
10109
+ * @description Retreives an Array of Materials from the result.
10110
+ * @return Returns a const pointer to an Array of Material class pointers. The caller should take ownership of the
10111
+ * pointer.
9922
10112
  */
9923
- getLODChain(): Systems.LODChain;
10113
+ getMaterials(): Common.Array<Systems.Material>;
9924
10114
  delete(): void;
9925
10115
  }
9926
10116
  }
@@ -11846,6 +12036,12 @@ export declare namespace Systems {
11846
12036
  * @param callback - Callback to call when a response is received
11847
12037
  */
11848
12038
  getAgoraUserToken(params: Systems.AgoraUserTokenParams): Promise<Systems.StringResult>;
12039
+ /**
12040
+ * @description Post Service Proxy to perform specified operation of specified service
12041
+ * @param params - Params to specify service, operation, set help and parameters
12042
+ * @param callback - Callback to call when a response is received
12043
+ */
12044
+ postServiceProxy(params: Systems.TokenInfoParams): Promise<Systems.StringResult>;
11849
12045
  /**
11850
12046
  * @description Re-send user verification email
11851
12047
  * @param inEmail - User's email address
@@ -11898,8 +12094,8 @@ export declare namespace Common {
11898
12094
  static ofcsp_systems_AssetCollection(): Array<Systems.AssetCollection>;
11899
12095
  static ofcsp_systems_EAssetCollectionType(): Array<Systems.EAssetCollectionType>;
11900
12096
  static ofcsp_systems_EAssetType(): Array<Systems.EAssetType>;
11901
- static ofcsp_systems_GLTFMaterial(): Array<Systems.GLTFMaterial>;
11902
12097
  static ofcsp_systems_LODAsset(): Array<Systems.LODAsset>;
12098
+ static ofcsp_systems_Material(): Array<Systems.Material>;
11903
12099
  static ofcsp_systems_VariantOptionInfo(): Array<Systems.VariantOptionInfo>;
11904
12100
  static ofcsp_systems_ProductVariantInfo(): Array<Systems.ProductVariantInfo>;
11905
12101
  static ofcsp_systems_ProductMediaInfo(): Array<Systems.ProductMediaInfo>;
@@ -11939,8 +12135,8 @@ export declare namespace Common {
11939
12135
  static ofcsp_systems_AssetCollection_number(size: number): Array<Systems.AssetCollection>;
11940
12136
  static ofcsp_systems_EAssetCollectionType_number(size: number): Array<Systems.EAssetCollectionType>;
11941
12137
  static ofcsp_systems_EAssetType_number(size: number): Array<Systems.EAssetType>;
11942
- static ofcsp_systems_GLTFMaterial_number(size: number): Array<Systems.GLTFMaterial>;
11943
12138
  static ofcsp_systems_LODAsset_number(size: number): Array<Systems.LODAsset>;
12139
+ static ofcsp_systems_Material_number(size: number): Array<Systems.Material>;
11944
12140
  static ofcsp_systems_VariantOptionInfo_number(size: number): Array<Systems.VariantOptionInfo>;
11945
12141
  static ofcsp_systems_ProductVariantInfo_number(size: number): Array<Systems.ProductVariantInfo>;
11946
12142
  static ofcsp_systems_ProductMediaInfo_number(size: number): Array<Systems.ProductMediaInfo>;