Mercurial > cortex

annotate org/util.org @ 43:117eb477d0a7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix typo
author Robert McIntyre <rlm@mit.edu>
date Fri, 04 Nov 2011 07:54:20 -0700
parents bc93abad23ee
children ee55966ce7f6
rev   line source
rlm@29 1 #+title: Clojure Utilities for jMonkeyEngine3
rlm@23 2 #+author: Robert McIntyre
rlm@23 3 #+email: rlm@mit.edu
rlm@29 4 #+description:
rlm@29 5 #+keywords: JME3, clojure, import, utilities
rlm@23 6 #+SETUPFILE: ../../aurellem/org/setup.org
rlm@23 7 #+INCLUDE: ../../aurellem/org/level-0.org
rlm@29 8
rlm@34 9 [TABLE-OF-CONTENTS]
rlm@29 10
rlm@29 11 These are a collection of functions to make programming jMonkeyEngine
rlm@29 12 in clojure easier.
rlm@23 13
rlm@34 14 * Imports
rlm@28 15
rlm@23 16 #+srcname: import
rlm@23 17 #+begin_src clojure :results silent
rlm@23 18 (ns cortex.import
rlm@23 19 (:require swank.util.class-browse))
rlm@23 20
rlm@23 21 (defn permissive-import
rlm@23 22 [classname]
rlm@23 23 (eval `(try (import '~classname)
rlm@23 24 (catch java.lang.Exception e#
rlm@23 25 (println "couldn't import " '~classname))))
rlm@23 26 classname)
rlm@23 27
rlm@23 28 (defn jme-class? [classname]
rlm@23 29 (and
rlm@23 30 (.startsWith classname "com.jme3.")
rlm@23 31 ;; Don't import the Lwjgl stuff since it can throw exceptions
rlm@23 32 ;; upon being loaded.
rlm@23 33 (not (re-matches #".*Lwjgl.*" classname))))
rlm@23 34
rlm@23 35 (defn jme-classes
rlm@23 36 "returns a list of all jme3 classes"
rlm@23 37 []
rlm@23 38 (filter
rlm@23 39 jme-class?
rlm@23 40 (map :name
rlm@23 41 swank.util.class-browse/available-classes)))
rlm@23 42
rlm@23 43 (defn mega-import-jme3
rlm@23 44 "Import ALL the jme classes. For REPL use."
rlm@23 45 []
rlm@23 46 (doall
rlm@23 47 (map (comp permissive-import symbol) (jme-classes))))
rlm@23 48 #+end_src
rlm@23 49
rlm@29 50 jMonkeyEngine3 has a plethora of classes which can be overwhelming to
rlm@29 51 manage. This code uses reflection to import all of them. Once I'm
rlm@29 52 happy with the general structure of a namespace I can deal with
rlm@29 53 importing only the classes it actually needs.
rlm@29 54
rlm@23 55 The =mega-import-jme3= is quite usefull for debugging purposes since
rlm@34 56 it allows completion for almost all of JME's classes from the REPL.
rlm@23 57
rlm@23 58 Out of curiousity, let's see just how many classes =mega-import-jme3=
rlm@23 59 imports:
rlm@23 60
rlm@29 61 #+begin_src clojure :exports both :results output
rlm@29 62 (println (clojure.core/count (cortex.import/jme-classes)) "classes")
rlm@23 63 #+end_src
rlm@23 64
rlm@23 65 #+results:
rlm@29 66 : 955 classes
rlm@23 67
rlm@25 68
rlm@34 69 * Utilities
rlm@23 70
rlm@29 71 The utilities here come in three main groups:
rlm@29 72 - Changing settings in a running =Application=
rlm@29 73 - Creating objects
rlm@29 74 - Visualizing objects
rlm@23 75
rlm@23 76
rlm@29 77 *** Changing Settings
rlm@24 78
rlm@25 79 #+srcname: util
rlm@25 80 #+begin_src clojure
rlm@29 81 (ns cortex.util
rlm@34 82 "Utility functions for making jMonkeyEngine3 easier to program from
rlm@34 83 clojure."
rlm@29 84 {:author "Robert McIntyre"}
rlm@29 85 (:use cortex.world)
rlm@29 86 (:use clojure.contrib.def)
rlm@29 87 (:import com.jme3.math.Vector3f)
rlm@29 88 (:import com.jme3.math.Quaternion)
rlm@29 89 (:import com.jme3.asset.TextureKey)
rlm@29 90 (:import com.jme3.bullet.control.RigidBodyControl)
rlm@29 91 (:import com.jme3.bullet.collision.shapes.GImpactCollisionShape)
rlm@29 92 (:import com.jme3.scene.shape.Box)
rlm@29 93 (:import com.jme3.scene.Node)
rlm@29 94 (:import com.jme3.scene.shape.Sphere)
rlm@29 95 (:import com.jme3.light.DirectionalLight)
rlm@29 96 (:import com.jme3.math.ColorRGBA)
rlm@29 97 (:import com.jme3.bullet.BulletAppState)
rlm@29 98 (:import com.jme3.material.Material)
rlm@40 99 (:import com.jme3.scene.Geometry)
rlm@40 100 (:import (java.util.logging Level Logger)))
rlm@40 101
rlm@40 102
rlm@25 103
rlm@29 104 (defvar println-repl
rlm@29 105 (bound-fn [& args] (apply println args))
rlm@29 106 "println called from the LWJGL thread will not go to the REPL, but
rlm@29 107 instead to whatever terminal started the JVM process. This function
rlm@29 108 will always output to the REPL")
rlm@25 109
rlm@29 110 (defn position-camera
rlm@34 111 "Change the position of the in-world camera."
rlm@34 112 ([world position direction up]
rlm@34 113 (doto (.getCamera world)
rlm@29 114 (.setLocation )
rlm@29 115 (.lookAt direction up)))
rlm@34 116 ([world position direction]
rlm@29 117 (position-camera
rlm@34 118 world position direction Vector3f/UNIT_Y)))
rlm@25 119
rlm@29 120 (defn enable-debug
rlm@34 121 "Turn on debug wireframes for every object in this simulation."
rlm@29 122 [world]
rlm@29 123 (.enableDebug
rlm@29 124 (.getPhysicsSpace
rlm@29 125 (.getState
rlm@29 126 (.getStateManager world)
rlm@29 127 BulletAppState))
rlm@29 128 (asset-manager)))
rlm@29 129
rlm@40 130 (defn no-logging
rlm@40 131 "Disable all of jMonkeyEngine's logging."
rlm@40 132 []
rlm@40 133 (.setLevel (Logger/getLogger "com.jme3") Level/OFF))
rlm@40 134
rlm@40 135 (defn set-accuracy
rlm@40 136 "Change the accuracy at which the World's Physics is calculated."
rlm@40 137 [world new-accuracy]
rlm@40 138 (let [physics-manager
rlm@40 139 (.getState
rlm@40 140 (.getStateManager world) BulletAppState)]
rlm@40 141 (.setAccuracy
rlm@40 142 (.getPhysicsSpace physics-manager)
rlm@40 143 (float new-accuracy))))
rlm@40 144
rlm@40 145
rlm@34 146 (defn set-gravity
rlm@29 147 "In order to change the gravity of a scene, it is not only necessary
rlm@29 148 to set the gravity variable, but to \"tap\" every physics object in
rlm@29 149 the scene to reactivate physics calculations."
rlm@34 150 [world gravity]
rlm@25 151 (traverse
rlm@25 152 (fn [geom]
rlm@25 153 (if-let
rlm@29 154 ;; only set gravity for physical objects.
rlm@25 155 [control (.getControl geom RigidBodyControl)]
rlm@25 156 (do
rlm@25 157 (.setGravity control gravity)
rlm@29 158 ;; tappsies!
rlm@29 159 (.applyImpulse control Vector3f/ZERO Vector3f/ZERO))))
rlm@34 160 (.getRootNode world)))
rlm@29 161
rlm@29 162 (defn add-element
rlm@34 163 "Add the Spatial to the world's environment"
rlm@34 164 ([world element node]
rlm@29 165 (.addAll
rlm@29 166 (.getPhysicsSpace
rlm@29 167 (.getState
rlm@34 168 (.getStateManager world)
rlm@29 169 BulletAppState))
rlm@29 170 element)
rlm@29 171 (.attachChild node element))
rlm@34 172 ([world element]
rlm@34 173 (add-element world element (.getRootNode world))))
rlm@29 174
rlm@29 175 (defn apply-map
rlm@29 176 "Like apply, but works for maps and functions that expect an
rlm@29 177 implicit map and nothing else as in (fn [& {}]).
rlm@29 178 ------- Example -------
rlm@29 179 (defn demo [& {:keys [www] :or {www \"oh yeah\"} :as env}]
rlm@29 180 (println www))
rlm@29 181 (apply-map demo {:www \"hello!\"})
rlm@29 182 -->\"hello\""
rlm@29 183 [fn m]
rlm@29 184 (apply fn (reduce #(into %1 %2) [] m)))
rlm@29 185
rlm@25 186 #+end_src
rlm@25 187
rlm@25 188
rlm@29 189 *** Creating Basic Shapes
rlm@29 190
rlm@25 191 #+srcname: shapes
rlm@25 192 #+begin_src clojure :results silent
rlm@25 193 (in-ns 'cortex.util)
rlm@29 194
rlm@25 195 (defrecord shape-description
rlm@25 196 [name
rlm@25 197 color
rlm@25 198 mass
rlm@25 199 friction
rlm@25 200 texture
rlm@25 201 material
rlm@25 202 position
rlm@25 203 rotation
rlm@25 204 shape
rlm@29 205 physical?
rlm@29 206 GImpact?
rlm@29 207 ])
rlm@25 208
rlm@34 209 (defvar base-shape
rlm@25 210 (shape-description.
rlm@25 211 "default-shape"
rlm@25 212 false
rlm@25 213 ;;ColorRGBA/Blue
rlm@25 214 1.0 ;; mass
rlm@25 215 1.0 ;; friction
rlm@25 216 ;; texture
rlm@25 217 "Textures/Terrain/BrickWall/BrickWall.jpg"
rlm@25 218 ;; material
rlm@25 219 "Common/MatDefs/Misc/Unshaded.j3md"
rlm@25 220 Vector3f/ZERO
rlm@25 221 Quaternion/IDENTITY
rlm@25 222 (Box. Vector3f/ZERO 0.5 0.5 0.5)
rlm@29 223 true
rlm@34 224 false)
rlm@34 225 "Basic settings for shapes.")
rlm@25 226
rlm@25 227 (defn make-shape
rlm@25 228 [#^shape-description d]
rlm@29 229 (let [asset-manager (asset-manager)
rlm@25 230 mat (Material. asset-manager (:material d))
rlm@25 231 geom (Geometry. (:name d) (:shape d))]
rlm@25 232 (if (:texture d)
rlm@25 233 (let [key (TextureKey. (:texture d))]
rlm@34 234 ;;(.setGenerateMips key true)
rlm@34 235 ;;(.setTexture mat "ColorMap" (.loadTexture asset-manager key))
rlm@34 236 ))
rlm@25 237 (if (:color d) (.setColor mat "Color" (:color d)))
rlm@25 238 (.setMaterial geom mat)
rlm@25 239 (if-let [rotation (:rotation d)] (.rotate geom rotation))
rlm@25 240 (.setLocalTranslation geom (:position d))
rlm@25 241 (if (:physical? d)
rlm@29 242 (let [physics-control
rlm@29 243 (if (:GImpact d)
rlm@29 244 ;; Create an accurate mesh collision shape if desired.
rlm@29 245 (RigidBodyControl.
rlm@29 246 (doto (GImpactCollisionShape.
rlm@29 247 (.getMesh geom))
rlm@29 248 (.createJmeMesh)
rlm@29 249 (.setMargin 0))
rlm@29 250 (float (:mass d)))
rlm@29 251 ;; otherwise use jme3's default
rlm@29 252 (RigidBodyControl. (float (:mass d))))]
rlm@25 253 (.addControl geom physics-control)
rlm@25 254 ;;(.setSleepingThresholds physics-control (float 0) (float 0))
rlm@25 255 (.setFriction physics-control (:friction d))))
rlm@25 256 geom))
rlm@25 257
rlm@25 258 (defn box
rlm@25 259 ([l w h & {:as options}]
rlm@25 260 (let [options (merge base-shape options)]
rlm@25 261 (make-shape (assoc options
rlm@25 262 :shape (Box. l w h)))))
rlm@25 263 ([] (box 0.5 0.5 0.5)))
rlm@25 264
rlm@25 265 (defn sphere
rlm@25 266 ([r & {:as options}]
rlm@25 267 (let [options (merge base-shape options)]
rlm@25 268 (make-shape (assoc options
rlm@25 269 :shape (Sphere. 32 32 (float r))))))
rlm@25 270 ([] (sphere 0.5)))
rlm@29 271 #+end_src
rlm@25 272
rlm@29 273 *** Viewing Objects
rlm@25 274
rlm@29 275 #+srcname: world-view
rlm@29 276 #+begin_src clojure :results silent
rlm@29 277 (in-ns 'cortex.util)
rlm@25 278
rlm@29 279 (defprotocol Viewable
rlm@29 280 (view [something]))
rlm@29 281
rlm@29 282 (extend-type com.jme3.scene.Geometry
rlm@29 283 Viewable
rlm@29 284 (view [geo]
rlm@29 285 (view (doto (Node.)(.attachChild geo)))))
rlm@29 286
rlm@29 287 (extend-type com.jme3.scene.Node
rlm@29 288 Viewable
rlm@29 289 (view
rlm@29 290 [node]
rlm@29 291 (.start
rlm@29 292 (world
rlm@29 293 node
rlm@29 294 {}
rlm@29 295 (fn [world]
rlm@29 296 (enable-debug world)
rlm@29 297 (set-gravity world Vector3f/ZERO)
rlm@29 298 (let [sun
rlm@29 299 (doto (DirectionalLight.)
rlm@29 300 (.setDirection
rlm@29 301 (.normalizeLocal (Vector3f. 1 0 -2)))
rlm@29 302 (.setColor ColorRGBA/White))]
rlm@34 303 ;; lights are required to view some objects.
rlm@29 304 (.addLight (.getRootNode world) sun)))
rlm@29 305 no-op))))
rlm@25 306 #+end_src
rlm@25 307
rlm@29 308 Here I make the =Viewable= protocol and extend it to JME's types. Now
rlm@34 309 JME3's =hello-world= can be written as easily as:
rlm@29 310
rlm@29 311 #+begin_src clojure :results silent
rlm@29 312 (cortex.util/view (cortex.util/box))
rlm@29 313 #+end_src
rlm@29 314
rlm@29 315
rlm@24 316 * COMMENT code generation
rlm@24 317 #+begin_src clojure :tangle ../src/cortex/import.clj
rlm@24 318 <<import>>
rlm@24 319 #+end_src
rlm@25 320
rlm@25 321
rlm@29 322 #+begin_src clojure :tangle ../src/cortex/util.clj :noweb yes
rlm@25 323 <<util>>
rlm@25 324 <<shapes>>
rlm@29 325 <<world-view>>
rlm@25 326 #+end_src
rlm@25 327
rlm@29 328
rlm@29 329
rlm@29 330
rlm@29 331
rlm@29 332
rlm@29 333
rlm@29 334
rlm@29 335
rlm@29 336
rlm@29 337
rlm@29 338
rlm@29 339
rlm@29 340
rlm@29 341
rlm@29 342
rlm@29 343