0.3.5

* add DisplaceMap Modifier (in progress)
* edits / typos / optimizations
* example / doc updates

Author: Nikos M

api-reference.md

@@ -56,8 +56,9 @@ The taper modifier displaces the vertices on two axes proportionally to their po
 
 Use it with vehicle models for wheels.
 
-     The usual problem with a 3d wheel in a vahicle is that if it is 
-     supposed to turn (steer) and roll in the same time. So, this code:
+     The usual problem with a 3d wheel in a vahicle is that it is 
+     supposed to turn (steer) and roll in the same time. 
+     So, this code:
      
      ```javascript
      wheel.rotationY = 10; // Steer 10deg to the left
@@ -109,6 +110,21 @@ Randomly displaces each vertex in all 3 axes
 
 
 
+ ###DisplaceMap (BitmapDisplacement) Modifier 
+
+ Displaces vertices based on RGB values of bitmapData pixels. 
+ 
+ BitmapDisplacement is inspired by both the AS3 built-in DisplacementMapFilter. It allows
+ to use color values for each channels of a bitmap to modify the position of vertices in a mesh.
+ 
+ The displacement takes place along the cardinal axes, and each axis is mapped to a 
+ channel in the bitmap: X for Red, Y for Green and Z for Blue.
+ 
+ @author Bartek Drozdz
+ 
+
+
+
 ###Perlin modifier 
 
  Displaces vertices based on a perlin/simplex noise source.

build/MOD3.min.js

@@ -51,6 +51,7 @@ SRC =[]
     ./src/modifiers/Wheel.js
     ./src/modifiers/Break.js
     ./src/modifiers/Noise.js
+    ./src/modifiers/DisplaceMap.js
     ./src/modifiers/Perlin.js
 
     # Support for Three.js
@@ -88,7 +89,7 @@ HEADER =
 
 REPLACE =[{}]
 
-    "@@VERSION@@" = "0.3.4"
+    "@@VERSION@@" = "0.3.5"
 
     "@@DEPENDENCIES@@" = "@dependencies: Classy.js"
 

build/mod3.bundle.js

@@ -51,6 +51,7 @@ SRC =[]
     ./src/modifiers/Wheel.js
     ./src/modifiers/Break.js
     ./src/modifiers/Noise.js
+    ./src/modifiers/DisplaceMap.js
     ./src/modifiers/Perlin.js
 
     # Support for Three.js
@@ -68,7 +69,7 @@ HEADER =
 
 REPLACE =[{}]
 
-    "@@VERSION@@" = "0.3.4"
+    "@@VERSION@@" = "0.3.5"
 
     "@@DEPENDENCIES@@" = "@dependencies: Classy.js"
 

build/mod3.three.min.js

@@ -12,11 +12,10 @@ __supports:__  *Three.js* , *Pre3d* , *J3D* , *Copperlicht* , *CubicVR.js*
 
 [![MOD3.js](/flipbook2.png)](http://foo123.github.com/examples/flipbook3/)
 
-It is named *MOD3* to signify that it has support for [Three.js](https://github.com/mrdoob/three.js/)
+    It is named *MOD3* to signify that it has support for [Three.js](https://github.com/mrdoob/three.js/)
 
-    It is a complete port (up to limitations between the 2 frameworks)  
-    Not all Modifiers of AS3DMod can be ported but most can.  
-    However the structure is ready for more modifiers to be added (even custom ones)
+    It is a (almost) complete port. All Modifiers found in AS3DMod are scheduled to be ported. 
+    Also the API architecture is setup for more modifiers to be added (even custom ones).
 
 
 ###Contents
@@ -56,6 +55,7 @@ It is named *MOD3* to signify that it has support for [Three.js](https://github.
 * Bloat
 * Break
 * Perlin ( MOD3 v.0.3.4 )
+* DisplaceMap ( MOD3 v.0.3.5, in progress )
 
 
 ###TODO

dependencies

@@ -6,25 +6,31 @@
 **/
 (function(MOD3, undef){
 
-    var _modCount = 0;
+    var _modCount = 0, NONE = MOD3.ModConstant.NONE;
 
     var Modifier = MOD3.Modifier = MOD3.Class( Object, {
 
         constructor: function( mod ) {
             this.id = ++_modCount;
-            this.name = 'Generic Modifier';
+            this.name = 'Generic';
             this.mod = mod || null;
+            this.axes = NONE;
+            this.constraint = NONE;
             this.enabled = true;
         },
 
         id: null,
         name: null,
         mod : null,
+        axes: null,
+        constraint: null,
         enabled: true,
 
         dispose: function( ) {
             this.mod = null;
             this.name = null;
+            this.axes = null;
+            this.constraint = null;
             return this;
         },
 
@@ -37,19 +43,33 @@
             return this.enabled;
         },
 
+        constraintAxes: function( axes ) {
+            this.axes = axes || NONE;
+            return this;
+        },
+        
+        setConstraint: function( c ) {
+            this.constraint = c || NONE;
+            return this;
+        },
+        
         setModifiable: function( mod ) {
             this.mod = mod;
 
             return this;
         },
 
         getVertices: function( ) {
-            return this.mod.getVertices();
+            return this.mod.getVertices( );
         },
 
+        // override
         apply: function( ) {
-            // override
             return this;
+        },
+        
+        toString: function( ) {
+            return '[Modifier '+this.name+']';
         }
     });
 

dependencies-three

@@ -117,13 +117,13 @@
 
         setXYZ: function( xyz ) {
             // override
-            this,xyz = new A( xyz );
+            this.xyz = new A( xyz );
             return this;
         },
 
         setXYZRef: function( xyz ) {
             // override
-            this,xyz = xyz;
+            this.xyz = xyz;
             return this;
         },
 

readme.md

@@ -16,11 +16,8 @@
 
 (function(MOD3, undef){
 
-    var NONE = MOD3.ModConstant.NONE,
-        LEFT = MOD3.ModConstant.LEFT,
-        RIGHT = MOD3.ModConstant.RIGHT,
-        Matrix = MOD3.Matrix, 
-        Atan = Math.atan, Atan2 = Math.atan2, Sin = Math.sin, Cos = Math.cos,
+    var NONE = MOD3.ModConstant.NONE, LEFT = MOD3.ModConstant.LEFT,  RIGHT = MOD3.ModConstant.RIGHT,
+        Matrix = MOD3.Matrix,  Atan = Math.atan, Atan2 = Math.atan2, Sin = Math.sin, Cos = Math.cos,
         PI = MOD3.Constants.PI, halfPI = MOD3.Constants.halfPI, doublePI = MOD3.Constants.doublePI,
         Point = MOD3.Point
     ;
@@ -52,7 +49,6 @@
         offset: 0,
         angle: 0,
         diagAngle: 0,
-        constraint: NONE,
         max: 0,
         min: 0,
         mid: 0,
@@ -68,7 +64,6 @@
             this.offset = null;
             this.angle = null;
             this.diagAngle = null;
-            this.constraint = null;
             this.max = null;
             this.min = null;
             this.mid = null;
@@ -147,8 +142,8 @@
                 p = (vmax - origin) * invwidth;
 
                 if (
-                    ( (constraint == LEFT) && (p <= offset) ) || 
-                    ( (constraint == RIGHT) && (p >= offset) )
+                    ( (LEFT === constraint) && (p <= offset) ) || 
+                    ( (RIGHT === constraint) && (p >= offset) )
                 ) 
                 {  
                     /* do nothing */