@polygon-streaming/web-player-threejs 2.4.6 → 2.7.3

package/README.md

@@ -40,14 +40,8 @@ Instanciate the stream controller:
 ```javascript
 const streamController = new StreamController(camera, renderer, scene, cameraTarget, {
   cameraType: 'nonPlayer',
-  triangleBudget: 3000000,
-  mobileTriangleBudget: 1000000,
-  closeUpDistance: 0.2,
-  minimumDistance: 0.01,
-  distanceFactor: 1.1,
-  distanceType: 'boundingBoxCenter',
-  maximumQuality: 15000,
-  closeUpDistanceFactor: 5,
+  triangleBudget: 5000000,
+  mobileTriangleBudget: 3000000
 });
 ```
 
@@ -59,16 +53,7 @@ modelParent.position.set(0, 1, 0);
 scene.add(modelParent);
 
 streamController.addModel('<Model URL>', modelParent, {
-  qualityPriority: 1,
-  initialTrianglePercent: 0.1,
-  castShadows: true,
-  receiveShadows: true,
-  castShadowsLightmap: true,
-  forceDoubleSided: false,
-  useAlpha: true,
-  useEmbeddedCollider: true,
-  environmentMap: null,
-  hashCode: ''
+  qualityPriority: 1
 });
 ```
 
@@ -89,21 +74,19 @@ renderer.setAnimationLoop(animate);
 * **camera** (Required): The camera used in the scene.
 * **renderer** (Required): The WebGL renderer used in the scene.
 * **scene** (Required): The scene object.
-* **camera target** (Required): The camera target which is a Vector3. If you are using orbit controls it would be controls.target.
+* **cameraTarget** (Required): The camera target which is a Vector3. If you are using orbit controls it would be controls.target.
 * **options** (Optional): All options are optional. The options are:
   * **cameraType**:  'nonPlayer' | 'player', default: 'nonPlayer'
     * **nonPlayer**: A camera that is not attached to a player e.g. a camera that orbits an object.
     * **player**: A camera that is attached to a player.
-  * **triangleBudget**: number, default: 3000000. The maximum amount of triangles that you want to be in the scene at any single point.
-  * **mobileTriangleBudget**: number, default: 1000000. The triangle budget used on a mobile device. If it is set to 0 it will use the non-mobile triangle budget.
+  * **triangleBudget**: number, default: 5000000. The maximum amount of triangles that you want to be in the scene at any single point.
+  * **mobileTriangleBudget**: number, default: 3000000. The triangle budget used on a mobile device. If it is set to 0 it will use the non-mobile triangle budget.
   * **minimumDistance**: number, default: 0.01. The smallest possible distance to the camera.
   * **distanceFactor**: number, default: 1.1. Preference for nearby objects over objects further away. Values above one mean a preference for nearby objects. Values below one mean a preference for objects further away. One is neutral.
-  * **distanceType**: 'boundingBoxCenter' | 'boundingBox', default: 'boundingBoxCenter'
-    * **boundingBoxCenter**: Uses the center of the bounding box to caluclate the distance to the node.
-    * **boundingBox**: Uses the bounding box corners and face centers to calulcate the distance to the node. 
   * **maximumQuality**: number, default: 15000. Stops improving geometry that exceeds the maximum quality. This can be used to stop far away objects from showing more detail which can be wasteful. Setting it to 0 means there is no maximum quality.
   * **closeUpDistance**: number, default: 3. The distance where it starts using close-up distance factor. Set it to 0 to not use close-up distance factor.
   * **closeUpDistanceFactor**: number, default: 5. The distance factor used when close-up to an object. Should be higher than the standard distance factor.
+  * **iOS Memory Limit**: number, default 0. The maximum amount of memory in MB that meshes and textures can consume on iOS devices to avoid the page crashing. Use -1 for no limit or 0 to let Polygon Streaming determine the limit.
 
 ## Streaming Model Parameters
 
@@ -112,11 +95,12 @@ renderer.setAnimationLoop(animate);
 * **options** (Optional): All options are optional. The options are:
   * **qualityPriority**: number, default: 1.  How much to prioritize the quality of this model relative to the quality of other models in the scene. This parameter does nothing if this is the only model in the scene.
   * **initialTrianglePercent**: number, default: 0.1. Percentage of triangle budget to initialize the model with.
-  * **useMetalRoughness**: boolean, default: true. Whether materials should use metal roughness PBR. (deprecated)
   * **castShadows**: boolean, default: true. Whether the model should cast shadows.
   * **receiveShadows**: boolean, default: true. Whether the model should receive shadows.
-  * **castShadowsLightmap**: boolean, default: true. Whether the model casts shadows when rendering lightmaps.
   * **forceDoubleSided**: boolean, default: false. Render the model double sided regardless of the setting in the model file.
+  * **useAlpha**: boolean, default: true. Whether to render semi-transparency in materials. You might turn this off to increase performance but all your materials will render opaque.
+  * **playAnimationAutomatically**: boolean, default: true. Whether to play the embedded animation automatically.
+  * **animation**: string or number, default: null. The name or index of the embedded animation to play. An index value of 0 is the first animation. If not value is supplied it will play the first animation.
   * **environmentMap**: texture, default: null. A cube map environment texture.
   * **hashCode**: string, default: ''. Hash code to validate streaming model.