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


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

		<div class="desc">Runs a keyframe animation as imported from the [page:ColladaLoader].</div>

		<h2>Examples</h2>
		
		<div>[example:webgl_loader_collada_keyframe loader / collada / keyframe ]</div>


		<h2>Constructor</h2>


		<h3>[name]([page:Object data])</h3>
		<div>
		data -- An individual animation object from a the [page:ColladaLoader], e.g. loadedColladaObj.animations[0] <br />
		</div>
		<div>
		Creates a new keyframe animation and initializes it to the first keyframes.
		</div>
		

		<h2>Properties</h2>

		<h3>[property:Object3D root]</h3>
		<div>
		The root object of the animation
		</div> 

		<h3>[property:Object data]</h3>
		<div>
		The data containing the animation
		</div> 
		
		<h3>[property:Array hierarchy]</h3>
		<div>
		The objects that are influenced by the animation.
		</div>

		<h3>[property:number currentTime]</h3>
		<div>
		The time elapsed since the last start/restart of the animation.
		</div>
		
		<h3>[property:number timeScale]</h3>
		<div>
		How much to scale the speed of the animation. Defaults to 1.
		</div>

		<h3>[property:boolean isPlaying]</h3>
		<div>
		Indicates whether the animation is playing. This shouldn't be adapted by user code.
		</div>
		
		<h3>[property:boolean isPaused]</h3>
		<div>
		Indicates whether the animation is paused. This shouldn't be adapted by user code.
		</div>
		
		<h3>[property:boolean loop]</h3>
		<div>
		Set to make the animation restart when the animation ends.
		</div> 
		
		<h2>Methods</h2>
		
		<h3>[method:null play]([page:Number startTime])</h3>
		<div>
		Starts the animation at the startTime (in seconds) of the animation.
		</div>

		<h3>[method:null stop]()</h3>
		<div>
		Stops the animation.
		</div>

		<h3>[method:null update]([page:Float deltaTime])</h3>
		<div>
		deltaTime -- The change in time in seconds
		</div>
		<div>
		Updates the keyframe animation
		</div>

		<h3>[method:Object getNextKeyWith]([page:String sid], [page:Integer h], [page:Integer key])</h3>
		<div>
		sid -- The string id <br />
		h -- The index in the heirarchy to use<br />
		key -- The index of which key to start from
		</div>
		<div>
		Used internally to traverse the animation
		</div>

		<h3>[method:Object getPrevKeyWith]([page:String sid], [page:Integer h], [page:Integer key])</h3>
		<div>
		sid -- The string id <br />
		h -- The index in the heirarchy to use<br />
		key -- The index of which key to start from
		</div>
		<div>
		Used internally to traverse the animation
		</div>

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