connected-spaces-platform.web 5.12.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.
- package/Debug/ConnectedSpacesPlatform_WASM.js +84 -32
- package/Debug/ConnectedSpacesPlatform_WASM.wasm +0 -0
- package/Debug/ConnectedSpacesPlatform_WASM.wasm.debug.wasm +0 -0
- package/README.md +1 -1
- package/Release/ConnectedSpacesPlatform_WASM.js +1 -1
- package/Release/ConnectedSpacesPlatform_WASM.wasm +0 -0
- package/connectedspacesplatform.d.ts +275 -95
- package/connectedspacesplatform.js +449 -147
- package/connectedspacesplatform.js.map +1 -1
- package/connectedspacesplatform.ts +743 -210
- package/package.json +1 -1
|
Binary file
|
|
@@ -969,9 +969,20 @@ export declare namespace Systems {
|
|
|
969
969
|
}
|
|
970
970
|
export declare namespace Systems {
|
|
971
971
|
/**
|
|
972
|
-
|
|
973
|
-
|
|
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
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
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 {
|
|
@@ -5159,36 +5187,55 @@ export declare namespace Systems {
|
|
|
5159
5187
|
}
|
|
5160
5188
|
export declare namespace Systems {
|
|
5161
5189
|
/**
|
|
5162
|
-
@ingroup Asset System
|
|
5190
|
+
@ingroup Asset System.
|
|
5163
5191
|
* @description Base class for a material.
|
|
5164
5192
|
*/
|
|
5165
5193
|
class Material extends NativeClassWrapper implements INativeResource {
|
|
5166
5194
|
/** @internal */
|
|
5167
5195
|
constructor(pointer: NativePointer);
|
|
5168
5196
|
/**
|
|
5169
|
-
* @description Gets the user-defined name of the material
|
|
5170
|
-
* @return
|
|
5197
|
+
* @description Gets the user-defined name of the material.
|
|
5198
|
+
* @return Returns the material name.
|
|
5171
5199
|
*/
|
|
5172
5200
|
getName(): string;
|
|
5173
5201
|
/**
|
|
5174
|
-
* @description Gets the
|
|
5175
|
-
* @return
|
|
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.
|
|
5176
5214
|
*/
|
|
5177
5215
|
getMaterialCollectionId(): string;
|
|
5178
5216
|
/**
|
|
5179
|
-
* @description Gets the id for the material
|
|
5180
|
-
* @return
|
|
5217
|
+
* @description Gets the id for the material.
|
|
5218
|
+
* @return Returns the material id.
|
|
5181
5219
|
*/
|
|
5182
5220
|
getMaterialId(): string;
|
|
5183
5221
|
/**
|
|
5184
|
-
* @description
|
|
5222
|
+
* @description Constructs a material bound to an AssetCollection and Asset.
|
|
5185
5223
|
* @param name - The name of the material.
|
|
5186
|
-
* @param materialCollectionId - The asset collection
|
|
5187
|
-
* @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.
|
|
5188
5226
|
*/
|
|
5189
5227
|
static create_name_materialCollectionId_materialId(name: string, materialCollectionId: string, materialId: string): Material;
|
|
5190
|
-
|
|
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;
|
|
5191
5237
|
delete(): void;
|
|
5238
|
+
static create(): Material;
|
|
5192
5239
|
}
|
|
5193
5240
|
}
|
|
5194
5241
|
export declare namespace Systems {
|
|
@@ -9367,6 +9414,135 @@ export declare namespace Systems {
|
|
|
9367
9414
|
delete(): void;
|
|
9368
9415
|
}
|
|
9369
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
|
+
}
|
|
9370
9546
|
export declare namespace Systems {
|
|
9371
9547
|
/**
|
|
9372
9548
|
@ingroup Asset System
|
|
@@ -9660,12 +9836,13 @@ export declare namespace Systems {
|
|
|
9660
9836
|
/**
|
|
9661
9837
|
* @description Creates a new material backed by an AssetCollection/Asset.
|
|
9662
9838
|
* @param name - The name of the new material.
|
|
9839
|
+
* @param shaderType - The type of shader model the material is associated with.
|
|
9663
9840
|
* @param spaceId - The space id this material is associated with.
|
|
9664
9841
|
* @param metadata - The metadata to be associated with the created material.
|
|
9665
9842
|
* @param assetTags - Tags to be associated with the created material.
|
|
9666
9843
|
* @param callback - Callback when asynchronous task finishes.
|
|
9667
9844
|
*/
|
|
9668
|
-
createMaterial(name: string, spaceId: string, metadata: Common.Map<string, string>, assetTags: Common.Array<string>): Promise<Systems.
|
|
9845
|
+
createMaterial(name: string, shaderType: Systems.EShaderType, spaceId: string, metadata: Common.Map<string, string>, assetTags: Common.Array<string>): Promise<Systems.MaterialResult>;
|
|
9669
9846
|
/**
|
|
9670
9847
|
* @description Updates an existing material's properties.
|
|
9671
9848
|
* The material should be retrieved through GetMaterials or GetMaterial.
|
|
@@ -9674,27 +9851,27 @@ export declare namespace Systems {
|
|
|
9674
9851
|
* @param material - The material to update
|
|
9675
9852
|
* @param callback - Callback when asynchronous task finishes.
|
|
9676
9853
|
*/
|
|
9677
|
-
updateMaterial(material: Systems.
|
|
9854
|
+
updateMaterial(material: Systems.Material): Promise<Systems.NullResult>;
|
|
9678
9855
|
/**
|
|
9679
9856
|
* @description Deletes a given material.
|
|
9680
9857
|
* The material should be retrieved through GetMaterials or GetMaterial.
|
|
9681
9858
|
* @param material - The material to delete
|
|
9682
9859
|
* @param callback - Callback when asynchronous task finishes.
|
|
9683
9860
|
*/
|
|
9684
|
-
deleteMaterial(material: Systems.
|
|
9861
|
+
deleteMaterial(material: Systems.Material): Promise<Systems.NullResult>;
|
|
9685
9862
|
/**
|
|
9686
9863
|
* @description Gets all materials associated with the given space.
|
|
9687
9864
|
* @param spaceId - The space id the material is associated with.
|
|
9688
9865
|
* @param callback - Callback when asynchronous task finishes.
|
|
9689
9866
|
*/
|
|
9690
|
-
getMaterials(spaceId: string): Promise<Systems.
|
|
9867
|
+
getMaterials(spaceId: string): Promise<Systems.MaterialsResult>;
|
|
9691
9868
|
/**
|
|
9692
9869
|
* @description Gets a material using its AssetCollection and Asset Id.
|
|
9693
9870
|
* @param assetCollectionId - The asset collection id this material is associated with.
|
|
9694
9871
|
* @param assetId - The asset id this material is associated with.
|
|
9695
9872
|
* @param callback - Callback when asynchronous task finishes.
|
|
9696
9873
|
*/
|
|
9697
|
-
getMaterial(assetCollectionId: string, assetId: string): Promise<Systems.
|
|
9874
|
+
getMaterial(assetCollectionId: string, assetId: string): Promise<Systems.MaterialResult>;
|
|
9698
9875
|
/**
|
|
9699
9876
|
* @description Sets a callback for an asset changed event. Triggered when assets, such as textures or meshes, are modified
|
|
9700
9877
|
* @param callback - Callback to receive data for the asset that has been changed.
|
|
@@ -9725,212 +9902,215 @@ export declare namespace Systems {
|
|
|
9725
9902
|
constructor(pointer: NativePointer);
|
|
9726
9903
|
static fromMaterial(baseInstance: Systems.Material): Systems.GLTFMaterial;
|
|
9727
9904
|
/**
|
|
9728
|
-
* Sets how
|
|
9729
|
-
* @param mode -
|
|
9905
|
+
* @description Sets the alpha mode which determines how the alpha value is interpreted.
|
|
9906
|
+
* @param mode - The alpha mode to set.
|
|
9730
9907
|
*/
|
|
9731
9908
|
setAlphaMode(mode: Systems.EAlphaMode): void;
|
|
9732
9909
|
/**
|
|
9733
|
-
* Gets how
|
|
9734
|
-
* @return
|
|
9910
|
+
* @description Gets the alpha mode which determines how the alpha value is interpreted.
|
|
9911
|
+
* @return The alpha mode.
|
|
9735
9912
|
*/
|
|
9736
9913
|
getAlphaMode(): Systems.EAlphaMode;
|
|
9737
9914
|
/**
|
|
9738
|
-
* @description Sets the alpha cutoff value
|
|
9739
|
-
|
|
9915
|
+
* @description Sets the alpha cutoff value.
|
|
9916
|
+
@details When alphaMode is set to MASK the alphaCutoff property specifies the cutoff threshold.
|
|
9740
9917
|
* If the alpha value is greater than or equal to the alphaCutoff value then it is rendered as fully opaque,
|
|
9741
|
-
* otherwise, it is rendered as fully transparent. alphaCutoff value is ignored for other modes.
|
|
9742
|
-
* @param cutoff -
|
|
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.
|
|
9743
9920
|
*/
|
|
9744
9921
|
setAlphaCutoff(cutoff: number): void;
|
|
9745
9922
|
/**
|
|
9746
|
-
* Gets the alpha cutoff value
|
|
9747
|
-
* @return
|
|
9923
|
+
* @description Gets the alpha cutoff value.
|
|
9924
|
+
* @return The alpha cutoff value.
|
|
9748
9925
|
*/
|
|
9749
9926
|
getAlphaCutoff(): number;
|
|
9750
9927
|
/**
|
|
9751
9928
|
* @description Sets the doubleSided property which specifies whether the material is double sided.
|
|
9752
|
-
|
|
9929
|
+
@details When this value is false, back - face culling is enabled, i.e., only front-facing triangles are rendered.
|
|
9753
9930
|
* When this value is true, back - face culling is disabled and double sided lighting is enabled.
|
|
9754
|
-
* @param doubleSided -
|
|
9931
|
+
* @param doubleSided - The double sided value to set.
|
|
9755
9932
|
*/
|
|
9756
9933
|
setDoubleSided(doubleSided: boolean): void;
|
|
9757
9934
|
/**
|
|
9758
|
-
* @description Gets the double sided value
|
|
9759
|
-
* @return
|
|
9935
|
+
* @description Gets the double sided value.
|
|
9936
|
+
* @return The double sided value.
|
|
9760
9937
|
*/
|
|
9761
9938
|
getDoubleSided(): boolean;
|
|
9762
9939
|
/**
|
|
9763
9940
|
* @description Sets the factors for the base color of the material.
|
|
9764
|
-
|
|
9765
|
-
* @param factor -
|
|
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.
|
|
9766
9943
|
*/
|
|
9767
9944
|
setBaseColorFactor(factor: Common.Vector4): void;
|
|
9768
9945
|
/**
|
|
9769
|
-
* @description Gets the factor of the base color texture
|
|
9770
|
-
* @return
|
|
9946
|
+
* @description Gets the factor of the base color texture.
|
|
9947
|
+
* @return The base color factor.
|
|
9771
9948
|
*/
|
|
9772
9949
|
getBaseColorFactor(): Common.Vector4;
|
|
9773
9950
|
/**
|
|
9774
9951
|
* @description Sets the factor for the metalness of the material.
|
|
9775
|
-
|
|
9776
|
-
* @param factor -
|
|
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.
|
|
9777
9954
|
*/
|
|
9778
9955
|
setMetallicFactor(factor: number): void;
|
|
9779
9956
|
/**
|
|
9780
|
-
* @description Gets the factor of the metallic texture
|
|
9781
|
-
* @return
|
|
9957
|
+
* @description Gets the factor of the metallic texture.
|
|
9958
|
+
* @return The metallic factor.
|
|
9782
9959
|
*/
|
|
9783
9960
|
getMetallicFactor(): number;
|
|
9784
9961
|
/**
|
|
9785
9962
|
* @description Sets the factor for the roughness of the material.
|
|
9786
|
-
|
|
9787
|
-
* @param factor -
|
|
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.
|
|
9788
9965
|
*/
|
|
9789
9966
|
setRoughnessFactor(factor: number): void;
|
|
9790
9967
|
/**
|
|
9791
|
-
* @description Gets the factor of the roughness texture
|
|
9792
|
-
* @return
|
|
9968
|
+
* @description Gets the factor of the roughness texture.
|
|
9969
|
+
* @return The roughness factor.
|
|
9793
9970
|
*/
|
|
9794
9971
|
getRoughnessFactor(): number;
|
|
9795
9972
|
/**
|
|
9796
9973
|
* @description Sets factors for the emissive color of the material.
|
|
9797
|
-
|
|
9798
|
-
* @param factor -
|
|
9974
|
+
@details This value defines linear multipliers for the sampled texels of the emissive texture.
|
|
9975
|
+
* @param factor - The emissive factor to set.
|
|
9799
9976
|
*/
|
|
9800
9977
|
setEmissiveFactor(factor: Common.Vector3): void;
|
|
9801
9978
|
/**
|
|
9802
|
-
* @description Gets the factor of the emissive color texture
|
|
9803
|
-
* @return
|
|
9979
|
+
* @description Gets the factor of the emissive color texture.
|
|
9980
|
+
* @return The emissive factor.
|
|
9804
9981
|
*/
|
|
9805
9982
|
getEmissiveFactor(): Common.Vector3;
|
|
9806
9983
|
/**
|
|
9807
|
-
* @description Sets the base color texture.
|
|
9808
|
-
|
|
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.
|
|
9809
9986
|
* If the fourth component (A) is present, it represents the linear alpha coverage of the material.
|
|
9810
9987
|
* Otherwise, the alpha coverage is equal to 1.0. The material.alphaMode property specifies how alpha is interpreted.
|
|
9811
9988
|
* The stored texels MUST NOT be premultiplied.
|
|
9812
9989
|
* When undefined, the texture MUST be sampled as having 1.0 in all components.
|
|
9813
|
-
* @param texture -
|
|
9990
|
+
* @param texture - The base color texture to set.
|
|
9814
9991
|
*/
|
|
9815
9992
|
setBaseColorTexture(texture: Systems.TextureInfo): void;
|
|
9816
9993
|
/**
|
|
9817
|
-
* @description Gets the base color texture
|
|
9818
|
-
* @return
|
|
9994
|
+
* @description Gets the base color texture.
|
|
9995
|
+
* @return The base color texture.
|
|
9819
9996
|
*/
|
|
9820
9997
|
getBaseColorTexture(): Systems.TextureInfo;
|
|
9821
9998
|
/**
|
|
9822
9999
|
* @description Sets the metallic-roughness texture.
|
|
9823
|
-
|
|
10000
|
+
@details The metalness values are sampled from the B channel.
|
|
9824
10001
|
* The roughness values are sampled from the G channel.
|
|
9825
10002
|
* These values MUST be encoded with a linear transfer function.
|
|
9826
10003
|
* If other channels are present (R or A), they MUST be ignored for metallic-roughness calculations.
|
|
9827
10004
|
* When undefined, the texture MUST be sampled as having 1.0 in G and B components.
|
|
9828
|
-
* @param texture -
|
|
10005
|
+
* @param texture - The metallic-roughness texture to set.
|
|
9829
10006
|
*/
|
|
9830
10007
|
setMetallicRoughnessTexture(texture: Systems.TextureInfo): void;
|
|
9831
10008
|
/**
|
|
9832
|
-
* @description Gets the metallic-roughness texture
|
|
9833
|
-
* @return
|
|
10009
|
+
* @description Gets the metallic-roughness texture.
|
|
10010
|
+
* @return The metallic-roughness texture.
|
|
9834
10011
|
*/
|
|
9835
10012
|
getMetallicRoughnessTexture(): Systems.TextureInfo;
|
|
9836
10013
|
/**
|
|
9837
10014
|
* @description Sets the tangent space normal texture.
|
|
9838
|
-
|
|
10015
|
+
@details The texture encodes RGB components with linear transfer function.
|
|
9839
10016
|
* Each texel represents the XYZ components of a normal vector in tangent space.
|
|
9840
10017
|
* The normal vectors use the convention +X is right and +Y is up. +Z points toward the viewer.
|
|
9841
10018
|
* If a fourth component (A) is present, it MUST be ignored. When undefined, the material does not have a tangent space normal texture.
|
|
9842
|
-
* @param texture -
|
|
10019
|
+
* @param texture - The normal texture to set.
|
|
9843
10020
|
*/
|
|
9844
10021
|
setNormalTexture(texture: Systems.TextureInfo): void;
|
|
9845
10022
|
/**
|
|
9846
10023
|
* @description Gets the tangent space normal texture.
|
|
9847
|
-
* @return
|
|
10024
|
+
* @return The normal texture.
|
|
9848
10025
|
*/
|
|
9849
10026
|
getNormalTexture(): Systems.TextureInfo;
|
|
9850
10027
|
/**
|
|
9851
10028
|
* @description Sets the occlusion texture.
|
|
9852
|
-
|
|
10029
|
+
@details The occlusion values are linearly sampled from the R channel.
|
|
9853
10030
|
* Higher values indicate areas that receive full indirect lighting and lower values indicate no indirect lighting.
|
|
9854
10031
|
* If other channels are present (GBA), they MUST be ignored for occlusion calculations.
|
|
9855
10032
|
* When undefined, the material does not have an occlusion texture.
|
|
9856
|
-
* @param texture -
|
|
10033
|
+
* @param texture - The occlusion texture to set.
|
|
9857
10034
|
*/
|
|
9858
10035
|
setOcclusionTexture(texture: Systems.TextureInfo): void;
|
|
9859
10036
|
/**
|
|
9860
|
-
* @description Gets the occlusion texture
|
|
9861
|
-
* @return
|
|
10037
|
+
* @description Gets the occlusion texture.
|
|
10038
|
+
* @return The occlusion texture.
|
|
9862
10039
|
*/
|
|
9863
10040
|
getOcclusionTexture(): Systems.TextureInfo;
|
|
9864
10041
|
/**
|
|
9865
10042
|
* @description Sets the emissive texture.
|
|
9866
|
-
|
|
10043
|
+
@details It controls the color and intensity of the light being emitted by the material.
|
|
9867
10044
|
* This texture contains RGB components encoded with the sRGB transfer function.
|
|
9868
10045
|
* If a fourth component (A) is present, it MUST be ignored.
|
|
9869
10046
|
* When undefined, the texture MUST be sampled as having 1.0 in RGB components.
|
|
9870
|
-
* @param texture -
|
|
10047
|
+
* @param texture - The emissive texture to set.
|
|
9871
10048
|
*/
|
|
9872
10049
|
setEmissiveTexture(texture: Systems.TextureInfo): void;
|
|
9873
10050
|
/**
|
|
9874
|
-
* @description Gets the emissive texture
|
|
9875
|
-
* @return
|
|
10051
|
+
* @description Gets the emissive texture.
|
|
10052
|
+
* @return The emissive texture.
|
|
9876
10053
|
*/
|
|
9877
10054
|
getEmissiveTexture(): Systems.TextureInfo;
|
|
9878
10055
|
/**
|
|
9879
|
-
* @description Constructor which links the material to an asset
|
|
10056
|
+
* @description Constructor which links the material to an asset.
|
|
9880
10057
|
* @param name - The name of the material.
|
|
9881
|
-
* @param
|
|
9882
|
-
* @param
|
|
10058
|
+
* @param materialCollectionId - The asset collection which holds the associated material asset.
|
|
10059
|
+
* @param materialId - The asset where the material info is stored.
|
|
9883
10060
|
*/
|
|
9884
|
-
static
|
|
9885
|
-
static create(): GLTFMaterial;
|
|
10061
|
+
static create_name_materialCollectionId_materialId(name: string, materialCollectionId: string, materialId: string): GLTFMaterial;
|
|
9886
10062
|
delete(): void;
|
|
10063
|
+
static create(): GLTFMaterial;
|
|
9887
10064
|
}
|
|
9888
10065
|
}
|
|
9889
10066
|
export declare namespace Systems {
|
|
9890
10067
|
/**
|
|
9891
10068
|
@ingroup Asset System
|
|
9892
|
-
* @description Data class used to contain information when attempting to download
|
|
10069
|
+
* @description Data class used to contain information when attempting to download LOD chain data.
|
|
9893
10070
|
*/
|
|
9894
|
-
class
|
|
10071
|
+
class LODChainResult extends Systems.ResultBase implements INativeResource {
|
|
9895
10072
|
/** @internal */
|
|
9896
10073
|
constructor(pointer: NativePointer);
|
|
9897
|
-
static fromResultBase(baseInstance: Systems.ResultBase): Systems.
|
|
10074
|
+
static fromResultBase(baseInstance: Systems.ResultBase): Systems.LODChainResult;
|
|
9898
10075
|
/**
|
|
9899
|
-
* @description Retreives the
|
|
10076
|
+
* @description Retreives the LODChain from the result.
|
|
9900
10077
|
*/
|
|
9901
|
-
|
|
10078
|
+
getLODChain(): Systems.LODChain;
|
|
9902
10079
|
delete(): void;
|
|
9903
10080
|
}
|
|
9904
10081
|
}
|
|
9905
10082
|
export declare namespace Systems {
|
|
9906
10083
|
/**
|
|
9907
10084
|
@ingroup Asset System
|
|
9908
|
-
* @description
|
|
10085
|
+
* @description Result data class that contains downloaded material data.
|
|
9909
10086
|
*/
|
|
9910
|
-
class
|
|
10087
|
+
class MaterialResult extends Systems.ResultBase implements INativeResource {
|
|
9911
10088
|
/** @internal */
|
|
9912
10089
|
constructor(pointer: NativePointer);
|
|
9913
|
-
static fromResultBase(baseInstance: Systems.ResultBase): Systems.
|
|
10090
|
+
static fromResultBase(baseInstance: Systems.ResultBase): Systems.MaterialResult;
|
|
9914
10091
|
/**
|
|
9915
|
-
* @description
|
|
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.
|
|
9916
10094
|
*/
|
|
9917
|
-
|
|
10095
|
+
getMaterial(): Systems.Material;
|
|
9918
10096
|
delete(): void;
|
|
9919
10097
|
}
|
|
9920
10098
|
}
|
|
9921
10099
|
export declare namespace Systems {
|
|
9922
10100
|
/**
|
|
9923
10101
|
@ingroup Asset System
|
|
9924
|
-
* @description
|
|
10102
|
+
* @description Result data class that contains a collection of downloaded material data.
|
|
9925
10103
|
*/
|
|
9926
|
-
class
|
|
10104
|
+
class MaterialsResult extends Systems.ResultBase implements INativeResource {
|
|
9927
10105
|
/** @internal */
|
|
9928
10106
|
constructor(pointer: NativePointer);
|
|
9929
|
-
static fromResultBase(baseInstance: Systems.ResultBase): Systems.
|
|
10107
|
+
static fromResultBase(baseInstance: Systems.ResultBase): Systems.MaterialsResult;
|
|
9930
10108
|
/**
|
|
9931
|
-
* @description Retreives
|
|
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.
|
|
9932
10112
|
*/
|
|
9933
|
-
|
|
10113
|
+
getMaterials(): Common.Array<Systems.Material>;
|
|
9934
10114
|
delete(): void;
|
|
9935
10115
|
}
|
|
9936
10116
|
}
|
|
@@ -11914,8 +12094,8 @@ export declare namespace Common {
|
|
|
11914
12094
|
static ofcsp_systems_AssetCollection(): Array<Systems.AssetCollection>;
|
|
11915
12095
|
static ofcsp_systems_EAssetCollectionType(): Array<Systems.EAssetCollectionType>;
|
|
11916
12096
|
static ofcsp_systems_EAssetType(): Array<Systems.EAssetType>;
|
|
11917
|
-
static ofcsp_systems_GLTFMaterial(): Array<Systems.GLTFMaterial>;
|
|
11918
12097
|
static ofcsp_systems_LODAsset(): Array<Systems.LODAsset>;
|
|
12098
|
+
static ofcsp_systems_Material(): Array<Systems.Material>;
|
|
11919
12099
|
static ofcsp_systems_VariantOptionInfo(): Array<Systems.VariantOptionInfo>;
|
|
11920
12100
|
static ofcsp_systems_ProductVariantInfo(): Array<Systems.ProductVariantInfo>;
|
|
11921
12101
|
static ofcsp_systems_ProductMediaInfo(): Array<Systems.ProductMediaInfo>;
|
|
@@ -11955,8 +12135,8 @@ export declare namespace Common {
|
|
|
11955
12135
|
static ofcsp_systems_AssetCollection_number(size: number): Array<Systems.AssetCollection>;
|
|
11956
12136
|
static ofcsp_systems_EAssetCollectionType_number(size: number): Array<Systems.EAssetCollectionType>;
|
|
11957
12137
|
static ofcsp_systems_EAssetType_number(size: number): Array<Systems.EAssetType>;
|
|
11958
|
-
static ofcsp_systems_GLTFMaterial_number(size: number): Array<Systems.GLTFMaterial>;
|
|
11959
12138
|
static ofcsp_systems_LODAsset_number(size: number): Array<Systems.LODAsset>;
|
|
12139
|
+
static ofcsp_systems_Material_number(size: number): Array<Systems.Material>;
|
|
11960
12140
|
static ofcsp_systems_VariantOptionInfo_number(size: number): Array<Systems.VariantOptionInfo>;
|
|
11961
12141
|
static ofcsp_systems_ProductVariantInfo_number(size: number): Array<Systems.ProductVariantInfo>;
|
|
11962
12142
|
static ofcsp_systems_ProductMediaInfo_number(size: number): Array<Systems.ProductMediaInfo>;
|