Skip to content

Commit 792ef3a

Browse files
authored
Docs: Clarify auto update flags. (#32909)
1 parent 1251d16 commit 792ef3a

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/core/Object3D.js

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,8 @@ class Object3D extends EventDispatcher {
242242

243243
/**
244244
* When set to `true`, the engine automatically computes the local matrix from position,
245-
* rotation and scale every frame.
245+
* rotation and scale every frame. If set to `false`, the app is responsible for recomputing
246+
* the local matrix by calling `updateMatrix()`.
246247
*
247248
* The default values for all 3D objects is defined by `Object3D.DEFAULT_MATRIX_AUTO_UPDATE`.
248249
*
@@ -253,7 +254,8 @@ class Object3D extends EventDispatcher {
253254

254255
/**
255256
* When set to `true`, the engine automatically computes the world matrix from the current local
256-
* matrix and the object's transformation hierarchy.
257+
* matrix and the object's transformation hierarchy. If set to `false`, the app is responsible for
258+
* recomputing the world matrix by directly updating the `matrixWorld` property.
257259
*
258260
* The default values for all 3D objects is defined by `Object3D.DEFAULT_MATRIX_WORLD_AUTO_UPDATE`.
259261
*
@@ -1158,7 +1160,7 @@ class Object3D extends EventDispatcher {
11581160
* `true` by default. Set these flags to `false` if you need more control over the update matrix process.
11591161
*
11601162
* @param {boolean} [force=false] - When set to `true`, a recomputation of world matrices is forced even
1161-
* when {@link Object3D#matrixWorldAutoUpdate} is set to `false`.
1163+
* when {@link Object3D#matrixWorldNeedsUpdate} is `false`.
11621164
*/
11631165
updateMatrixWorld( force ) {
11641166

0 commit comments

Comments
 (0)