Permalink
Browse files

Move from clj-processing to Quil

  • Loading branch information...
samaaron committed Mar 5, 2012
1 parent 5825789 commit 32871e15056f6841470633093e6340173d5b20be
View

Large diffs are not rendered by default.

Oops, something went wrong.
View
@@ -1,78 +0,0 @@
-# Processing for Clojure #
-
-This lib is a wrapper for the [Processing][] project. Mixture of
-Clojure and Processing enables you to do live-coding and experiment
-easily.
-
-Most of the function are covered; some have a slightly different name
-than in Java (partly because Clojure is confused by methods of the
-same arity but different argument types). Most of the constants are
-accessible.
-
-## How To Use It? ##
-
-*NOTE*: project is currently going through some cleanups when it comes
- to lein/maven compatibility. Untill that's finished, you pretty much
- have to setup your project manually.
-
-If you use mave or leiningn, just add the following to your
-`project.clj`:
-
- [processing-core/processsing.core "0.1.0"]
-
-## Manual Setup
-
-Add Processing's `core.jar` to your classpath along with
-clj-processing jar and you're ready to go.
-
-To use the OpenGL features, you also have to add `gluegen-rt.jar`,
-`jogl.jar` and `opengl.jar` from the
-`$PROCESSING_DIR/libraries/opengl/library`. You also need to pass the
-argument:
-
- -Djava.library.path=`$PROCESSING_DIR/libraries/opengl/library
-
-to the JVM.
-
-Then, create a JAR by running `ant` and also add the resulting file to
-your CLASSPATH.
-
-## Examples ##
-
-The `examples` directory contains a simple script to get you going.
-
-## COMMON ISSUES ##
-
-clj-procesing may not work if you're using `add-classpath` to put the
-Processing jars into your CLASSPATH. Please, use a "proper" way to set
-up your CLASSPATH (eg. with a special script like the [clj][cljscript]
-on Clojure Wiki)
-
-If your're using Clojure's `proxy` macro, you'll have to define the
-mouse handling methods to take one argument (which is just an instance
-of java.awt.event.MouseEvent class) and get all needed information
-(like mouse position etc) from that object. Also, accessing instance
-fields of the PApplet class from within proxy doesn't work.
-
-## License
-
-`processing.core` is distributed under Common Public License Version
-1.0. The official Processing.org's core.jar is distributed under LGPG
-and its code can be found on http://processing.org/
-
-## TODO ##
-
-* docstrings
-* include remaining constants
-
-[processing]:http://processing.org/
-[cljscript]:http://en.wikibooks.org/wiki/Clojure_Programming/Getting_Started#Create_clj_Script
-
-## Contributors ##
-
-* Roland Sadowski
-* Phil Hagelberg
-* Vilson Vieira
-* Marshall T. Vandegrift
-* Ilya Epifanov
-* Sam Aaron
View
@@ -0,0 +1,80 @@
+# Quil
+
+Quil looked up in shock to see Bigelow floating high in the clouds, his balloons rustling merrily in the wind. He gruffed to her from above, "This truly is a party!". Image after image, vista after vista, passed furry Bige's wide-open eyes. The underlying beauty of what he saw unfolded before him. A flock of bezier gulls whistled past him. Beneath his dangling feet a distant shepard called his scribbly sheep in for re-drawing. Goading him from the distance, wooden letters of so many different fonts mocked **PERLIN-WOULD** from the hilltops.
+
+This truly was an amazing place. Here, dreams and reality had been drawn together - all in one Process. "*_Why* would I ever leave?" he barked with joy! *_Why* indeed!
+
+## (mix Processing Clojure)
+
+In one hand Quil holds Processing, a carefully crafted API for making drawing and animation extremely easy to get your biscuit-loving chops around. In the other she clutches Clojure, an interlocking suite of exquisite language abstractions forged by an army of hammocks and wrapped in flowing silky parens of un-braided joy.
+
+In one skilled motion, Quil throws them high into the air together. They bond instantly and fly off into the distance painting their way with immutable trails of brilliant colour. Moments later, you see them swiftly return and hover nearby. Your very own ride to Perlinwould awaits. Summon the winds and ride well, my friend.
+
+## Installation
+
+Simply add Quil as a dependency in your `project.clj`:
+
+ [quil "1.0.0-SNAPSHOT"]
+
+**Please Note:** In order to use the OpenGL features, you need to be using Leiningen 2.x.
+
+## Getting Started
+
+Using Quil is as easy as eating chocolate digestives. You just need to grok three basic concepts:
+
+* The Setup fn
+* The Draw fn
+* The Applet obj
+
+If `setup` and `draw` are hard working *artistic gladiators*, `applet` is the *arena* in which they battle for the glory of art. However, they don't actually fight each other - they work as a team - relentlessly spilling colour all over the arena sands. The crowds roar for messy fight.
+
+`setup` lays all the groundwork and is called only once at the start. `draw`, on the other hand, is called immediately after `setup` has completed, and then repeatedly until you summon it to stop. When you create an `applet` and name your `setup` and `draw` fns, the fun automatically starts.
+
+A simple example is called for:
+
+ (defn setup []
+ (smooth) ;;Turn on anti-aliasing
+ (frame-rate 1) ;;Set framerate to 1 FPS
+ (background 200)) ;;Set the background colour to
+ ;; a nice shade of grey.
+ (defn draw []
+ (stroke (random 255)) ;;Set the stroke colour to a random grey
+ (stroke-weight (random 10)) ;;Set the stroke thickness randomly
+ (fill (random 255)) ;;Set the fill colour to a random grey
+
+ (let [diam (random 100) ;;Set the diameter to a value between 0 and 100
+ x (random (width)) ;;Set the x coord randomly within the applet
+ y (random (height))] ;;Set the y coord randomly within the applet
+ (ellipse x y diam diam))) ;;Draw a circle at x y with the correct diameter
+
+ (defapplet example ;;Define a new applet named example
+ :title "Oh so many grey circles" ;;Set the title of the applet
+ :setup setup ;;Specify the setup fn
+ :draw draw ;;Specify the draw fn
+ :size [500 300]) ;;Specify the size to be 500 x 300
+
+
+Feast your eyes on this beauty. You're witnessing `setup`, `draw` and `applet` working in complete harmony. See how `setup` turns on anti-aliasing, sets the framerate to 1 FPS and sets the background colour to a nice shade of grey. `draw` then kicks into action. It chooses random stroke, fill colours as well as a random stroke weight (thickness of the pen). It then chooses some random coordinates and circle size and draws an ellipse. An ellipse with the same height and width is a circle. Finally `defapplet` a convenience macro around `applet` ties everything together, specifies a title and size and starts things running. Don't just watch it though, start modifying it to see immediate effects. Go to town.
+
+## Processing Support
+
+Quil provides support for the standard Processing API. The majority of fns Processing methods have an equivalent Quil fn. Typically, `camelCased` methods have been converted to `hyphenated-versions`. For a full API list (with both Processing and Quil equivalents) see `API.md`.
+
+## API Exploration
+
+Quil supports an explorable API. For a full list of API categories and subcategories simply type `(doc-cats)` at the REPL. In order to see the fns within a specific category use `(doc-fns 1.1)` if `1.1` is the index of the category you wish to examine. If you know the start of Processing API method name such as `bezier`, you can use `(doc-meths "bezier")` to list all Processing API methods starting with `bezier` alongside their Quil equivalents.
+
+## License
+
+Quil is distributed under Common Public License Version 1.0. See LICENCE for details.
+
+The official Processing.org's jars, used as dependencies, are distributed under LGPG and their code can be found on http://processing.org/
+
+## Contributors ##
+
+* Roland Sadowski
+* Phil Hagelberg
+* Vilson Vieira
+* Marshall T. Vandegrift
+* Ilya Epifanov
+* Sam Aaron
View
@@ -1,6 +1,5 @@
(ns example2
- (:use [processing.core]
- [processing.core.applet]))
+ (:use [quil core applet]))
;; here's a function which will be called by Processing's (PApplet)
;; draw method every frame. Place your code here. If you eval it
@@ -37,5 +36,3 @@
:setup setup
:draw draw
:size [200 200])
-
-(applet-start example2)
View
@@ -1,30 +1,26 @@
(ns mouse-example
- (:use [processing.core]
- [processing.core.applet]))
+ (:use [quil core applet]))
-(def mouse-position (atom [0 0]))
+(defn setup []
+ (smooth)
+ (no-stroke)
+ (set-state! :mouse-position (atom [0 0])))
(defn draw
[]
(background-float 125)
(stroke-weight 20)
(stroke-float 10)
- (let [[x y] @mouse-position]
+ (let [[x y] @(state :mouse-position)]
(point x y)))
-(defn setup []
- (smooth)
- (no-stroke))
-
(defn mouse-moved []
(let [x (mouse-x) y (mouse-y)]
- (reset! mouse-position [x y])))
+ (reset! (state :mouse-position) [x y])))
(defapplet mouse-example
:title "Mouse example."
:size [200 200]
:setup setup
:draw draw
:mouse-moved mouse-moved)
-
-(applet-start mouse-example)
@@ -1,7 +1,10 @@
-(ns processing.core.applet
- (:use [processing.core :except (size)]
- [processing.constants]
- [processing.util :only [resolve-constant-key]])
+(ns
+ ^{:doc "Functions and macros for initialising and controlling visualisation applets."
+ :author "Roland Sadowsky, Sam Aaron"}
+ quil.applet
+ (:use [quil.core]
+ [quil.constants]
+ [quil.util :only [resolve-constant-key]])
(:import (javax.swing JFrame)
(java.awt.event WindowListener)))
@@ -1,15 +1,7 @@
-;; Constants for the simple processing wrapper for Clojure
-;; Roland Sadowski [szabla gmail com]
-
-;; Copyright (c) 2008 Roland Sadowski. All rights reserved. The use and
-;; distribution terms for this software are covered by the Common
-;; Public License 1.0 (http://www.opensource.org/licenses/cpl1.0.php)
-;; which can be found in the file CPL.TXT at the root of this
-;; distribution. By using this software in any fashion, you are
-;; agreeing to be bound by the terms of this license. You must not
-;; remove this notice, or any other, from this software.
-
-(ns processing.constants
+(ns
+ ^{:doc "Convenient bindings for most of the Processing.org constants"
+ :author "Roland Sadowsky, Sam Aaron"}
+ quil.constants
(:import [processing.core PApplet PConstants]))
;; renderers known to org.processing.core
@@ -1,19 +1,11 @@
-;; simple processing wrapper for Clojure
-;; Roland Sadowski [szabla gmail com]
-
-;; Copyright (c) 2008 Roland Sadowski. All rights reserved. The use and
-;; distribution terms for this software are covered by the Common
-;; Public License 1.0 (http://www.opensource.org/licenses/cpl1.0.php)
-;; which can be found in the file CPL.TXT at the root of this
-;; distribution. By using this software in any fashion, you are
-;; agreeing to be bound by the terms of this license. You must not
-;; remove this notice, or any other, from this software.
-
-(ns processing.core
+(ns
+ ^{:doc "Wrappers and extensions around the core Processing.org API."
+ :author "Roland Sadowsky, Sam Aaron"}
+ quil.core
(:import [processing.core PApplet PImage PGraphics PFont PConstants PShape])
(:require [clojure.set])
- (:use [processing.constants]
- [processing.util :only [int-like? resolve-constant-key length-of-longest-key gen-padding print-definition-list]]))
+ (:use [quil.constants]
+ [quil.util :only [int-like? resolve-constant-key length-of-longest-key gen-padding print-definition-list]]))
;; used by functions in this lib. Use binding to set it
;; to an instance of processing.core.PApplet
@@ -4152,7 +4144,7 @@
;;; version number
(let [version-stream (.getResourceAsStream (clojure.lang.RT/baseLoader)
- "processing/core/version.properties")
+ "quil/processing-core/version.properties")
properties (doto (new java.util.Properties) (.load version-stream))
prop (fn [k] (.getProperty properties (str "processing.core.version." k)))
processing-version {:major (Integer/valueOf ^String (prop "major"))
@@ -1,4 +1,7 @@
-(ns processing.util)
+(ns
+ ^{:doc "Utility fns"
+ :author "Roland Sadowsky, Sam Aaron"}
+ quil.util)
(defn int-like?
[val]

0 comments on commit 32871e1

Please sign in to comment.