Constructor
new AnimationAction( mixer : AnimationMixer, clip : AnimationClip, localRoot : Object3D, blendMode : NormalAnimationBlendMode | AdditiveAnimationBlendMode )
Constructs a new animation action.
| mixer |
The mixer that is controlled by this action. |
| clip |
The animation clip that holds the actual keyframes. |
| localRoot |
The root object on which this action is performed. Default is |
| blendMode |
The blend mode. |
Properties
.blendMode : NormalAnimationBlendMode | AdditiveAnimationBlendMode
Defines how the animation is blended/combined when two or more animations are simultaneously played.
.clampWhenFinished : boolean
If set to true the animation will automatically be paused on its last frame.
If set to false, AnimationAction#enabled will automatically be switched
to false when the last loop of the action has finished, so that this action has
no further impact.
Note: This member has no impact if the action is interrupted (it has only an effect if its last loop has really finished).
Default is false.
.enabled : boolean
If set to false, the action is disabled so it has no impact.
When the action is re-enabled, the animation continues from its current
time (setting enabled to false doesn't reset the action).
Default is true.
.loop : LoopRepeat | LoopOnce | LoopPingPong
The loop mode, set via AnimationAction#setLoop.
Default is LoopRepeat.
.paused : boolean
If set to true, the playback of the action is paused.
Default is false.
.repetitions : number
The number of repetitions of the performed clip over the course of this action. Can be set via AnimationAction#setLoop.
Setting this number has no effect if AnimationAction#loop is set to
THREE:LoopOnce.
Default is Infinity.
.time : number
The local time of this action (in seconds, starting with 0).
The value gets clamped or wrapped to [0,clip.duration] (according to the
loop state).
Default is Infinity.
.timeScale : number
Scaling factor for the AnimationAction#time. A value of 0 causes the
animation to pause. Negative values cause the animation to play backwards.
Default is 1.
.weight : number
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.
.zeroSlopeAtEnd : boolean
Enables smooth interpolation without separate clips for start, loop and end.
Default is true.
.zeroSlopeAtStart : boolean
Enables smooth interpolation without separate clips for start, loop and end.
Default is true.
Methods
.crossFadeFrom( fadeOutAction : AnimationAction, duration : number, warp : boolean ) : AnimationAction
Causes this action to fade in and the given action to fade out, within the passed time interval.
| fadeOutAction |
The animation action to fade out. |
| duration |
The duration of the fade. |
| warp |
Whether warping should be used or not. Default is |
- Returns: A reference to this animation action.
.crossFadeTo( fadeInAction : AnimationAction, duration : number, warp : boolean ) : AnimationAction
Causes this action to fade out and the given action to fade in, within the passed time interval.
| fadeInAction |
The animation action to fade in. |
| duration |
The duration of the fade. |
| warp |
Whether warping should be used or not. Default is |
- Returns: A reference to this animation action.
.fadeIn( duration : number ) : AnimationAction
Fades the animation in by increasing its weight gradually from 0 to 1,
within the passed time interval.
| duration |
The duration of the fade. |
- Returns: A reference to this animation action.
.fadeOut( duration : number ) : AnimationAction
Fades the animation out by decreasing its weight gradually from 1 to 0,
within the passed time interval.
| duration |
The duration of the fade. |
- Returns: A reference to this animation action.
.getClip() : AnimationClip
Returns the animation clip of this animation action.
- Returns: The animation clip.
.getEffectiveTimeScale() : number
Returns the effective time scale of this action.
- Returns: The effective time scale.
.getEffectiveWeight() : number
Returns the effective weight of this action.
- Returns: The effective weight.
.getMixer() : AnimationMixer
Returns the animation mixer of this animation action.
- Returns: The animation mixer.
.getRoot() : Object3D
Returns the root object of this animation action.
- Returns: The root object.
.halt( duration : number ) : AnimationAction
Decelerates this animation's speed to 0 within the passed time interval.
| duration |
The duration. |
- Returns: A reference to this animation action.
.isRunning() : boolean
Returns true if the animation is running.
- Returns: Whether the animation is running or not.
.isScheduled() : boolean
Returns true when AnimationAction#play has been called.
- Returns: Whether the animation is scheduled or not.
.play() : AnimationAction
Starts the playback of the animation.
- Returns: A reference to this animation action.
.reset() : AnimationAction
Resets the playback of the animation.
- Returns: A reference to this animation action.
.setDuration( duration : number ) : AnimationAction
Sets the duration for a single loop of this action.
| duration |
The duration to set. |
- Returns: A reference to this animation action.
.setEffectiveTimeScale( timeScale : number ) : AnimationAction
Sets the effective time scale of this action.
An action has no effect and thus an effective time scale of zero when the action is paused.
| timeScale |
The time scale to set. |
- Returns: A reference to this animation action.
.setEffectiveWeight( weight : number ) : AnimationAction
Sets the effective weight of this action.
An action has no effect and thus an effective weight of zero when the action is disabled.
| weight |
The weight to set. |
- Returns: A reference to this animation action.
.setLoop( mode : LoopRepeat | LoopOnce | LoopPingPong, repetitions : number ) : AnimationAction
Configures the loop settings for this action.
| mode |
The loop mode. |
| repetitions |
The number of repetitions. |
- Returns: A reference to this animation action.
.startAt( time : number ) : AnimationAction
Defines the time when the animation should start.
| time |
The start time in seconds. |
- Returns: A reference to this animation action.
.stop() : AnimationAction
Stops the playback of the animation.
- Returns: A reference to this animation action.
.stopFading() : AnimationAction
Stops any fading which is applied to this action.
- Returns: A reference to this animation action.
.stopWarping() : AnimationAction
Stops any scheduled warping which is applied to this action.
- Returns: A reference to this animation action.
.syncWith( action : AnimationAction ) : AnimationAction
Synchronizes this action with the passed other action.
| action |
The action to sync with. |
- Returns: A reference to this animation action.
.warp( startTimeScale : number, endTimeScale : number, duration : number ) : AnimationAction
Changes the playback speed, within the passed time interval, by modifying
AnimationAction#timeScale gradually from startTimeScale to
endTimeScale.
| startTimeScale |
The start time scale. |
| endTimeScale |
The end time scale. |
| duration |
The duration. |
- Returns: A reference to this animation action.