浏览代码

Update AnimationHandler.html

gero3 11 年之前
父节点
当前提交
7c4df36c3c
共有 1 个文件被更改,包括 27 次插入23 次删除
  1. 27 23
      docs/api/extras/animation/AnimationHandler.html

+ 27 - 23
docs/api/extras/animation/AnimationHandler.html

@@ -9,7 +9,11 @@
 	<body>
 	<body>
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
+		<div class="desc">
+		The AnimationHandler handles the initialisation of the Animation data and 
+		the animations itself. It keeps track of every animation and if it's active or not.
+		It also update all animations which are active if its method *update* is called.
+		</div>
 
 
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
@@ -17,7 +21,7 @@
 
 
 		<h3>[name]()</h3>
 		<h3>[name]()</h3>
 		<div>
 		<div>
-		todo
+		The animationHandler can't be called as constructor.
 		</div>
 		</div>
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
@@ -25,69 +29,69 @@
 
 
 		<h3>.[page:number CATMULLROM]</h3>
 		<h3>.[page:number CATMULLROM]</h3>
 		<div>
 		<div>
-		todo
+		Enum Value to indicate that the animation needs to be interpolated as CATMULLROM.
 		</div> 
 		</div> 
 
 
 		<h3>.[page:number CATMULLROM_FORWARD]</h3>
 		<h3>.[page:number CATMULLROM_FORWARD]</h3>
 		<div>
 		<div>
-		todo
+		Enum Value to indicate that the animation needs to be interpolated as CATMULLROM_FORWARD.
 		</div> 
 		</div> 
 
 
 		<h3>.[page:number LINEAR]</h3>
 		<h3>.[page:number LINEAR]</h3>
 		<div>
 		<div>
-		todo
+		Enum Value to indicate that the animation needs to be interpolated as LINEAR.
 		</div> 
 		</div> 
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
 
 
 
 
 
 
-		<h3>.removeFromUpdate([page:todo animation]) [page:todo]</h3>
+		<h3>.removeFromUpdate([page:Animation animation])</h3>
 		<div>
 		<div>
-		animation -- todo
+		animation -- The Animation to remove from the update. 
 		</div>
 		</div>
 		<div>
 		<div>
-		todo
+		Removes the animation from the update cycle. This gets called when the animation stops. This shouldn't be called by usercode.
 		</div>
 		</div>
 
 
-		<h3>.get([page:todo name]) [page:todo]</h3>
+		<h3>.get([page:String name]) [page:Object]</h3>
 		<div>
 		<div>
-		name -- todo
+		name -- The name of the animationData
 		</div>
 		</div>
 		<div>
 		<div>
-		todo
+		Gets the animationData from its library.
 		</div>
 		</div>
 
 
-		<h3>.update([page:todo deltaTimeMS]) [page:todo]</h3>
+		<h3>.update([page:Number deltaTimeMS]) </h3>
 		<div>
 		<div>
-		deltaTimeMS -- todo
+		deltaTimeMS -- Time elapsed since last update in milliseconds.
 		</div>
 		</div>
 		<div>
 		<div>
-		todo
+		Updates all active animations with deltaTime.
 		</div>
 		</div>
 
 
-		<h3>.parse([page:todo root]) [page:todo]</h3>
+		<h3>.parse([page:Object root])</h3>
 		<div>
 		<div>
-		root -- todo
+		root -- object
 		</div>
 		</div>
 		<div>
 		<div>
-		todo
+		Parses the object to get the hierachy.
 		</div>
 		</div>
 
 
-		<h3>.add([page:todo data]) [page:todo]</h3>
+		<h3>.add([page:object data])</h3>
 		<div>
 		<div>
-		data -- todo
+		data -- The animationData
 		</div>
 		</div>
 		<div>
 		<div>
-		todo
+		Adds the animationData from its library.
 		</div>
 		</div>
 
 
-		<h3>.addToUpdate([page:todo animation]) [page:todo]</h3>
+		<h3>.addToUpdate([page:Animation animation]) </h3>
 		<div>
 		<div>
-		animation -- todo
+		animation -- The Animation to add from the update. 
 		</div>
 		</div>
 		<div>
 		<div>
-		todo
+		Adds the animation from the update cycle. This gets called when the animation starts. This shouldn't be called by user code.
 		</div>
 		</div>
 
 
 		<h2>Source</h2>
 		<h2>Source</h2>