Docs: Add default value annotations (#1587)

* EnvironmentControls: Add flight support

* Add free rotation

* Updates

* fix focus

* Remove lines

* Stylistic

* Add "@default" annotations

* Update docs build functions

* Update more defaults

* Update new defaults

* Update docs

* Update

Author: gkjohnson

src/core/renderer/API.md

@@ -85,7 +85,7 @@ Base class for all 3D Tiles content loaders. Handles fetching and parsing tile c
 ### .fetchOptions
 
 ```js
-fetchOptions: Object
+fetchOptions: Object = {}
 ```
 
 Options passed to `fetch` when loading tile content.
@@ -94,7 +94,7 @@ Options passed to `fetch` when loading tile content.
 ### .workingPath
 
 ```js
-workingPath: string
+workingPath: string = ''
 ```
 
 Base URL used to resolve relative external URLs.
@@ -348,17 +348,17 @@ are in use each frame and evicts unused items when the cache exceeds its size li
 ### .unloadPriorityCallback
 
 ```js
-unloadPriorityCallback: ( a: any, b: any ) => number | null
+unloadPriorityCallback: ( a: any, b: any ) => number | null = null
 ```
 
 Comparator used to determine eviction order. Items that sort last are evicted first.
-Defaults to `null` (eviction order is by last-used time).
+When `null`, eviction order is by last-used time.
 
 
 ### .minSize
 
 ```js
-minSize: number
+minSize: number = 6000
 ```
 
 Minimum number of items to keep in the cache after eviction.
@@ -367,7 +367,7 @@ Minimum number of items to keep in the cache after eviction.
 ### .maxSize
 
 ```js
-maxSize: number
+maxSize: number = 8000
 ```
 
 Maximum number of items before eviction is triggered.
@@ -376,7 +376,7 @@ Maximum number of items before eviction is triggered.
 ### .minBytesSize
 
 ```js
-minBytesSize: number
+minBytesSize: number = ~322MB
 ```
 
 Minimum total bytes to retain after eviction.
@@ -387,7 +387,7 @@ Minimum total bytes to retain after eviction.
 ### .maxBytesSize
 
 ```js
-maxBytesSize: number
+maxBytesSize: number = ~430MB
 ```
 
 Maximum total bytes before eviction is triggered.
@@ -398,7 +398,7 @@ Maximum total bytes before eviction is triggered.
 ### .unloadPercent
 
 ```js
-unloadPercent: number
+unloadPercent: number = 0.05
 ```
 
 Fraction of excess items/bytes to unload per eviction pass.
@@ -407,7 +407,7 @@ Fraction of excess items/bytes to unload per eviction pass.
 ### .autoMarkUnused
 
 ```js
-autoMarkUnused: boolean
+autoMarkUnused: boolean = true
 ```
 
 If true, items are automatically marked as unused at the start of each eviction pass.
@@ -551,7 +551,7 @@ returns whether tasks are queued or actively running
 ### .maxJobs
 
 ```js
-maxJobs: number
+maxJobs: number = 6
 ```
 
 Maximum number of jobs that can run concurrently.
@@ -560,7 +560,7 @@ Maximum number of jobs that can run concurrently.
 ### .autoUpdate
 
 ```js
-autoUpdate: boolean
+autoUpdate: boolean = true
 ```
 
 If true, job runs are automatically scheduled after `add` and after each job completes.
@@ -569,11 +569,11 @@ If true, job runs are automatically scheduled after `add` and after each job com
 ### .priorityCallback
 
 ```js
-priorityCallback: ( a: any, b: any ) => number | null
+priorityCallback: ( a: any, b: any ) => number | null = null
 ```
 
 Comparator used to sort queued items. Higher-priority items should sort last
-(i.e. return positive when `itemA` should run before `itemB`). Defaults to `null`.
+(i.e. return positive when `itemA` should run before `itemB`).
 
 
 ### .sort
@@ -773,7 +773,7 @@ The loaded root tileset object, or null if not yet loaded.
 ### .fetchOptions
 
 ```js
-fetchOptions: RequestInit
+fetchOptions: RequestInit = {}
 ```
 
 Options passed to `fetch` when loading tile and tileset resources.
@@ -863,7 +863,7 @@ Loading and rendering statistics updated each frame. Fields:
 ### .errorTarget
 
 ```js
-errorTarget: number
+errorTarget: number = 16
 ```
 
 Target screen-space error in pixels to aim for when updating the geometry. Tiles will
@@ -875,7 +875,7 @@ of the 3D Tiles specification for more information.
 ### .displayActiveTiles
 
 ```js
-displayActiveTiles: boolean
+displayActiveTiles: boolean = false
 ```
 
 "Active tiles" are those that are loaded and available but not necessarily visible.
@@ -888,7 +888,7 @@ camera view not accounted for by the tiles renderer.
 ### .maxDepth
 
 ```js
-maxDepth: number
+maxDepth: number = Infinity
 ```
 
 Maximum depth in the tile hierarchy to traverse. Tiles deeper than this are skipped.
@@ -897,7 +897,7 @@ Maximum depth in the tile hierarchy to traverse. Tiles deeper than this are skip
 ### .optimizedLoadStrategy
 
 ```js
-optimizedLoadStrategy: boolean
+optimizedLoadStrategy: boolean = false
 ```
 
 **Experimental.** Enables an optimized tile loading strategy that loads only the tiles
@@ -907,9 +907,6 @@ tiles to load first. Prevents visual gaps and flashing during camera movement.
 
 Based in part on [Cesium Native tile selection](https://cesium.com/learn/cesium-native/ref-doc/selection-algorithm-details.html).
 
-Default is `false`, which uses the previous approach of loading all parent and sibling
-tiles for guaranteed smooth transitions.
-
 > [!WARNING]
 > Setting is currently incompatible with plugins that split tiles and on-the-fly generate and
 > dispose of child tiles including the `ImageOverlayPlugin` `enableTileSplitting` setting,
@@ -919,7 +916,7 @@ tiles for guaranteed smooth transitions.
 ### .loadSiblings
 
 ```js
-loadSiblings: boolean
+loadSiblings: boolean = true
 ```
 
 **Experimental.** When `true`, sibling tiles are loaded together to prevent gaps during
@@ -933,7 +930,7 @@ Only applies when `optimizedLoadStrategy` is enabled.
 ### .loadAncestors
 
 ```js
-loadAncestors: boolean
+loadAncestors: boolean = false
 ```
 
 **Experimental.** When `true`, ancestor tiles are queued for download and displayed as a
@@ -947,7 +944,7 @@ Only applies when `optimizedLoadStrategy` is enabled.
 ### .maxTilesProcessed
 
 ```js
-maxTilesProcessed: number
+maxTilesProcessed: number = 250
 ```
 
 The number of tiles to process immediately when traversing the tile set to determine

src/core/renderer/loaders/LoaderBase.js

@@ -10,12 +10,14 @@ export class LoaderBase {
 		/**
 		 * Options passed to `fetch` when loading tile content.
 		 * @type {Object}
+		 * @default {}
 		 */
 		this.fetchOptions = {};
 
 		/**
 		 * Base URL used to resolve relative external URLs.
 		 * @type {string}
+		 * @default ''
 		 */
 		this.workingPath = '';
 

src/core/renderer/tiles/TilesRendererBase.js

@@ -403,6 +403,7 @@ export class TilesRendererBase {
 		/**
 		 * Options passed to `fetch` when loading tile and tileset resources.
 		 * @type {RequestInit}
+		 * @default {}
 		 */
 		this.fetchOptions = {};
 		this.plugins = [];
@@ -544,6 +545,7 @@ export class TilesRendererBase {
 		 * {@link https://github.com/CesiumGS/3d-tiles/tree/master/specification#geometric-error geometric error section}
 		 * of the 3D Tiles specification for more information.
 		 * @type {number}
+		 * @default 16
 		 */
 		this.errorTarget = 16.0;
 		this._errorThreshold = Infinity;
@@ -555,12 +557,14 @@ export class TilesRendererBase {
 		 * Setting this to `true` keeps them in the scene so they can be rendered from an outside
 		 * camera view not accounted for by the tiles renderer.
 		 * @type {boolean}
+		 * @default false
 		 */
 		this.displayActiveTiles = false;
 
 		/**
 		 * Maximum depth in the tile hierarchy to traverse. Tiles deeper than this are skipped.
 		 * @type {number}
+		 * @default Infinity
 		 */
 		this.maxDepth = Infinity;
 
@@ -571,14 +575,12 @@ export class TilesRendererBase {
 		 * tiles to load first. Prevents visual gaps and flashing during camera movement.
 		 *
 		 * Based in part on {@link https://cesium.com/learn/cesium-native/ref-doc/selection-algorithm-details.html Cesium Native tile selection}.
-		 *
-		 * Default is `false`, which uses the previous approach of loading all parent and sibling
-		 * tiles for guaranteed smooth transitions.
 		 * @warn Setting is currently incompatible with plugins that split tiles and on-the-fly generate and
 		 * dispose of child tiles including the `ImageOverlayPlugin` `enableTileSplitting` setting,
 		 * `QuantizedMeshPlugin`, & `ImageFormatPlugin` subclasses (XYZ, TMS, etc). Any tile sets
 		 * that share caches or queues must also use the same setting.
 		 * @type {boolean}
+		 * @default false
 		 */
 		this.optimizedLoadStrategy = false;
 
@@ -590,6 +592,7 @@ export class TilesRendererBase {
 		 *
 		 * Only applies when `optimizedLoadStrategy` is enabled.
 		 * @type {boolean}
+		 * @default true
 		 */
 		this.loadSiblings = true;
 
@@ -601,6 +604,7 @@ export class TilesRendererBase {
 		 *
 		 * Only applies when `optimizedLoadStrategy` is enabled.
 		 * @type {boolean}
+		 * @default false
 		 */
 		this.loadAncestors = false;
 
@@ -610,6 +614,7 @@ export class TilesRendererBase {
 		 * at once when a new tile set is available, while higher values process more tiles
 		 * immediately so data can be downloaded and displayed sooner.
 		 * @type {number}
+		 * @default 250
 		 */
 		this.maxTilesProcessed = 250;
 

src/core/renderer/utilities/LRUCache.js

@@ -22,8 +22,9 @@ class LRUCache {
 
 	/**
 	 * Comparator used to determine eviction order. Items that sort last are evicted first.
-	 * Defaults to `null` (eviction order is by last-used time).
+	 * When `null`, eviction order is by last-used time.
 	 * @type {UnloadPriorityCallback|null}
+	 * @default null
 	 */
 	get unloadPriorityCallback() {
 
@@ -60,38 +61,44 @@ class LRUCache {
 		/**
 		 * Minimum number of items to keep in the cache after eviction.
 		 * @type {number}
+		 * @default 6000
 		 */
 		this.minSize = 6000;
 
 		/**
 		 * Maximum number of items before eviction is triggered.
 		 * @type {number}
+		 * @default 8000
 		 */
 		this.maxSize = 8000;
 
 		/**
 		 * Minimum total bytes to retain after eviction.
 		 * @note Only works with three.js r166 or higher.
 		 * @type {number}
+		 * @default ~322MB
 		 */
 		this.minBytesSize = 0.3 * GIGABYTE_BYTES;
 
 		/**
 		 * Maximum total bytes before eviction is triggered.
 		 * @note Only works with three.js r166 or higher.
 		 * @type {number}
+		 * @default ~430MB
 		 */
 		this.maxBytesSize = 0.4 * GIGABYTE_BYTES;
 
 		/**
 		 * Fraction of excess items/bytes to unload per eviction pass.
 		 * @type {number}
+		 * @default 0.05
 		 */
 		this.unloadPercent = 0.05;
 
 		/**
 		 * If true, items are automatically marked as unused at the start of each eviction pass.
 		 * @type {boolean}
+		 * @default true
 		 */
 		this.autoMarkUnused = true;
 

src/core/renderer/utilities/PriorityQueue.js

@@ -60,10 +60,10 @@ export class PriorityQueue {
 
 	/**
 	 * Callback used to schedule when to run jobs next, so more work doesn't happen in a
-	 * single frame than there is time for. Defaults to `requestAnimationFrame`. Should be
-	 * overridden in scenarios where `requestAnimationFrame` is not reliable, such as when
-	 * running in WebXR.
+	 * single frame than there is time for. Should be overridden in scenarios where
+	 * `requestAnimationFrame` is not reliable, such as when running in WebXR.
 	 * @type {SchedulingCallback}
+	 * @default requestAnimationFrame
 	 * @deprecated
 	 */
 	get schedulingCallback() {
@@ -84,6 +84,7 @@ export class PriorityQueue {
 		/**
 		 * Maximum number of jobs that can run concurrently.
 		 * @type {number}
+		 * @default 6
 		 */
 		this.maxJobs = 6;
 
@@ -95,13 +96,15 @@ export class PriorityQueue {
 		/**
 		 * If true, job runs are automatically scheduled after `add` and after each job completes.
 		 * @type {boolean}
+		 * @default true
 		 */
 		this.autoUpdate = true;
 
 		/**
 		 * Comparator used to sort queued items. Higher-priority items should sort last
-		 * (i.e. return positive when `itemA` should run before `itemB`). Defaults to `null`.
+		 * (i.e. return positive when `itemA` should run before `itemB`).
 		 * @type {PriorityCallback|null}
+		 * @default null
 		 */
 		this.priorityCallback = null;
 

src/three/plugins/API.md

@@ -709,7 +709,7 @@ order, and an unlit rendering mode. Color modes are available via the static
 ### .getDebugColor
 
 ```js
-getDebugColor: ( val: number, target: Color ) => void
+getDebugColor: ( val: number, target: Color ) => void = ( value, target ) => target.setRGB( value, value, value )
 ```
 
 Maps a normalized [0, 1] value to a `Color` for debug visualizations. Defaults to

src/three/plugins/DebugTilesPlugin.js

@@ -262,6 +262,7 @@ export class DebugTilesPlugin {
 		 * a black-to-white gradient. Replace with a custom function to use a different color
 		 * ramp.
 		 * @type {GetDebugColorCallback}
+		 * @default ( value, target ) => target.setRGB( value, value, value )
 		 */
 		this.getDebugColor = ( value, target ) => {