Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/dev' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
lmj01 committed May 20, 2022
2 parents b6b1049 + 3d1c5b8 commit 5891b12
Show file tree
Hide file tree
Showing 241 changed files with 2,900 additions and 8,611 deletions.
1,601 changes: 126 additions & 1,475 deletions build/three.cjs

Large diffs are not rendered by default.

1,601 changes: 126 additions & 1,475 deletions build/three.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build/three.min.js

Large diffs are not rendered by default.

2,235 changes: 170 additions & 2,065 deletions build/three.module.js

Large diffs are not rendered by default.

88 changes: 44 additions & 44 deletions docs/api/en/animation/AnimationAction.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ <h2>Constructor</h2>

<h3>[name]( [param:AnimationMixer mixer], [param:AnimationClip clip], [param:Object3D localRoot] )</h3>
<p>
[page:AnimationMixer mixer] - the *AnimationMixer* that is controlled by this action.<br />
[page:AnimationClip clip] - the *AnimationClip* that holds the animation data for this action.<br />
[page:AnimationMixer mixer] - the `AnimationMixer` that is controlled by this action.<br />
[page:AnimationClip clip] - the `AnimationClip` that holds the animation data for this action.<br />
[page:Object3D localRoot] - the root object on which this action is performed.<br /><br />

Note: Instead of calling this constructor directly you should instantiate an AnimationAction with
Expand All @@ -39,31 +39,31 @@ <h2>Properties</h2>

<h3>[property:Boolean clampWhenFinished]</h3>
<p>
If *clampWhenFinished* is set to true the animation will automatically be [page:.paused paused]
If `clampWhenFinished` is set to true the animation will automatically be [page:.paused paused]
on its last frame.<br /><br />

If *clampWhenFinished* is set to false, [page:.enabled enabled] will automatically be switched
If `clampWhenFinished` is set to false, [page:.enabled enabled] will automatically be switched
to false when the last loop of the action has finished, so that this action has no further
impact.<br /><br />

Default is false.<br /><br />

Note: *clampWhenFinished* has no impact if the action is interrupted (it has only an effect if
Note: `clampWhenFinished` has no impact if the action is interrupted (it has only an effect if
its last loop has really finished).
</p>

<h3>[property:Boolean enabled]</h3>
<p>
Setting *enabled* to *false* disables this action, so that it has no impact. Default is *true*.<br /><br />
Setting `enabled` to `false` disables this action, so that it has no impact. Default is `true`.<br /><br />

When the action is re-enabled, the animation continues from its current [page:.time time]
(setting *enabled* to *false* doesn't reset the action).<br /><br />
(setting `enabled` to `false` doesn't reset the action).<br /><br />

Note: Setting *enabled* to *true* doesn’t automatically restart the animation. Setting *enabled*
to *true* will only restart the animation immediately if the following condition is fulfilled:
[page:.paused paused] is *false*, this action has not been deactivated in the meantime (by
Note: Setting `enabled` to `true` doesn’t automatically restart the animation. Setting `enabled`
to `true` will only restart the animation immediately if the following condition is fulfilled:
[page:.paused paused] is `false`, this action has not been deactivated in the meantime (by
executing a [page:.stop stop] or [page:.reset reset] command), and neither [page:.weight weight]
nor [page:.timeScale timeScale] is 0.
nor [page:.timeScale timeScale] is `0`.
</p>

<h3>[property:Number loop]</h3>
Expand All @@ -73,40 +73,40 @@ <h3>[property:Number loop]</h3>

Must be one of these constants:<br /><br />
[page:Animation THREE.LoopOnce] - playing the clip once,<br />
[page:Animation THREE.LoopRepeat] - playing the clip with the chosen number of *repetitions*,
[page:Animation THREE.LoopRepeat] - playing the clip with the chosen number of `repetitions`,
each time jumping from the end of the clip directly to its beginning,<br />
[page:Animation THREE.LoopPingPong] - playing the clip with the chosen number of *repetitions*,
[page:Animation THREE.LoopPingPong] - playing the clip with the chosen number of `repetitions`,
alternately playing forward and backward.
</p>

<h3>[property:Boolean paused]</h3>
<p>
Setting *paused* to *true* pauses the execution of the action by setting the effective time scale
to 0. Default is *false*.<br /><br />
Setting `paused` to `true` pauses the execution of the action by setting the effective time scale
to `0`. Default is `false`.<br /><br />
</p>

<h3>[property:Number repetitions]</h3>
<p>
The number of repetitions of the performed [page:AnimationClip] over the course of this action.
Can be set via [page:.setLoop setLoop]. Default is *Infinity*.<br /><br />
Can be set via [page:.setLoop setLoop]. Default is `Infinity`.<br /><br />
Setting this number has no effect, if the [page:.loop loop mode] is set to
[page:Animation THREE.LoopOnce].
</p>

<h3>[property:Number time]</h3>
<p>
The local time of this action (in seconds, starting with 0).<br /><br />
The local time of this action (in seconds, starting with `0`).<br /><br />

The value gets clamped or wrapped to 0...clip.duration (according to the loop state). It can be
The value gets clamped or wrapped to `0...clip.duration` (according to the loop state). It can be
scaled relatively to the global mixer time by changing [page:.timeScale timeScale] (using
[page:.setEffectiveTimeScale setEffectiveTimeScale] or [page:.setDuration setDuration]).<br />
</p>

<h3>[property:Number timeScale]</h3>
<p>
Scaling factor for the [page:.time time]. A value of 0 causes the animation to pause. Negative
values cause the animation to play backwards. Default is 1.<br /><br />
Properties/methods concerning *timeScale* (respectively *time*) are:
Scaling factor for the [page:.time time]. A value of `0` causes the animation to pause. Negative
values cause the animation to play backwards. Default is `1`.<br /><br />
Properties/methods concerning `timeScale` (respectively `time`) are:
[page:.getEffectiveTimeScale getEffectiveTimeScale],
[page:.halt halt],
[page:.paused paused],
Expand All @@ -119,9 +119,9 @@ <h3>[property:Number timeScale]</h3>

<h3>[property:Number weight]</h3>
<p>
The degree of influence of this action (in the interval [0, 1]). Values between 0 (no impact)
and 1 (full impact) can be used to blend between several actions. Default is 1. <br /><br />
Properties/methods concerning *weight* are:
The degree of influence of this action (in the interval `[0, 1]`). Values between `0` (no impact)
and 1 (full impact) can be used to blend between several actions. Default is `1`. <br /><br />
Properties/methods concerning `weight` are:
[page:.crossFadeFrom crossFadeFrom],
[page:.crossFadeTo crossFadeTo],
[page:.enabled enabled],
Expand All @@ -134,12 +134,12 @@ <h3>[property:Number weight]</h3>

<h3>[property:Boolean zeroSlopeAtEnd]</h3>
<p>
Enables smooth interpolation without separate clips for start, loop and end. Default is *true*.
Enables smooth interpolation without separate clips for start, loop and end. Default is `true`.
</p>

<h3>[property:Boolean zeroSlopeAtStart]</h3>
<p>
Enables smooth interpolation without separate clips for start, loop and end. Default is *true*.
Enables smooth interpolation without separate clips for start, loop and end. Default is `true`.
</p>


Expand All @@ -154,7 +154,7 @@ <h3>[method:this crossFadeFrom]( [param:AnimationAction fadeOutAction], [param:N
If warpBoolean is true, additional [page:.warp warping] (gradually changes of the time scales)
will be applied.<br /><br />

Note: Like with *fadeIn*/*fadeOut*, the fading starts/ends with a weight of 1.
Note: Like with `fadeIn`/`fadeOut`, the fading starts/ends with a weight of 1.

</p>

Expand All @@ -165,18 +165,18 @@ <h3>[method:this crossFadeTo]( [param:AnimationAction fadeInAction], [param:Numb
If warpBoolean is true, additional [page:.warp warping] (gradually changes of the time scales)
will be applied.<br /><br />

Note: Like with *fadeIn*/*fadeOut*, the fading starts/ends with a weight of 1.
Note: Like with `fadeIn`/`fadeOut`, the fading starts/ends with a weight of 1.
</p>

<h3>[method:this fadeIn]( [param:Number durationInSeconds] )</h3>
<p>
Increases the [page:.weight weight] of this action gradually from 0 to 1, within the passed time
Increases the [page:.weight weight] of this action gradually from `0` to `1`, within the passed time
interval. This method can be chained.
</p>

<h3>[method:this fadeOut]( [param:Number durationInSeconds] )</h3>
<p>
Decreases the [page:.weight weight] of this action gradually from 1 to 0, within the passed time
Decreases the [page:.weight weight] of this action gradually from `1` to `0`, within the passed time
interval. This method can be chained.
</p>

Expand Down Expand Up @@ -209,7 +209,7 @@ <h3>[method:Object3D getRoot]()</h3>

<h3>[method:this halt]( [param:Number durationInSeconds] )</h3>
<p>
Decelerates this animation's speed to 0 by decreasing [page:.timeScale timeScale] gradually
Decelerates this animation's speed to `0` by decreasing [page:.timeScale timeScale] gradually
(starting from its current value), within the passed time interval. This method can be chained.
</p>

Expand All @@ -219,10 +219,10 @@ <h3>[method:Boolean isRunning]()</h3>

In addition to being activated in the mixer (see [page:.isScheduled isScheduled]) the following conditions must be fulfilled:
[page:.paused paused] is equal to false, [page:.enabled enabled] is equal to true,
[page:.timeScale timeScale] is different from 0, and there is no scheduling for a delayed start
[page:.timeScale timeScale] is different from `0`, and there is no scheduling for a delayed start
([page:.startAt startAt]).<br /><br />

Note: *isRunning* being true doesn’t necessarily mean that the animation can actually be seen.
Note: `isRunning` being true doesn’t necessarily mean that the animation can actually be seen.
This is only the case, if [page:.weight weight] is additionally set to a non-zero value.
</p>

Expand Down Expand Up @@ -250,11 +250,11 @@ <h3>[method:this reset]()</h3>
Resets the action. This method can be chained.<br /><br />

This method sets [page:.paused paused] to false, [page:.enabled enabled] to true,
[page:.time time] to 0, interrupts any scheduled fading and warping, and removes the internal
[page:.time time] to `0`, interrupts any scheduled fading and warping, and removes the internal
loop count and scheduling for delayed starting.<br /><br />

Note: .*reset* is always called by [page:.stop stop], but .*reset* doesn’t call .*stop* itself.
This means: If you want both, resetting and stopping, don’t call .*reset*; call .*stop* instead.
Note: .`reset` is always called by [page:.stop stop], but .`reset` doesn’t call .`stop` itself.
This means: If you want both, resetting and stopping, don’t call .`reset`; call .`stop` instead.
</p>

<h3>[method:this setDuration]( [param:Number durationInSeconds] )</h3>
Expand All @@ -269,9 +269,9 @@ <h3>[method:this setEffectiveTimeScale]( [param:Number timeScale] )</h3>

If [page:.paused paused] is false, the effective time scale (an internal property) will also be set
to this value; otherwise the effective time scale (directly affecting the animation at
this moment) will be set to 0.<br /><br />
this moment) will be set to `0`.<br /><br />

Note: .*paused* will not be switched to *true* automatically, if .*timeScale* is set to 0 by
Note: .`paused` will not be switched to `true` automatically, if .`timeScale` is set to `0` by
this method.
</p>

Expand All @@ -281,9 +281,9 @@ <h3>[method:this setEffectiveWeight]( [param:Number weight] )</h3>

If [page:.enabled enabled] is true, the effective weight (an internal property) will also be set
to this value; otherwise the effective weight (directly affecting the animation at this moment)
will be set to 0.<br /><br />
will be set to `0`.<br /><br />

Note: .*enabled* will not be switched to *false* automatically, if .*weight* is set to 0 by
Note: .`enabled` will not be switched to `false` automatically, if .`weight` is set to `0` by
this method.
</p>

Expand All @@ -298,9 +298,9 @@ <h3>[method:this startAt]( [param:Number startTimeInSeconds] )</h3>
Defines the time for a delayed start (usually passed as [page:AnimationMixer.time] +
deltaTimeInSeconds). This method can be chained.<br /><br />

Note: The animation will only start at the given time, if .*startAt* is chained with
Note: The animation will only start at the given time, if .`startAt` is chained with
[page:.play play], or if the action has already been activated in the mixer (by a previous
call of .*play*, without stopping or resetting it in the meantime).
call of .`play`, without stopping or resetting it in the meantime).
</p>

<h3>[method:this stop]()</h3>
Expand Down Expand Up @@ -332,13 +332,13 @@ <h3>[method:this syncWith]( [param:AnimationAction otherAction] )</h3>
Synchronizing is done by setting this action’s [page:.time time] and [page:.timeScale timeScale] values
to the corresponding values of the other action (stopping any scheduled warping).<br /><br />

Note: Future changes of the other action's *time* and *timeScale* will not be detected.
Note: Future changes of the other action's `time` and `timeScale` will not be detected.
</p>

<h3>[method:this warp]( [param:Number startTimeScale], [param:Number endTimeScale], [param:Number durationInSeconds] )</h3>
<p>
Changes the playback speed, within the passed time interval, by modifying
[page:.timeScale timeScale] gradually from *startTimeScale* to *endTimeScale*. This method can
[page:.timeScale timeScale] gradually from `startTimeScale` to `endTimeScale`. This method can
be chained.
</p>

Expand Down
4 changes: 2 additions & 2 deletions docs/api/en/animation/AnimationClip.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h3>[name]( [param:String name], [param:Number duration], [param:Array tracks] )
<p>
[page:String name] - a name for this clip.<br />
[page:Number duration] - the duration of this clip (in seconds). If a negative value is passed,
the duration will be calculated from the passed *tracks* array.<br />
the duration will be calculated from the passed `tracks` array.<br />
[page:Array tracks] - an array of [page:KeyframeTrack KeyframeTracks].<br /><br />

Note: Instead of instantiating an AnimationClip directly with the constructor, you can use one
Expand Down Expand Up @@ -113,7 +113,7 @@ <h3>[method:AnimationClip CreateFromMorphTargetSequence]( [param:String name], [
Returns a new AnimationClip from the passed morph targets array of a geometry, taking a name and the number of frames per second.<br /><br />

Note: The fps parameter is required, but the animation speed can be overridden in an
*AnimationAction* via [page:AnimationAction.setDuration animationAction.setDuration].
`AnimationAction` via [page:AnimationAction.setDuration animationAction.setDuration].
</p>

<h3>[method:AnimationClip findByName]( [param:Object objectOrClipArray], [param:String name] )</h3>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/en/animation/AnimationMixer.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ <h2>Properties</h2>

<h3>[property:Number time]</h3>
<p>
The global mixer time (in seconds; starting with 0 on the mixer's creation).
The global mixer time (in seconds; starting with `0` on the mixer's creation).
</p>

<h3>[property:Number timeScale]</h3>
<p>
A scaling factor for the global [page:.time mixer time].<br /><br />

Note: Setting the mixer's timeScale to 0 and later back to 1 is a possibility to pause/unpause
Note: Setting the mixer's timeScale to `0` and later back to `1` is a possibility to pause/unpause
all actions that are controlled by this mixer.
</p>

Expand Down
10 changes: 5 additions & 5 deletions docs/api/en/animation/AnimationObjectGroup.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,14 @@ <h3>[property:Boolean isAnimationObjectGroup]</h3>

<h3>[property:Object stats]</h3>
<p>
An object that contains some informations of this *AnimationObjectGroup* (total number, number
An object that contains some informations of this `AnimationObjectGroup` (total number, number
in use, number of bindings per object)
</p>

<h3>[property:String uuid]</h3>
<p>
The [link:http://en.wikipedia.org/wiki/Universally_unique_identifier UUID] of this
*AnimationObjectGroup*. It gets automatically assigned and shouldn't be edited.
`AnimationObjectGroup`. It gets automatically assigned and shouldn't be edited.
</p>


Expand All @@ -67,17 +67,17 @@ <h2>Methods</h2>

<h3>[method:undefined add]( [param:Object obj1], [param:Object obj2], [param:Object obj3], ... )</h3>
<p>
Adds an arbitrary number of objects to this *AnimationObjectGroup*.
Adds an arbitrary number of objects to this `AnimationObjectGroup`.
</p>

<h3>[method:undefined remove]( [param:Object obj1], [param:Object obj2], [param:Object obj3], ... )</h3>
<p>
Removes an arbitrary number of objects from this *AnimationObjectGroup*.
Removes an arbitrary number of objects from this `AnimationObjectGroup`.
</p>

<h3>[method:undefined uncache]( [param:Object obj1], [param:Object obj2], [param:Object obj3], ... )</h3>
<p>
Deallocates all memory resources for the passed objects of this *AnimationObjectGroup*.
Deallocates all memory resources for the passed objects of this `AnimationObjectGroup`.
</p>


Expand Down
2 changes: 1 addition & 1 deletion docs/api/en/animation/AnimationUtils.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ <h3>[method:Array getKeyframeOrder]( times )</h3>

<h3>[method:Boolean isTypedArray]( object )</h3>
<p>
Returns *true* if the object is a typed array.
Returns `true` if the object is a typed array.
</p>

<h3>[method:AnimationClip makeClipAdditive]( [param:AnimationClip targetClip], [param:Number referenceFrame], [param:AnimationClip referenceClip], [param:Number fps] )</h3>
Expand Down
14 changes: 7 additions & 7 deletions docs/api/en/animation/KeyframeTrack.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ <h1>[name]</h1>
<p>
In contrast to the animation hierarchy of the
[link:https://github.com/mrdoob/three.js/wiki/JSON-Model-format-3 JSON model format] a
*KeyframeTrack* doesn't store its single keyframes as objects in a "keys" array (holding the
`KeyframeTrack` doesn't store its single keyframes as objects in a "keys" array (holding the
times and the values for each frame together in one place).
</p>

<p>
Instead of this there are always two arrays in a *KeyframeTrack*: the [page:.times times] array
Instead of this there are always two arrays in a `KeyframeTrack`: the [page:.times times] array
stores the time values for all keyframes of this track in sequential order, and the
[page:.values values] array contains the corresponding changing values of the animated property.
</p>
Expand All @@ -43,7 +43,7 @@ <h1>[name]</h1>

<p>
Corresponding to the different possible types of animated values there are several subclasses of
*KeyframeTrack*, inheriting the most properties and methods:
`KeyframeTrack`, inheriting the most properties and methods:
</p>

<ul>
Expand Down Expand Up @@ -77,7 +77,7 @@ <h2>Constructor</h2>

<h3>[name]( [param:String name], [param:Array times], [param:Array values], [param:Constant interpolation] )</h3>
<p>
[page:String name] - the identifier for the *KeyframeTrack*.<br />
[page:String name] - the identifier for the `KeyframeTrack`.<br />
[page:Array times] - an array of keyframe times, converted internally to a
[link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array Float32Array].<br />
[page:Array values] - an array with the values related to the times array, converted internally to a
Expand Down Expand Up @@ -232,8 +232,8 @@ <h3>[method:this shift]( [param:Number timeOffsetInSeconds] )</h3>

<h3>[method:this trim]( [param:Number startTimeInSeconds], [param:Number endTimeInSeconds] )</h3>
<p>
Removes keyframes before *startTime* and after *endTime*,
without changing any values within the range [*startTime*, *endTime*].
Removes keyframes before `startTime` and after `endTime`,
without changing any values within the range [`startTime`, `endTime`].
</p>

<h3>[method:Boolean validate]()</h3>
Expand All @@ -243,7 +243,7 @@ <h3>[method:Boolean validate]()</h3>

<p>
This method logs errors to the console, if a track is empty, if the [page:.valueSize value size] is not valid, if an item
in the [page:.times times] or [page:.values values] array is not a valid number or if the items in the *times* array are out of order.
in the [page:.times times] or [page:.values values] array is not a valid number or if the items in the `times` array are out of order.
</p>

<h2>Static Methods</h2>
Expand Down
Loading

0 comments on commit 5891b12

Please sign in to comment.