Added description to every command-type with valid input types

dforrer · dforrer · commit 2645c3216994 · 2015-10-07T16:51:27.000+02:00
diff --git a/editor/js/Cmd.js b/editor/js/Cmd.js
@@ -1,5 +1,11 @@
 /**
- * Created by Daniel on 20.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param editorRef pointer to main editor object used to initialize
+ *        each command object with a reference to the editor
+ * @constructor
  */
 
 Cmd = function ( editorRef ) {
diff --git a/editor/js/CmdAddObject.js b/editor/js/CmdAddObject.js
@@ -1,5 +1,10 @@
 /**
- * Created by Daniel on 20.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @constructor
  */
 
 CmdAddObject = function ( object ) {
diff --git a/editor/js/CmdAddScript.js b/editor/js/CmdAddScript.js
@@ -1,5 +1,11 @@
 /**
- * Created by Daniel on 20.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param script javascript object
+ * @constructor
  */
 
 CmdAddScript = function ( object, script ) {
diff --git a/editor/js/CmdMoveObject.js b/editor/js/CmdMoveObject.js
@@ -1,5 +1,12 @@
 /**
- * Created by Daniel on 20.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param newParent THREE.Object3D
+ * @param newBefore THREE.Object3D
+ * @constructor
  */
 
 CmdMoveObject = function ( object, newParent, newBefore ) {
diff --git a/editor/js/CmdMultiCmds.js b/editor/js/CmdMultiCmds.js
@@ -1,5 +1,10 @@
 /**
- * Created by Daniel on 20.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param cmdArray array containing command objects
+ * @constructor
  */
 
 CmdMultiCmds = function ( cmdArray ) {
diff --git a/editor/js/CmdRemoveObject.js b/editor/js/CmdRemoveObject.js
@@ -1,5 +1,10 @@
 /**
- * Created by Daniel on 20.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @constructor
  */
 
 CmdRemoveObject = function ( object ) {
diff --git a/editor/js/CmdRemoveScript.js b/editor/js/CmdRemoveScript.js
@@ -1,5 +1,11 @@
 /**
- * Created by Daniel on 20.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param script javascript object
+ * @constructor
  */
 
 CmdRemoveScript = function ( object, script ) {
diff --git a/editor/js/CmdSetColor.js b/editor/js/CmdSetColor.js
@@ -1,5 +1,12 @@
 /**
- * Created by Daniel on 21.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param attributeName string
+ * @param newValue integer representing a hex color value
+ * @constructor
  */
 
 CmdSetColor = function ( object, attributeName, newValue ) {
diff --git a/editor/js/CmdSetGeometry.js b/editor/js/CmdSetGeometry.js
@@ -1,5 +1,11 @@
 /**
- * Created by Daniel on 21.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param newGeometry THREE.Geometry
+ * @constructor
  */
 
 CmdSetGeometry = function ( object, newGeometry ) {
diff --git a/editor/js/CmdSetGeometryValue.js b/editor/js/CmdSetGeometryValue.js
@@ -1,5 +1,12 @@
 /**
- * Created by Daniel on 21.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param attributeName string
+ * @param newValue number, string, boolean or object
+ * @constructor
  */
 
 CmdSetGeometryValue = function ( object, attributeName, newValue ) {
diff --git a/editor/js/CmdSetMaterial.js b/editor/js/CmdSetMaterial.js
@@ -1,5 +1,11 @@
 /**
- * Created by Daniel on 21.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param newMaterial THREE.Material
+ * @constructor
  */
 
 CmdSetMaterial = function ( object, newMaterial ) {
diff --git a/editor/js/CmdSetMaterialColor.js b/editor/js/CmdSetMaterialColor.js
@@ -1,5 +1,12 @@
 /**
- * Created by Daniel on 21.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param attributeName string
+ * @param newValue integer representing a hex color value
+ * @constructor
  */
 
 CmdSetMaterialColor = function ( object, attributeName, newValue ) {
diff --git a/editor/js/CmdSetMaterialMap.js b/editor/js/CmdSetMaterialMap.js
@@ -1,5 +1,12 @@
 /**
- * Created by Daniel on 21.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param mapName string
+ * @param newMap THREE.Texture
+ * @constructor
  */
 
 CmdSetMaterialMap = function ( object, mapName, newMap ) {
diff --git a/editor/js/CmdSetMaterialValue.js b/editor/js/CmdSetMaterialValue.js
@@ -1,5 +1,12 @@
 /**
- * Created by Daniel on 21.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param attributeName string
+ * @param newValue number, string, boolean or object
+ * @constructor
  */
 
 CmdSetMaterialValue = function ( object, attributeName, newValue ) {
diff --git a/editor/js/CmdSetPosition.js b/editor/js/CmdSetPosition.js
@@ -1,8 +1,15 @@
 /**
- * Created by Daniel on 23.07.15.
+ * @author dforrer / https://github.com/dforrer
  */
 
-CmdSetPosition = function ( object, newPositionVector, oldPositionVector ) {
+/**
+ * @param object THREE.Object3D
+ * @param newPosition THREE.Vector3
+ * @param optionalOldPosition THREE.Vector3
+ * @constructor
+ */
+
+CmdSetPosition = function ( object, newPosition, optionalOldPosition ) {
 
 	Cmd.call( this );
 
@@ -12,16 +19,16 @@ CmdSetPosition = function ( object, newPositionVector, oldPositionVector ) {
 
 	this.object = object;
 
-	if ( object !== undefined && newPositionVector !== undefined ) {
+	if ( object !== undefined && newPosition !== undefined ) {
 
 		this.oldPosition = object.position.clone();
-		this.newPosition = newPositionVector.clone();
+		this.newPosition = newPosition.clone();
 
 	}
 
-	if ( oldPositionVector !== undefined ) {
+	if ( optionalOldPosition !== undefined ) {
 
-		this.oldPosition = oldPositionVector.clone();
+		this.oldPosition = optionalOldPosition.clone();
 
 	}
 
diff --git a/editor/js/CmdSetRotation.js b/editor/js/CmdSetRotation.js
@@ -1,8 +1,15 @@
 /**
- * Created by Daniel on 23.07.15.
+ * @author dforrer / https://github.com/dforrer
  */
 
-CmdSetRotation = function ( object, newRotationEuler, oldRotationEuler ) {
+/**
+ * @param object THREE.Object3D
+ * @param newRotation THREE.Euler
+ * @param optionalOldRotation THREE.Euler
+ * @constructor
+ */
+
+CmdSetRotation = function ( object, newRotation, optionalOldRotation ) {
 
 	Cmd.call( this );
 
@@ -12,16 +19,16 @@ CmdSetRotation = function ( object, newRotationEuler, oldRotationEuler ) {
 
 	this.object = object;
 
-	if ( object !== undefined && newRotationEuler !== undefined) {
+	if ( object !== undefined && newRotation !== undefined) {
 
 		this.oldRotation = object.rotation.clone();
-		this.newRotation = newRotationEuler.clone();
+		this.newRotation = newRotation.clone();
 
 	}
 
-	if ( oldRotationEuler !== undefined ) {
+	if ( optionalOldRotation !== undefined ) {
 
-		this.oldRotation = oldRotationEuler.clone();
+		this.oldRotation = optionalOldRotation.clone();
 
 	}
 
diff --git a/editor/js/CmdSetScale.js b/editor/js/CmdSetScale.js
@@ -1,8 +1,15 @@
 /**
- * Created by Daniel on 23.07.15.
+ * @author dforrer / https://github.com/dforrer
  */
 
-CmdSetScale = function ( object, newScaleVector, oldScaleVector ) {
+/**
+ * @param object THREE.Object3D
+ * @param newScale THREE.Vector3
+ * @param optionalOldScale THREE.Vector3
+ * @constructor
+ */
+
+CmdSetScale = function ( object, newScale, optionalOldScale ) {
 
 	Cmd.call( this );
 
@@ -12,18 +19,19 @@ CmdSetScale = function ( object, newScaleVector, oldScaleVector ) {
 
 	this.object = object;
 
-	if ( object !== undefined && newScaleVector !== undefined ) {
+	if ( object !== undefined && newScale !== undefined ) {
 
 		this.oldScale = object.scale.clone();
-		this.newScale = newScaleVector.clone();
+		this.newScale = newScale.clone();
 
 	}
 
-	if ( oldScaleVector !== undefined ) {
+	if ( optionalOldScale !== undefined ) {
 
-		this.oldScale = oldScaleVector.clone();
+		this.oldScale = optionalOldScale.clone();
 
 	}
+
 };
 
 CmdSetScale.prototype = {
diff --git a/editor/js/CmdSetScene.js b/editor/js/CmdSetScene.js
@@ -1,8 +1,13 @@
 /**
- * Created by Daniel on 20.07.15.
+ * @author dforrer / https://github.com/dforrer
  */
 
-CmdSetScene = function ( newScene ) {
+/**
+ * @param scene containing children to import
+ * @constructor
+ */
+
+CmdSetScene = function ( scene ) {
 
 	Cmd.call( this );
 
@@ -11,15 +16,15 @@ CmdSetScene = function ( newScene ) {
 
 	this.cmdArray = [];
 
-	if ( newScene !== undefined ) {
+	if ( scene !== undefined ) {
 
-		this.cmdArray.push( new CmdSetUuid( this.editor.scene, newScene.uuid ) );
-		this.cmdArray.push( new CmdSetValue( this.editor.scene, 'name', newScene.name ) );
-		this.cmdArray.push( new CmdSetValue( this.editor.scene, 'userData', JSON.parse( JSON.stringify( newScene.userData ) ) ) );
+		this.cmdArray.push( new CmdSetUuid( this.editor.scene, scene.uuid ) );
+		this.cmdArray.push( new CmdSetValue( this.editor.scene, 'name', scene.name ) );
+		this.cmdArray.push( new CmdSetValue( this.editor.scene, 'userData', JSON.parse( JSON.stringify( scene.userData ) ) ) );
 
-		while ( newScene.children.length > 0 ) {
+		while ( scene.children.length > 0 ) {
 
-			var child = newScene.children.pop();
+			var child = scene.children.pop();
 			this.cmdArray.push( new CmdAddObject( child ) );
 
 		}
diff --git a/editor/js/CmdSetScriptValue.js b/editor/js/CmdSetScriptValue.js
@@ -1,5 +1,14 @@
 /**
- * Created by Daniel on 21.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param script javascript object
+ * @param attributeName string
+ * @param newValue string, object
+ * @param cursorPosition javascript object with format {line: 2, ch: 3}
+ * @constructor
  */
 
 CmdSetScriptValue = function ( object, script, attributeName, newValue, cursorPosition ) {
@@ -16,7 +25,7 @@ CmdSetScriptValue = function ( object, script, attributeName, newValue, cursorPo
 	this.attributeName = attributeName;
 	this.oldValue = ( script !== undefined ) ? script[ this.attributeName ] : undefined;
 	this.newValue = newValue;
-	this.cursorPosition = cursorPosition; // Format {line: 2, ch: 3}
+	this.cursorPosition = cursorPosition;
 
 };
 
diff --git a/editor/js/CmdSetUuid.js b/editor/js/CmdSetUuid.js
@@ -1,5 +1,11 @@
 /**
- * Created by Daniel on 21.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param newUuid string
+ * @constructor
  */
 
 CmdSetUuid = function ( object, newUuid ) {
diff --git a/editor/js/CmdSetValue.js b/editor/js/CmdSetValue.js
@@ -1,5 +1,12 @@
 /**
- * Created by Daniel on 21.07.15.
+ * @author dforrer / https://github.com/dforrer
+ */
+
+/**
+ * @param object THREE.Object3D
+ * @param attributeName string
+ * @param newValue number, string, boolean or object
+ * @constructor
  */
 
 CmdSetValue = function ( object, attributeName, newValue ) {
diff --git a/editor/js/History.js b/editor/js/History.js
