Browse Source

descriptions of the classes.

Ben Houston 10 years ago
parent
commit
69a3556013

+ 3 - 0
src/animation/Action.js

@@ -1,4 +1,7 @@
 /**
 /**
+ *
+ * A clip that has been explicitly scheduled.
+ * 
  * @author Ben Houston / http://clara.io/
  * @author Ben Houston / http://clara.io/
  * @author David Sarno / http://lighthaus.us/
  * @author David Sarno / http://lighthaus.us/
  */
  */

+ 1 - 1
src/animation/Clip.js

@@ -35,7 +35,7 @@ THREE.Clip.prototype = {
 
 
 	importFromData: function( data ) {
 	importFromData: function( data ) {
 
 
-		init: function ( data ) {
+		// TODO: Convert this copy-paste code from AnimationHandler into an importer into Tracks and Clips with some improvements to the track names
 
 
 		if ( data.initialized === true ) return data;
 		if ( data.initialized === true ) return data;
 
 

+ 7 - 1
src/animation/ConstantTrack.js

@@ -1,4 +1,10 @@
-
+/**
+ *
+ * A Track that returns a constant value.
+ * 
+ * @author Ben Houston / http://clara.io/
+ * @author David Sarno / http://lighthaus.us/
+ */
 
 
 THREE.ConstantTrack = function ( name, value ) {
 THREE.ConstantTrack = function ( name, value ) {
 
 

+ 9 - 1
src/animation/KeyframeTrack.js

@@ -1,4 +1,12 @@
-
+/**
+ *
+ * A Track that returns a keyframe interpolated value.
+ *
+ * TODO: Add cubic in addition to linear interpolation.
+ * 
+ * @author Ben Houston / http://clara.io/
+ * @author David Sarno / http://lighthaus.us/
+ */
 
 
 THREE.KeyframeTrack = function ( name, keys ) {
 THREE.KeyframeTrack = function ( name, keys ) {
 
 

+ 3 - 0
src/animation/Mixer.js

@@ -1,4 +1,7 @@
 /**
 /**
+ *
+ * Mixes together the Clips scheduled by Actions and applies them to the root and subtree
+ *
  * @author Ben Houston / http://clara.io/
  * @author Ben Houston / http://clara.io/
  * @author David Sarno / http://lighthaus.us/
  * @author David Sarno / http://lighthaus.us/
  */
  */

+ 10 - 0
src/animation/Track.js

@@ -1,3 +1,13 @@
+/**
+ *
+ * A Track base class that has a getAt function and name handling.
+ *
+ * TODO: Add support for bone indices via a number rather than a name?
+ * TODO: Add support for explicitly setting the nodeName and propertyName?
+ * 
+ * @author Ben Houston / http://clara.io/
+ * @author David Sarno / http://lighthaus.us/
+ */
 
 
 THREE.Track = function ( name ) {
 THREE.Track = function ( name ) {