Skip to content

Commit 0579d5d

Browse files
committed
Update docs
1 parent 77c3d62 commit 0579d5d

6 files changed

Lines changed: 14 additions & 7 deletions

File tree

src/core/renderer/API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ Maximum number of items before eviction is triggered.
376376
### .minBytesSize
377377

378378
```js
379-
minBytesSize: number
379+
minBytesSize: number = ~322MB
380380
```
381381

382382
Minimum total bytes to retain after eviction.
@@ -387,7 +387,7 @@ Minimum total bytes to retain after eviction.
387387
### .maxBytesSize
388388

389389
```js
390-
maxBytesSize: number
390+
maxBytesSize: number = ~430MB
391391
```
392392

393393
Maximum total bytes before eviction is triggered.

src/core/renderer/utilities/LRUCache.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,15 @@ class LRUCache {
7676
* Minimum total bytes to retain after eviction.
7777
* @note Only works with three.js r166 or higher.
7878
* @type {number}
79+
* @default ~322MB
7980
*/
8081
this.minBytesSize = 0.3 * GIGABYTE_BYTES;
8182

8283
/**
8384
* Maximum total bytes before eviction is triggered.
8485
* @note Only works with three.js r166 or higher.
8586
* @type {number}
87+
* @default ~430MB
8688
*/
8789
this.maxBytesSize = 0.4 * GIGABYTE_BYTES;
8890

src/three/renderer/API.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Distance the orthographic camera is pushed back when `orthographicPositionalZoom
125125
### .fixedPoint
126126

127127
```js
128-
fixedPoint: Vector3
128+
fixedPoint: Vector3 = new Vector3()
129129
```
130130

131131
World-space point that remains visually fixed during the transition.
@@ -793,7 +793,7 @@ Fraction of the far plane distance added as a buffer.
793793
### .globeInertia
794794

795795
```js
796-
globeInertia: Quaternion
796+
globeInertia: Quaternion = new Quaternion()
797797
```
798798

799799
Accumulated globe rotation inertia quaternion. Applied each frame when globe inertia is active.
@@ -820,7 +820,7 @@ The ellipsoid model used for surface interaction and up-direction calculation.
820820
### .ellipsoidGroup
821821

822822
```js
823-
ellipsoidGroup: Group
823+
ellipsoidGroup: Group = new Group()
824824
```
825825

826826
The Three.js group whose world matrix defines the ellipsoid's coordinate frame.
@@ -926,7 +926,7 @@ Add `tiles.group` to your scene and call `tiles.update()` each frame.
926926
### .autoDisableRendererCulling
927927

928928
```js
929-
autoDisableRendererCulling: boolean
929+
autoDisableRendererCulling: boolean = true
930930
```
931931

932932
If `true`, all tile meshes automatically have `frustumCulled` set to `false` since the
@@ -967,7 +967,7 @@ Array of cameras registered with this renderer.
967967
### .manager
968968

969969
```js
970-
manager: LoadingManager
970+
manager: LoadingManager = new LoadingManager()
971971
```
972972

973973
The `LoadingManager` used when loading tile geometry.

src/three/renderer/controls/CameraTransitionManager.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ export class CameraTransitionManager extends EventDispatcher {
120120
/**
121121
* World-space point that remains visually fixed during the transition.
122122
* @type {Vector3}
123+
* @default new Vector3()
123124
*/
124125
this.fixedPoint = new Vector3();
125126

src/three/renderer/controls/GlobeControls.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ export class GlobeControls extends EnvironmentControls {
103103
/**
104104
* Accumulated globe rotation inertia quaternion. Applied each frame when globe inertia is active.
105105
* @type {Quaternion}
106+
* @default new Quaternion()
106107
*/
107108
this.globeInertia = new Quaternion();
108109

@@ -123,6 +124,7 @@ export class GlobeControls extends EnvironmentControls {
123124
/**
124125
* The Three.js group whose world matrix defines the ellipsoid's coordinate frame.
125126
* @type {Group}
127+
* @default new Group()
126128
*/
127129
this.ellipsoidGroup = new Group();
128130
this._ellipsoidFrameInverse = new Matrix4();

src/three/renderer/tiles/TilesRenderer.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ export class TilesRenderer extends TilesRendererBase {
5757
* tiles renderer performs its own frustum culling. If `displayActiveTiles` is `true` or
5858
* multiple cameras are being used, consider setting this to `false`.
5959
* @type {boolean}
60+
* @default true
6061
*/
6162
get autoDisableRendererCulling() {
6263

@@ -129,6 +130,7 @@ export class TilesRenderer extends TilesRendererBase {
129130
/**
130131
* The `LoadingManager` used when loading tile geometry.
131132
* @type {LoadingManager}
133+
* @default new LoadingManager()
132134
*/
133135
this.manager = new LoadingManager();
134136

0 commit comments

Comments
 (0)