view org/util.org @ 155:95bf55614211

moved goals and deleted old test
author Robert McIntyre <rlm@mit.edu>
date Fri, 03 Feb 2012 06:04:30 -0700
parents c95179907951
children 33278bf028e7
line wrap: on
line source
1 #+title: Clojure Utilities for jMonkeyEngine3
2 #+author: Robert McIntyre
3 #+email: rlm@mit.edu
4 #+description:
5 #+keywords: JME3, clojure, import, utilities
6 #+SETUPFILE: ../../aurellem/org/setup.org
7 #+INCLUDE: ../../aurellem/org/level-0.org
9 [TABLE-OF-CONTENTS]
11 These are a collection of functions to make programming jMonkeyEngine
12 in clojure easier.
14 * Imports
16 #+name: import
17 #+begin_src clojure :results silent
18 (ns cortex.import
19 (:require swank.util.class-browse))
21 (defn permissive-import
22 [classname]
23 (eval `(try (import '~classname)
24 (catch java.lang.Exception e#
25 (println "couldn't import " '~classname))))
26 classname)
28 (defn jme-class? [classname]
29 (and
30 (.startsWith classname "com.jme3.")
31 ;; Don't import the Lwjgl stuff since it can throw exceptions
32 ;; upon being loaded.
33 (not (re-matches #".*Lwjgl.*" classname))))
35 (defn jme-classes
36 "returns a list of all jme3 classes"
37 []
38 (filter
39 jme-class?
40 (map :name
41 swank.util.class-browse/available-classes)))
43 (defn mega-import-jme3
44 "Import ALL the jme classes. For REPL use."
45 []
46 (doall
47 (map (comp permissive-import symbol) (jme-classes))))
48 #+end_src
50 jMonkeyEngine3 has a plethora of classes which can be overwhelming to
51 manage. This code uses reflection to import all of them. Once I'm
52 happy with the general structure of a namespace I can deal with
53 importing only the classes it actually needs.
55 The =mega-import-jme3= is quite usefull for debugging purposes since
56 it allows completion for almost all of JME's classes from the REPL.
58 Out of curiousity, let's see just how many classes =mega-import-jme3=
59 imports:
61 #+begin_src clojure :exports both :results output
62 (println (clojure.core/count (cortex.import/jme-classes)) "classes")
63 #+end_src
65 #+results:
66 : 955 classes
69 * Utilities
71 The utilities here come in three main groups:
72 - Changing settings in a running =Application=
73 - Creating objects
74 - Debug Actions
75 - Visualizing objects
77 *** Changing Settings
79 #+name: util
80 #+begin_src clojure
81 (ns cortex.util
82 "Utility functions for making jMonkeyEngine3 easier to program from
83 clojure."
84 {:author "Robert McIntyre"}
85 (:use cortex.world)
86 (:use clojure.contrib.def)
87 (:import com.jme3.math.Vector3f)
88 (:import com.jme3.math.Quaternion)
89 (:import com.jme3.asset.TextureKey)
90 (:import com.jme3.bullet.control.RigidBodyControl)
91 (:import com.jme3.bullet.collision.shapes.GImpactCollisionShape)
92 (:import com.jme3.scene.shape.Box)
93 (:import com.jme3.scene.Node)
94 (:import com.jme3.scene.shape.Sphere)
95 (:import com.jme3.light.AmbientLight)
96 (:import com.jme3.light.DirectionalLight)
97 (:import (com.jme3.math Triangle ColorRGBA))
98 (:import com.jme3.bullet.BulletAppState)
99 (:import com.jme3.material.Material)
100 (:import com.jme3.scene.Geometry)
101 (:import java.awt.image.BufferedImage)
102 (:import javax.swing.JPanel)
103 (:import javax.swing.JFrame)
104 (:import javax.swing.SwingUtilities)
106 (:import (java.util.logging Level Logger)))
108 (defvar println-repl
109 (bound-fn [& args] (apply println args))
110 "println called from the LWJGL thread will not go to the REPL, but
111 instead to whatever terminal started the JVM process. This function
112 will always output to the REPL")
114 (defn position-camera
115 "Change the position of the in-world camera."
116 ([world position direction up]
117 (doto (.getCamera world)
118 (.setLocation )
119 (.lookAt direction up)))
120 ([world position direction]
121 (position-camera
122 world position direction Vector3f/UNIT_Y)))
124 (defn enable-debug
125 "Turn on debug wireframes for every object in this simulation."
126 [world]
127 (.enableDebug
128 (.getPhysicsSpace
129 (.getState
130 (.getStateManager world)
131 BulletAppState))
132 (asset-manager)))
134 (defn speed-up
135 "Increase the dismally slow speed of the world's camera."
136 [world]
137 (.setMoveSpeed (.getFlyByCamera world)
138 (float 60))
139 (.setRotationSpeed (.getFlyByCamera world)
140 (float 3))
141 world)
144 (defn no-logging
145 "Disable all of jMonkeyEngine's logging."
146 []
147 (.setLevel (Logger/getLogger "com.jme3") Level/OFF))
149 (defn set-accuracy
150 "Change the accuracy at which the World's Physics is calculated."
151 [world new-accuracy]
152 (let [physics-manager
153 (.getState
154 (.getStateManager world) BulletAppState)]
155 (.setAccuracy
156 (.getPhysicsSpace physics-manager)
157 (float new-accuracy))))
160 (defn set-gravity
161 "In order to change the gravity of a scene, it is not only necessary
162 to set the gravity variable, but to \"tap\" every physics object in
163 the scene to reactivate physics calculations."
164 [world gravity]
165 (traverse
166 (fn [geom]
167 (if-let
168 ;; only set gravity for physical objects.
169 [control (.getControl geom RigidBodyControl)]
170 (do
171 (.setGravity control gravity)
172 ;; tappsies!
173 (.applyImpulse control Vector3f/ZERO Vector3f/ZERO))))
174 (.getRootNode world)))
176 (defn add-element
177 "Add the Spatial to the world's environment"
178 ([world element node]
179 (.addAll
180 (.getPhysicsSpace
181 (.getState
182 (.getStateManager world)
183 BulletAppState))
184 element)
185 (.attachChild node element))
186 ([world element]
187 (add-element world element (.getRootNode world))))
189 (defn apply-map
190 "Like apply, but works for maps and functions that expect an
191 implicit map and nothing else as in (fn [& {}]).
192 ------- Example -------
193 (defn demo [& {:keys [www] :or {www \"oh yeah\"} :as env}]
194 (println www))
195 (apply-map demo {:www \"hello!\"})
196 -->\"hello\""
197 [fn m]
198 (apply fn (reduce #(into %1 %2) [] m)))
200 (defn map-vals
201 "Transform a map by applying a function to its values,
202 keeping the keys the same."
203 [f m] (zipmap (keys m) (map f (vals m))))
206 #+end_src
208 #+results: util
209 : #'cortex.util/apply-map
212 *** Creating Basic Shapes
214 #+name: shapes
215 #+begin_src clojure :results silent
216 (in-ns 'cortex.util)
218 (defn load-bullet
219 "Runnig this function unpacks the native bullet libraries and makes
220 them available."
221 []
222 (let [sim (world (Node.) {} no-op no-op)]
223 (doto sim
224 (.enqueue
225 (fn []
226 (.stop sim)))
227 (.start))))
230 (defrecord shape-description
231 [name
232 color
233 mass
234 friction
235 texture
236 material
237 position
238 rotation
239 shape
240 physical?
241 GImpact?
242 ])
244 (defvar base-shape
245 (shape-description.
246 "default-shape"
247 false
248 ;;ColorRGBA/Blue
249 1.0 ;; mass
250 1.0 ;; friction
251 ;; texture
252 "Textures/Terrain/BrickWall/BrickWall.jpg"
253 ;; material
254 "Common/MatDefs/Misc/Unshaded.j3md"
255 Vector3f/ZERO
256 Quaternion/IDENTITY
257 (Box. Vector3f/ZERO 0.5 0.5 0.5)
258 true
259 false)
260 "Basic settings for shapes.")
262 (defn make-shape
263 [#^shape-description d]
264 (let [asset-manager (asset-manager)
265 mat (Material. asset-manager (:material d))
266 geom (Geometry. (:name d) (:shape d))]
267 (if (:texture d)
268 (let [key (TextureKey. (:texture d))]
269 ;;(.setGenerateMips key true)
270 ;;(.setTexture mat "ColorMap" (.loadTexture asset-manager key))
271 ))
272 (if (:color d) (.setColor mat "Color" (:color d)))
273 (.setMaterial geom mat)
274 (if-let [rotation (:rotation d)] (.rotate geom rotation))
275 (.setLocalTranslation geom (:position d))
276 (if (:physical? d)
277 (let [physics-control
278 (if (:GImpact d)
279 ;; Create an accurate mesh collision shape if desired.
280 (RigidBodyControl.
281 (doto (GImpactCollisionShape.
282 (.getMesh geom))
283 (.createJmeMesh)
284 ;;(.setMargin 0)
285 )
286 (float (:mass d)))
287 ;; otherwise use jme3's default
288 (RigidBodyControl. (float (:mass d))))]
289 (.addControl geom physics-control)
290 ;;(.setSleepingThresholds physics-control (float 0) (float 0))
291 (.setFriction physics-control (:friction d))))
292 geom))
294 (defn box
295 ([l w h & {:as options}]
296 (let [options (merge base-shape options)]
297 (make-shape (assoc options
298 :shape (Box. l w h)))))
299 ([] (box 0.5 0.5 0.5)))
301 (defn sphere
302 ([r & {:as options}]
303 (let [options (merge base-shape options)]
304 (make-shape (assoc options
305 :shape (Sphere. 32 32 (float r))))))
306 ([] (sphere 0.5)))
308 (defn green-x-ray
309 "A usefull material for debuging -- it can be seen no matter what
310 object occuldes it."
311 []
312 (doto (Material. (asset-manager)
313 "Common/MatDefs/Misc/Unshaded.j3md")
314 (.setColor "Color" ColorRGBA/Green)
315 (-> (.getAdditionalRenderState)
316 (.setDepthTest false))))
318 (defn node-seq
319 "Take a node and return a seq of all its children
320 recursively. There will be no nodes left in the resulting
321 structure"
322 [#^Node node]
323 (tree-seq #(isa? (class %) Node) #(.getChildren %) node))
325 (defn nodify
326 "Take a sequence of things that can be attached to a node and return
327 a node with all of them attached"
328 ([name children]
329 (let [node (Node. name)]
330 (dorun (map #(.attachChild node %) children))
331 node))
332 ([children] (nodify "" children)))
335 #+end_src
338 *** Debug Actions
339 #+name: debug-actions
340 #+begin_src clojure :results silent
341 (in-ns 'cortex.util)
343 (defn basic-light-setup
344 "returns a sequence of lights appropiate for fully lighting a scene"
345 []
346 (conj
347 (doall
348 (map
349 (fn [direction]
350 (doto (DirectionalLight.)
351 (.setDirection direction)
352 (.setColor ColorRGBA/White)))
353 [;; six faces of a cube
354 Vector3f/UNIT_X
355 Vector3f/UNIT_Y
356 Vector3f/UNIT_Z
357 (.mult Vector3f/UNIT_X (float -1))
358 (.mult Vector3f/UNIT_Y (float -1))
359 (.mult Vector3f/UNIT_Z (float -1))]))
360 (doto (AmbientLight.)
361 (.setColor ColorRGBA/White))))
363 (defn light-up-everything
364 "Add lights to a world appropiate for quickly seeing everything
365 in the scene. Adds six DirectionalLights facing in orthogonal
366 directions, and one AmbientLight to provide overall lighting
367 coverage."
368 [world]
369 (dorun
370 (map
371 #(.addLight (.getRootNode world) %)
372 (basic-light-setup))))
374 (defn fire-cannon-ball
375 "Creates a function that fires a cannon-ball from the current game's
376 camera. The cannon-ball will be attached to the node if provided, or
377 to the game's RootNode if no node is provided."
378 ([node]
379 (fn [game value]
380 (if (not value)
381 (let [camera (.getCamera game)
382 cannon-ball
383 (sphere 0.7
384 :material "Common/MatDefs/Misc/Unshaded.j3md"
385 :texture "Textures/PokeCopper.jpg"
386 :position
387 (.add (.getLocation camera)
388 (.mult (.getDirection camera) (float 1)))
389 :mass 3)] ;200 0.05
390 (.setLinearVelocity
391 (.getControl cannon-ball RigidBodyControl)
392 (.mult (.getDirection camera) (float 50))) ;50
393 (add-element game cannon-ball (if node node (.getRootNode game)))))))
394 ([]
395 (fire-cannon-ball false)))
397 (def standard-debug-controls
398 {"key-space" (fire-cannon-ball)})
403 #+end_src
406 *** Viewing Objects
408 #+name: world-view
409 #+begin_src clojure :results silent
410 (in-ns 'cortex.util)
412 (defn view-image
413 "Initailizes a JPanel on which you may draw a BufferedImage.
414 Returns a function that accepts a BufferedImage and draws it to the
415 JPanel."
416 []
417 (let [image
418 (atom
419 (BufferedImage. 1 1 BufferedImage/TYPE_4BYTE_ABGR))
420 panel
421 (proxy [JPanel] []
422 (paint
423 [graphics]
424 (proxy-super paintComponent graphics)
425 (.drawImage graphics @image 0 0 nil)))
426 frame (JFrame. "Display Image")]
427 (SwingUtilities/invokeLater
428 (fn []
429 (doto frame
430 (-> (.getContentPane) (.add panel))
431 (.pack)
432 (.setLocationRelativeTo nil)
433 (.setResizable true)
434 (.setVisible true))))
435 (fn [#^BufferedImage i]
436 (reset! image i)
437 (.setSize frame (+ 8 (.getWidth i)) (+ 28 (.getHeight i)))
438 (.repaint panel 0 0 (.getWidth i) (.getHeight i)))))
440 (defprotocol Viewable
441 (view [something]))
443 (extend-type com.jme3.scene.Geometry
444 Viewable
445 (view [geo]
446 (view (doto (Node.)(.attachChild geo)))))
448 (extend-type com.jme3.scene.Node
449 Viewable
450 (view
451 [node]
452 (.start
453 (world
454 node
455 {}
456 (fn [world]
457 (enable-debug world)
458 (set-gravity world Vector3f/ZERO)
459 (light-up-everything world))
460 no-op))))
462 (extend-type com.jme3.math.ColorRGBA
463 Viewable
464 (view
465 [color]
466 (view (doto (Node.)
467 (.attachChild (box 1 1 1 :color color))))))
469 (defprotocol Textual
470 (text [something]
471 "Display a detailed textual analysis of the given object."))
473 (extend-type com.jme3.scene.Node
474 Textual
475 (text [node]
476 (println "Total Vertexes: " (.getVertexCount node))
477 (println "Total Triangles: " (.getTriangleCount node))
478 (println "Controls :")
479 (dorun (map #(text (.getControl node %)) (range (.getNumControls node))))
480 (println "Has " (.getQuantity node) " Children:")
481 (doall (map text (.getChildren node)))))
483 (extend-type com.jme3.animation.AnimControl
484 Textual
485 (text [control]
486 (let [animations (.getAnimationNames control)]
487 (println "Animation Control with " (count animations) " animation(s):")
488 (dorun (map println animations)))))
490 (extend-type com.jme3.animation.SkeletonControl
491 Textual
492 (text [control]
493 (println "Skeleton Control with the following skeleton:")
494 (println (.getSkeleton control))))
496 (extend-type com.jme3.bullet.control.KinematicRagdollControl
497 Textual
498 (text [control]
499 (println "Ragdoll Control")))
501 (extend-type com.jme3.scene.Geometry
502 Textual
503 (text [control]
504 (println "...geo...")))
506 (extend-type Triangle
507 Textual
508 (text [t]
509 (println "Triangle: " \newline (.get1 t) \newline
510 (.get2 t) \newline (.get3 t))))
512 #+end_src
514 Here I make the =Viewable= protocol and extend it to JME's types. Now
515 JME3's =hello-world= can be written as easily as:
517 #+begin_src clojure :results silent
518 (cortex.util/view (cortex.util/box))
519 #+end_src
522 * COMMENT code generation
523 #+begin_src clojure :tangle ../src/cortex/import.clj
524 <<import>>
525 #+end_src
528 #+begin_src clojure :tangle ../src/cortex/util.clj :noweb yes
529 <<util>>
530 <<shapes>>
531 <<debug-actions>>
532 <<world-view>>
533 #+end_src