Helpers: Clarify the usage of update(). (#32717)

Mugen87 · web-flow · commit 2ec2102b2ddd · 2026-01-12T10:56:26.000+01:00
diff --git a/src/helpers/CameraHelper.js b/src/helpers/CameraHelper.js
@@ -18,6 +18,9 @@ const _camera = /*@__PURE__*/ new Camera();
  *
  * `CameraHelper` must be a child of the scene.
  *
+ * When the camera is transformed or its projection matrix is changed, it's necessary
+ * to call the `update()` method of the respective helper.
+ *
  * ```js
  * const camera = new THREE.PerspectiveCamera( 75, window.innerWidth / window.innerHeight, 0.1, 1000 );
  * const helper = new THREE.CameraHelper( camera );
diff --git a/src/helpers/DirectionalLightHelper.js b/src/helpers/DirectionalLightHelper.js
@@ -11,9 +11,12 @@ const _v3 = /*@__PURE__*/ new Vector3();
 
 /**
  * Helper object to assist with visualizing a {@link DirectionalLight}'s
- * effect on the scene. This consists of plane and a line representing the
+ * effect on the scene. This consists of a plane and a line representing the
  * light's position and direction.
  *
+ * When the directional light or its target are transformed or light properties
+ * are changed, it's necessary to call the `update()` method of the respective helper.
+ *
  * ```js
  * const light = new THREE.DirectionalLight( 0xFFFFFF );
  * scene.add( light );
diff --git a/src/helpers/HemisphereLightHelper.js b/src/helpers/HemisphereLightHelper.js
@@ -14,6 +14,9 @@ const _color2 = /*@__PURE__*/ new Color();
  * Creates a visual aid consisting of a spherical mesh for a
  * given {@link HemisphereLight}.
  *
+ * When the hemisphere light is transformed or its light properties are changed,
+ * it's necessary to call the `update()` method of the respective helper.
+ *
  * ```js
  * const light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 );
  * const helper = new THREE.HemisphereLightHelper( light, 5 );
diff --git a/src/helpers/SpotLightHelper.js b/src/helpers/SpotLightHelper.js
@@ -10,6 +10,9 @@ const _vector = /*@__PURE__*/ new Vector3();
 /**
  * This displays a cone shaped helper object for a {@link SpotLight}.
  *
+ * When the spot light or its target are transformed or light properties are
+ * changed, it's necessary to call the `update()` method of the respective helper.
+ *
  * ```js
  * const spotLight = new THREE.SpotLight( 0xffffff );
  * spotLight.position.set( 10, 10, 10 );

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,9 @@ const _camera = /@__PURE__/ new Camera();`
`18`	`18`	`*`
`19`	`19`	* `CameraHelper` must be a child of the scene.
`20`	`20`	`*`
	`21`	`+ * When the camera is transformed or its projection matrix is changed, it's necessary`
	`22`	+ * to call the `update()` method of the respective helper.
	`23`	`+ *`
`21`	`24`	* ```js
`22`	`25`	`* const camera = new THREE.PerspectiveCamera( 75, window.innerWidth / window.innerHeight, 0.1, 1000 );`
`23`	`26`	`* const helper = new THREE.CameraHelper( camera );`