cortex: org/util.org comparison

comparison org/util.org @ 34:183744c179e6

MASSIVE cleanup, especially in the vision code

author	Robert McIntyre <rlm@mit.edu>
date	Thu, 03 Nov 2011 08:28:26 -0700
parents	0206878c28b4
children	bc93abad23ee

comparison

equal deleted inserted replaced

-:c377222528e6
+:183744c179e6
 #+description:
 #+keywords: JME3, clojure, import, utilities
 #+SETUPFILE: ../../aurellem/org/setup.org
 #+INCLUDE: ../../aurellem/org/level-0.org
-* Utilities
+[TABLE-OF-CONTENTS]
 These are a collection of functions to make programming jMonkeyEngine
 in clojure easier.
-** Imports
+* Imports
 #+srcname: import
 #+begin_src clojure :results silent
 (ns cortex.import
 (:require swank.util.class-browse))
 manage. This code uses reflection to import all of them. Once I'm
 happy with the general structure of a namespace I can deal with
 importing only the classes it actually needs.
 The =mega-import-jme3= is quite usefull for debugging purposes since
-it allows completion for almost all of JME's classes.
+it allows completion for almost all of JME's classes from the REPL.
 Out of curiousity, let's see just how many classes =mega-import-jme3=
 imports:
 #+begin_src clojure :exports both :results output
 #+results:
 : 955 classes
-** Utilities
+* Utilities
 The utilities here come in three main groups:
 - Changing settings in a running =Application=
 - Creating objects
 - Visualizing objects
 *** Changing Settings
 #+srcname: util
 #+begin_src clojure
 (ns cortex.util
-"Utility functions for making jMonkeyEngine easier to program from
+"Utility functions for making jMonkeyEngine3 easier to program from
-clojure"
+clojure."
 {:author "Robert McIntyre"}
 (:use cortex.world)
 (:use clojure.contrib.def)
 (:import com.jme3.math.Vector3f)
 (:import com.jme3.math.Quaternion)
 "println called from the LWJGL thread will not go to the REPL, but
 instead to whatever terminal started the JVM process. This function
 will always output to the REPL")
 (defn position-camera
-([game position direction up]
+"Change the position of the in-world camera."
-(doto (.getCamera game)
+([world position direction up]
+(doto (.getCamera world)
 (.setLocation )
 (.lookAt direction up)))
-([game position direction]
+([world position direction]
 (position-camera
-game position direction Vector3f/UNIT_Y)))
+world position direction Vector3f/UNIT_Y)))
 (defn enable-debug
-"Turn on the debug wireframes for every object in this simulation"
+"Turn on debug wireframes for every object in this simulation."
 [world]
 (.enableDebug
 (.getPhysicsSpace
 (.getState
 (.getStateManager world)
 BulletAppState))
 (asset-manager)))
 (defn set-gravity
 "In order to change the gravity of a scene, it is not only necessary
 to set the gravity variable, but to \"tap\" every physics object in
 the scene to reactivate physics calculations."
-[game gravity]
+[world gravity]
 (traverse
 (fn [geom]
 (if-let
 ;; only set gravity for physical objects.
 	 [control (.getControl geom RigidBodyControl)]
 (do
 	 (.setGravity control gravity)
 ;; tappsies!
 	 (.applyImpulse control Vector3f/ZERO Vector3f/ZERO))))
-(.getRootNode game)))
+(.getRootNode world)))
 (defn add-element
-"Add the Spatial to the game's environment"
+"Add the Spatial to the world's environment"
-([game element node]
+([world element node]
 (.addAll
 (.getPhysicsSpace
 (.getState
-(.getStateManager game)
+(.getStateManager world)
 BulletAppState))
 element)
 (.attachChild node element))
-([game element]
+([world element]
-(add-element game element (.getRootNode game))))
+(add-element world element (.getRootNode world))))
 (defn apply-map
 "Like apply, but works for maps and functions that expect an
 implicit map and nothing else as in (fn [& {}]).
 ------- Example -------
 shape
 physical?
 GImpact?
 ])
-(def base-shape
+(defvar base-shape
 (shape-description.
 "default-shape"
 false
 ;;ColorRGBA/Blue
 1.0 ;; mass
 "Common/MatDefs/Misc/Unshaded.j3md"
 Vector3f/ZERO
 Quaternion/IDENTITY
 (Box. Vector3f/ZERO 0.5 0.5 0.5)
 true
-false))
+false)
+"Basic settings for shapes.")
 (defn make-shape
 [#^shape-description d]
 (let [asset-manager (asset-manager)
 mat (Material. asset-manager (:material d))
 	geom (Geometry. (:name d) (:shape d))]
 (if (:texture d)
 (let [key (TextureKey. (:texture d))]
-	(.setGenerateMips key true)
+	;;(.setGenerateMips key true)
-	(.setTexture mat "ColorMap" (.loadTexture asset-manager key))))
+	;;(.setTexture mat "ColorMap" (.loadTexture asset-manager key))
+))
 (if (:color d) (.setColor mat "Color" (:color d)))
 (.setMaterial geom mat)
 (if-let [rotation (:rotation d)] (.rotate geom rotation))
 (.setLocalTranslation geom (:position d))
 (if (:physical? d)
 (make-shape (assoc options
 		     :shape (Sphere. 32 32 (float r))))))
 ([] (sphere 0.5)))
 #+end_src
 *** Viewing Objects
 #+srcname: world-view
 #+begin_src clojure :results silent
 (in-ns 'cortex.util)
 (let [sun
 (doto (DirectionalLight.)
 (.setDirection
 (.normalizeLocal (Vector3f. 1 0 -2)))
 (.setColor ColorRGBA/White))]
+;; lights are required to view some objects.
 (.addLight (.getRootNode world) sun)))
 no-op))))
 #+end_src
 Here I make the =Viewable= protocol and extend it to JME's types.  Now
-hello-world can be written as easily as:
+JME3's =hello-world= can be written as easily as:
 #+begin_src clojure :results silent
 (cortex.util/view (cortex.util/box))
 #+end_src

Mercurial > cortex

comparison org/util.org @ 34:183744c179e6