javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
							<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<base href="../../../" />
		<script src="page.js"></script>
		<link type="text/css" rel="stylesheet" href="page.css" />
	</head>
	<body>
		<h1>[name]</h1>

		<p class="desc">
			The AnimationMixer is a player for animations on a particular object in the scene. When
			multiple objects in the scene are animated independently, one AnimationMixer may be used for
			each object.<br /><br />

			For an overview of the different elements of the three.js animation system see the
			"Animation System" article in the "Next Steps" section of the manual.
		</p>


		<h2>Constructor</h2>


		<h3>[name]( [param:Object3D rootObject] )</h3>
		<p>
			[page:Object3D rootObject] - the object whose animations shall be played by this mixer.<br />
		</p>


		<h2>Properties</h2>


		<h3>[property:Number time]</h3>
		<p>
			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
			all actions that are controlled by this mixer.
		</p>


		<h2>Methods</h2>


		<h3>[method:AnimationAction clipAction]([param:AnimationClip clip], [param:Object3D optionalRoot])</h3>
		<p>
			Returns an [page:AnimationAction] for the passed clip, optionally using a root object different
			from the mixer's default root. The first parameter can be either an [page:AnimationClip] object
			or the name of an AnimationClip.<br /><br />

			If an action fitting the clip and root parameters doesn't yet exist, it will be created by
			this method. Calling this method several times with the same clip and root parameters always
			returns the same clip instance.
		</p>

		<h3>[method:AnimationAction existingAction]([param:AnimationClip clip], [param:Object3D optionalRoot])</h3>
		<p>
			Returns an existing [page:AnimationAction] for the passed clip, optionally using a root object
			different from the mixer's default root.<br /><br />

			The first parameter can be either an [page:AnimationClip] object or the name of an AnimationClip.
		</p>

		<h3>[method:Object3D getRoot]()</h3>
		<p>
			Returns this mixer's root object.
		</p>

		<h3>[method:AnimationMixer stopAllAction]()</h3>
		<p>
			Deactivates all previously scheduled actions on this mixer.
		</p>

		<h3>[method:AnimationMixer update]([param:Number deltaTimeInSeconds]) </h3>
		<p>
			Advances the global mixer time and updates the animation.<br /><br />

			This is usually done in the render loop, passing [page:Clock.getDelta clock.getDelta] scaled by the mixer's [page:.timeScale timeScale]).
		</p>

		<h3>[method:AnimationMixer setTime]([param:Number timeInSeconds]) </h3>
		<p>
			Sets the global mixer to a specific time and updates the animation accordingly.<br /><br />

			This is useful when you need to jump to an exact time in an animation. The input parameter will be scaled by the mixer's [page:.timeScale timeScale].
		</p>

		<h3>[method:null uncacheClip]([param:AnimationClip clip])</h3>

		<p>
			Deallocates all memory resources for a clip.
		</p>

		<h3>[method:null uncacheRoot]([param:Object3D root]) </h3>
		<p>
			Deallocates all memory resources for a root object.
		</p>

		<h3>[method:null uncacheAction]([param:AnimationClip clip], [param:Object3D optionalRoot])</h3>
		<p>
			Deallocates all memory resources for an action.
		</p>


		<h2>Source</h2>


		<p>
			[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
		</p>
	</body>
</html>