jax 0.0.0.3 → 0.0.0.4

data/guides/source/index.html.erb

@@ -36,13 +36,17 @@
 <% end %>
 
 <%= guide("Lighting", 'lighting.html', :work_in_progress => true) do %>
-  <p>This guide shows how to make the most of lighting support in Jax, and outlines potential caveats.</p>
+  <p>This guide shows how to make the most of lighting support in Jax, and outlines potential caveats. It will also discuss how to prevent certain objects from being lit at all, and in what circumstances you'd want to do this.</p>
 <% end %>
 
 <%= guide("Custom Shaders", 'shaders.html', :work_in_progress => true) do %>
   <p>This guide shows how to add and use your own shaders to add advanced custom visual effects.</p>
 <% end %>
 
+<%= guide("Matrices", "matrices.html", :work_in_progress => true) do%>
+  <p>This guide explains all of the various matrices and "spaces", and how they relate to one another. It will help you understand the difference between world space, camera space and object space; and how a 3D object goes from a set of vertices in object space to a translated, rotated and scaled image on your computer screen.</p>
+<% end %>
+
 <%= guide("Testing Jax Applications", 'testing.html', :work_in_progress => true) do %>
   <p>This is a comprehensive guide to testing a Jax application. It covers everything from &quot;What is a test?&quot; to the testing APIs.</p>
 <% end %>

data/guides/source/matrices.textile

@@ -0,0 +1,5 @@
+h2. This Guide Not Yet Started
+
+Please come back after I've had time to work on this guide a bit.
+
+endprologue.

data/lib/jax/generators/app/app_generator.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext'
+require 'rbconfig'
 require File.join(File.dirname(__FILE__), "../../../jax")
 
 module Jax
@@ -55,14 +56,24 @@ module Jax
         end
         
         def git
-          if File.exist? '.git'
-            say_status :exist, 'git', :blue
+          void = RbConfig::CONFIG['host_os'] =~ /msdos|mswin|djgpp|mingw/ ? 'NUL' : '/dev/null'
+          if system "git --version >>#{void} 2>&1"
+            if File.exist? '.git'
+              say_status :exist, 'git', :blue
+            else
+              `git init`
+              `git add *`
+              say_status :init, 'git', :green
+            end
           else
-            `git init`
-            `git add *`
-            say_status :init, 'git', :green
+            say_status :warn, "Git does not seem to be installed. Skipping...", :yellow
           end
         end
+        
+        def done
+          # to clarify that everything is fine, just in case the user got warnings about git
+          say_status :complete, "Done!", :green
+        end
 
         protected
         def self.banner

data/lib/jax/generators/app/templates/public/javascripts/jax.js

@@ -3073,11 +3073,11 @@ Jax.MatrixStack = (function() {
   }
 
   return Jax.Class.create({
-    push: function() { pushMatrix(this); },
+    push: function() { pushMatrix(this); return this; },
 
-    pop: function() { this.depth--; },
+    pop: function() { this.depth--; return this; },
 
-    reset: function() { this.depth = 0; },
+    reset: function() { this.depth = 0; return this; },
 
     loadModelMatrix: function(values) { loadMatrix(this, MODEL, values); return this; },
 
@@ -3819,8 +3819,12 @@ Jax.Shader = (function() {
     return source;
   }
 
+  function sourceWithoutComments(source) {
+    return source.replace(/\/\*.*\*\//g, "");
+  }
+
   function numArgumentsInMain(source) {
-    var result = /void\s*main\((.*?)\)\s*\{/.exec(source);
+    var result = /void\s*main\((.*?)\)\s*\{/.exec(sourceWithoutComments(source));
     if (result) {
       result = result[1].replace(/\s*/g, '');
       if (result == "" || result == "void") return 0;
@@ -4310,7 +4314,7 @@ Jax.ShaderChain = (function() {
   function preprocessFunctions(self, prefix, suffix, source) {
     /* TODO mangle all function and structure names to prevent conflicts -- right now we only mangle main() */
 
-    return source.replace(/void\s*main\s*\(/, 'void '+sanitizeName(prefix)+'_main_'+sanitizeName(suffix)+'(');
+    return source.replace(/void\s*main\s*\(/g, 'void '+sanitizeName(prefix)+'_main_'+sanitizeName(suffix)+'(');
   }
 
   function preprocessorOptions(self) {
@@ -4450,11 +4454,18 @@ Jax.ShaderChain = (function() {
         functionCalls += "  "+sanitizeName(this.phases[i].getName())+i+"_main_f("+args+");\n";
       }
 
+      var colors = "#ifdef PASS_TYPE\n"
+                 + "  if (PASS_TYPE == "+Jax.Scene.ILLUMINATION_PASS+") gl_FragColor = ambient + diffuse + specular;\n"
+                 + "  else gl_FragColor = ambient;\n"
+                 + "#else\n"
+                 + "  gl_FragColor = ambient + diffuse + specular;\n"
+                 + "#endif\n";
+
       return "/**** Shader chain generated #main ****/\n" +
              "void main(void) {\n" +
                "vec4 ambient = vec4(1.0,1.0,1.0,1.0), diffuse = vec4(1.0,1.0,1.0,1.0), specular = vec4(1.0,1.0,1.0,1.0);\n" +
                functionCalls +
-               (lastTookArguments ? "gl_FragColor = ambient + diffuse + specular;\n" : "") +
+               (lastTookArguments ? colors : "") +
              "}\n";
     },
 
@@ -6100,13 +6111,15 @@ Jax.Scene.LightManager = (function() {
     },
 
     illuminate: function(context, objects, options) {
+      this.context.glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
       for (var i = 0; i < this._lights.length; i++) {
-        this._current_light = i;
         for (var j = 0; j < objects.length; j++) {
+          this._current_light = i;
           /* TODO optimization: see if objects[j] is even affected by this._lights[i] (based on attenuation) */
           if (objects[j].isLit())
             objects[j].render(context, options);
         }
+        this.context.glBlendFunc(GL_ONE, GL_ONE);
       }
       delete this._current_light;
     },
@@ -6562,11 +6575,15 @@ Jax.World = (function() {
 
       if (this.lighting.isEnabled()) {
         /* ambient pass */
-        for (i = 0; i < this.objects.length; i++) {
+        /*
+          So.... I see a legit need for an ambient pass for A) unlit objects and B)
+          scene lighting. But jax doesn't yet support scene lighting so really only
+          unlit objects need an ambient pass. For lit objects, why not let
+          lighting take care of (ambient + diffuse + specular) all at once?
+        */
+        for (i = 0; i < this.objects.length; i++)
           if (!this.objects[i].lit)
             this.objects[i].render(this.context, unlit);
-        }
-        this.lighting.ambient(this.context, this.objects);
 
         /* shadowgen pass */
         this.context.current_pass = Jax.Scene.SHADOWMAP_PASS;
@@ -6576,7 +6593,6 @@ Jax.World = (function() {
         }
 
         /* illumination pass */
-        this.context.glBlendFunc(GL_ONE, GL_ONE);
         this.context.current_pass = Jax.Scene.ILLUMINATION_PASS;
         this.lighting.illuminate(this.context, this.objects);
       } else {

data/lib/jax/generators/commands.rb

@@ -19,11 +19,15 @@ module Jax
         def base_path=(path)
           @base_path = path
         end
+
+        def usage
+          usage = ERB.new(File.read(File.expand_path("USAGE", base_path)), nil, '-')
+          usage.result(binding)
+        end
         
         def start(given_args=ARGV, config={})
           if (given_args.length == 0)
-            usage = ERB.new(File.read(File.expand_path("USAGE", base_path)), nil, '-')
-            puts usage.result(binding)
+            puts usage
           else
             super
           end
@@ -35,6 +39,7 @@ module Jax
     autoload :Model,      File.join(File.dirname(__FILE__), "model/model_generator")
     autoload :LightSource,File.join(File.dirname(__FILE__), "light_source/light_source_generator")
     autoload :Material,   File.join(File.dirname(__FILE__), "material/material_generator")
+    autoload :Shader,     File.join(File.dirname(__FILE__), "shader/shader_generator")
   end
 end
 
@@ -66,16 +71,24 @@ class JaxGeneratorInvoker < Thor
   end
 
   desc "scaffold", "generates a controller, model and material, all with the same name"
-  def scaffold(name)
+  def scaffold(*name)
+    name = name.shift || []
     Jax::Generators::Controller::ControllerGenerator.start([name, 'index'])
     Jax::Generators::Model::ModelGenerator.start([name])
     Jax::Generators::Material::MaterialGenerator.start([name])
   end
+
+  desc "shader", "generates a new custom shader"
+  def shader(*name)
+    Jax::Generators::Shader::ShaderGenerator.start(name)
+  end
 end
 
 class JaxGenerator < Thor
-  desc "generate", "generates a controller, model, light source, or material"
+  desc "generate", "generates a controller, model, light source, material or shader"
   def generate(*args)
     JaxGeneratorInvoker.start(args)
+  rescue ArgumentError
+    puts $!.message
   end
 end

data/lib/jax/generators/material/material_generator.rb

@@ -61,7 +61,7 @@ module Jax
         end
         
         def banner
-          "jax generate light #{self.arguments.map { |a| a.usage }.join(' ')}"
+          "jax generate material #{self.arguments.map { |a| a.usage }.join(' ')}"
         end
 
         def file_name

data/lib/jax/generators/shader/USAGE

@@ -0,0 +1,4 @@
+Usage:
+  jax generate shader NAME
+
+Generates a new custom shader, which can then be used in materials.

data/lib/jax/generators/shader/shader_generator.rb

@@ -0,0 +1,71 @@
+require 'active_support/core_ext'
+
+module Jax
+  module Generators
+    module Shader
+      class ShaderGenerator < Jax::Generators::Command
+        include Thor::Actions
+        argument :name, :desc => "The name of this shader", :banner => "[name]"
+
+        def self.source_root
+          File.expand_path("templates", File.dirname(__FILE__))
+        end
+
+        def check_conflicts
+          if Jax.application.shaders.find(file_name)
+            raise ArgumentError, "A shader called '#{file_name}' already exists!"
+          end
+        end
+             
+        def common
+          template_to 'common.ejs'
+        end
+
+        def fragment
+          template_to 'fragment.ejs'
+        end
+
+        def manifest
+          template_to 'manifest.yml'
+        end
+
+        def material
+          template_to 'material.js'
+        end
+
+        def vertex
+          template_to 'vertex.ejs'
+        end
+
+        def spec
+          template "spec.js.tt", File.join("spec/javascripts/shaders", "#{file_name}_spec.js")
+        end
+        
+        protected
+        def template_to(basename)
+          template "#{basename}.tt", path_to(basename)
+        end
+
+        def path_to(basename)
+          File.join("app/shaders", file_name, basename)
+        end
+
+        def banner
+          "jax generate shader #{self.arguments.map { |a| a.usage }.join(' ')}"
+        end
+
+        def file_name
+          name.underscore
+        end
+        
+        def class_name
+          name.camelize
+        end
+        
+        def plural_name
+          name.pluralize
+        end
+      end
+    end
+  end
+end

data/lib/jax/generators/shader/templates/common.ejs.tt

@@ -0,0 +1,16 @@
+// Shared variables save on graphics memory and allow you to "piggy-back" off of
+// variables defined in other shaders:
+
+shared uniform mat3 nMatrix;
+shared uniform mat4 mvMatrix, pMatrix;
+
+shared varying vec2 vTexCoords;
+shared varying vec3 vNormals;
+shared varying vec4 vColors;
+
+// If a variable isn't shared, it will be defined specifically for this shader.
+// If this shader is used twice in one materials, unshared variables will be
+// defined twice -- once for each use of the shader.
+
+//   uniform sampler2D Texture;
+//   uniform float TextureScaleX, TextureScaleY;

data/lib/jax/generators/shader/templates/fragment.ejs.tt

@@ -0,0 +1,8 @@
+/*
+  If you don't need the color attributes, use
+      void main(void)
+  to make your shader more efficient.
+*/
+void main(inout vec4 ambient, inout vec4 diffuse, inout vec4 specular) {
+
+}

data/lib/jax/generators/shader/templates/manifest.yml.tt

@@ -0,0 +1,15 @@
+description: |
+  Write a brief description for your shader.
+
+
+# Add an 'options' attribute if your shader's Material can accept
+# multiple configurations. Usually, you'll have an option for each
+# corresponding uniform or attribute variable.
+
+# Example:
+
+#options:
+#  path: "/path/to/texture.png"
+#  flip_y: false
+#  scale_x: 1.0
+#  scale_y: 1.0

data/lib/jax/generators/shader/templates/material.js.tt

@@ -0,0 +1,28 @@
+Jax.Material.<%=class_name%> = Jax.Class.create(Jax.Material, {
+  initialize: function($super, options) {
+    options = Jax.Util.normalizeOptions(options, {
+      shader: "<%=file_name%>",
+
+      // You can specify default options (see +manifest.yml+) here.
+    });
+
+    $super(options);
+  },
+  
+  setUniforms: function($super, context, mesh, options, uniforms) {
+    $super(context, mesh, options, uniforms);
+
+    uniforms.set('mvMatrix', context.getModelViewMatrix());
+    uniforms.set('nMatrix', context.getNormalMatrix());
+    uniforms.set('pMatrix', context.getProjectionMatrix());
+
+    // uniforms.texture('Texture', this.texture, context);
+  },
+
+  setAttributes: function($super, context, mesh, options, attributes) {
+    attributes.set('VERTEX_POSITION',  mesh.getVertexBuffer());
+    attributes.set('VERTEX_COLOR',     mesh.getColorBuffer());
+    attributes.set('VERTEX_NORMAL',    mesh.getNormalBuffer());
+    attributes.set('VERTEX_TEXCOORDS', mesh.getTextureCoordsBuffer());
+  }
+});

data/lib/jax/generators/shader/templates/spec.js.tt

@@ -0,0 +1,28 @@
+describe("Shader '<%=file_name%>'", function() {
+  var context, material, mesh;
+
+  beforeEach(function() {
+    context = new Jax.Context('webgl-canvas');
+    mesh = new Jax.Mesh.Quad();
+  });
+
+  describe("stand-alone", function() {
+    beforeEach(function() { mesh.material = new Jax.Material.<%=class_name%>(); });
+
+    it("should render without error", function() {
+      expect(function() { mesh.render(context); }).not.toThrow();
+    });
+  });
+
+  describe("as a layer", function() {
+    beforeEach(function() {
+      mesh.material = new Jax.Material({layers:[{
+        type:"<%=class_name%>"
+      }]});
+    });
+
+    it("should render without error", function() {
+      expect(function() { mesh.render(context); }).not.toThrow();
+    });
+  });
+});

data/lib/jax/generators/shader/templates/vertex.ejs.tt

@@ -0,0 +1,10 @@
+shared attribute vec4 VERTEX_POSITION, VERTEX_COLOR;
+shared attribute vec3 VERTEX_NORMAL;
+shared attribute vec2 VERTEX_TEXCOORDS;
+
+void main(void) {
+  gl_Position = pMatrix * mvMatrix * VERTEX_POSITION;
+//  vNormal = VERTEX_NORMAL;
+//  vColor = VERTEX_COLOR;
+//  vTexCoords = VERTEX_TEXCOORDS;
+}

data/lib/jax/version.rb

@@ -3,7 +3,7 @@ module Jax
     MAJOR = 0
     MINOR = 0
     TINY  = 0
-    PATCH = 3
+    PATCH = 4
 
     STRING = PATCH == 0 ? "#{MAJOR}.#{MINOR}.#{TINY}" : "#{MAJOR}.#{MINOR}.#{TINY}.#{PATCH}"
   end

data/spec/javascripts/jax/webgl/shader_chain_spec.js

@@ -25,7 +25,7 @@ describe("Jax.ShaderChain", function() {
 
   describe("with a fragment main with 3 unqualified arguments", function() {
     beforeEach(function() {
-      chain.addShader(new Jax.Shader({fragment:"void main(vec4 amb, vec4 dif, vec4 spec) { }",name:"one"}));
+      chain.addShader(new Jax.Shader({fragment:"/* comment with void main(void) in it*/\nvoid main(vec4 amb, vec4 dif, vec4 spec) { }",name:"one"}));
     });
     
     it("should mangle #main but keep the arguments", function() {