Improve documentation of model

This commit is contained in:
oakes
2014-05-22 02:42:35 -04:00
parent b59f2f8e55
commit 0cb0af6fb7
2 changed files with 12 additions and 2 deletions

View File

@@ -141,7 +141,7 @@
"model-batch!" :methods}
"ModelBuilder" {"model-builder" :methods
"model-builder!" :methods}
"ModelInstance" {"model" :methods
"ModelInstance" {"model" :constructors
"model!" :methods}
"MouseJointDef" {"joint-def :mouse" :fields}
"Net" {"net!" :methods}

View File

@@ -79,7 +79,17 @@
(throw (Exception. "Asset manager not found. See set-asset-manager!"))))
(defmacro model
"Returns an entity based on [ModelInstance](http://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/graphics/g3d/ModelInstance.html)."
"Returns an entity based on [ModelInstance](http://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/graphics/g3d/ModelInstance.html).
In addition to the listed options, you may also pass an internal path to a model
object created by an external application.
; load a model from a file
(model \"knight.g3dj\")
; create a model from an existing model
(model (model \"knight.g3dj\"))
; set the position of a model
(assoc (model \"knight.g3dj\")
:x 0 :y 0 :z 0)"
[& args]
`(ModelEntity.
(let [arg1# ~(first args)]