summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Models.html
blob: 4d319a1a62ddaa55ad3cfe5b8aa85f4447f52a40 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!--  Copyright (C) 2017-2023  David Thompson dthompson2@worcester.edu

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".

A copy of the license is also available from the Free Software
Foundation Web site at http://www.gnu.org/licenses/fdl.html.


* Chickadee: (chickadee).     Game programming toolkit for Guile.

The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
  -->
<!--  Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/  -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Models (The Chickadee Game Toolkit)</title>

<meta name="description" content="Models (The Chickadee Game Toolkit)" />
<meta name="keywords" content="Models (The Chickadee Game Toolkit)" />
<meta name="resource-type" content="document" />
<meta name="distribution" content="global" />
<meta name="Generator" content="makeinfo" />
<link href="index.html" rel="start" title="Top" />
<link href="Index.html" rel="index" title="Index" />
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents" />
<link href="Graphics.html" rel="up" title="Graphics" />
<link href="Lights.html" rel="next" title="Lights" />
<link href="Tile-Maps.html" rel="prev" title="Tile Maps" />
<style type="text/css">
&lt;!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
@media (min-width: 1140px) {
    body {
        margin-left: 14rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (min-width: 800px) and (max-width: 1140px) {
    body {
        margin-left: 6rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (max-width: 800px) {
    body {
        margin: 1rem;
    }
}

--&gt;
</style>
<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css" />


</head>

<body lang="en">
<span id="Models"></span><div class="header">
<p>
Next: <a href="Lights.html" accesskey="n" rel="next">Lights</a>, Previous: <a href="Tile-Maps.html" accesskey="p" rel="prev">Tile Maps</a>, Up: <a href="Graphics.html" accesskey="u" rel="up">Graphics</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr />
<span id="Models-1"></span><h4 class="subsection">5.3.8 Models</h4>

<p><em>Disclaimer: Chickadee is alpha software, but 3D model support is
even more alpha than that.  There are many missing features in both
the model loading and rendering components, so set your expectations
accordingly!</em>
</p>
<p>The <code>(chickadee graphics model)</code> module provides procedures to
load and render 3D models in the classic OBJ and more modern glTF 2.0
formats.
</p>
<p>Here&rsquo;s some basic boilerplate to render a 3D model:
</p>
<div class="lisp">
<pre class="lisp"><span class="syntax-open">(</span><span class="syntax-symbol">use-modules</span> <span class="syntax-open">(</span><span class="syntax-symbol">chickadee</span> <span class="syntax-symbol">graphics</span> <span class="syntax-symbol">light</span><span class="syntax-close">)</span>
             <span class="syntax-open">(</span><span class="syntax-symbol">chickadee</span> <span class="syntax-symbol">graphics</span> <span class="syntax-symbol">model</span><span class="syntax-close">)</span>
             <span class="syntax-open">(</span><span class="syntax-symbol">chickadee</span> <span class="syntax-symbol">graphics</span> <span class="syntax-symbol">skybox</span><span class="syntax-close">)</span><span class="syntax-close">)</span>

<span class="syntax-open">(</span><span class="syntax-special">define</span> <span class="syntax-symbol">model</span> <span class="syntax-open">(</span><span class="syntax-symbol">load-gltf</span> <span class="syntax-string">"Suzanne.gltf"</span><span class="syntax-close">)</span><span class="syntax-close">)</span>
<span class="syntax-open">(</span><span class="syntax-special">define</span> <span class="syntax-symbol">camera-position</span> <span class="syntax-open">(</span><span class="syntax-symbol">vec3</span> <span class="syntax-symbol">0.0</span> <span class="syntax-symbol">0.0</span> <span class="syntax-symbol">3.0</span><span class="syntax-close">)</span><span class="syntax-close">)</span>
<span class="syntax-open">(</span><span class="syntax-special">define</span> <span class="syntax-symbol">world</span> <span class="syntax-open">(</span><span class="syntax-symbol">make-identity-matrix4</span><span class="syntax-close">)</span><span class="syntax-close">)</span>
<span class="syntax-open">(</span><span class="syntax-special">define</span> <span class="syntax-symbol">view</span> <span class="syntax-open">(</span><span class="syntax-symbol">look-at</span> <span class="syntax-symbol">camera-position</span> <span class="syntax-open">(</span><span class="syntax-symbol">vec3</span> <span class="syntax-symbol">0.0</span> <span class="syntax-symbol">0.0</span> <span class="syntax-symbol">0.0</span><span class="syntax-close">)</span> <span class="syntax-open">(</span><span class="syntax-symbol">vec3</span> <span class="syntax-symbol">0.0</span> <span class="syntax-symbol">1.0</span> <span class="syntax-symbol">0.0</span><span class="syntax-close">)</span><span class="syntax-close">)</span><span class="syntax-close">)</span>
<span class="syntax-open">(</span><span class="syntax-special">define</span> <span class="syntax-symbol">projection</span> <span class="syntax-open">(</span><span class="syntax-symbol">perspective-projection</span> <span class="syntax-open">(</span><span class="syntax-symbol">/</span> <span class="syntax-symbol">pi</span> <span class="syntax-symbol">3.0</span><span class="syntax-close">)</span> <span class="syntax-open">(</span><span class="syntax-symbol">/</span> <span class="syntax-symbol">4.0</span> <span class="syntax-symbol">3.0</span><span class="syntax-close">)</span> <span class="syntax-symbol">0.1</span> <span class="syntax-symbol">5.0</span><span class="syntax-close">)</span><span class="syntax-close">)</span>

<span class="syntax-open">(</span><span class="syntax-special">define</span> <span class="syntax-open">(</span><span class="syntax-symbol">draw</span> <span class="syntax-symbol">alpha</span><span class="syntax-close">)</span>
  <span class="syntax-open">(</span><span class="syntax-symbol">with-projection</span> <span class="syntax-symbol">projection</span>
    <span class="syntax-open">(</span><span class="syntax-symbol">draw-model</span> <span class="syntax-symbol">model</span> <span class="syntax-symbol">world</span> <span class="syntax-symbol">view</span> <span class="syntax-symbol">camera-position</span>
</pre></div>

<dl>
<dt id="index-load_002dobj">Procedure: <strong>load-obj</strong> <em>file-name</em></dt>
<dd><p>Load the OBJ formatted model in <var>file-name</var> and return a 3D model
object.
</p>
<p>OBJ models are rendered using a Phong lighting model, which is a
work-in-progress.
</p></dd></dl>

<dl>
<dt id="index-load_002dgltf">Procedure: <strong>load-gltf</strong> <em>file-name</em></dt>
<dd><p>Load the glTF 2.0 formatted model in <var>file-name</var> and return a 3D
model object.
</p>
<p>glTF models are rendered using a physically based lighting model,
which is currently a stub to be implemented later.
</p></dd></dl>

<dl>
<dt id="index-model_003f">Procedure: <strong>model?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a 3D model.
</p></dd></dl>

<dl>
<dt id="index-draw_002dmodel">Procedure: <strong>draw-model</strong> <em>model [#:model-matrix] [#:view-matrix]        [#:camera-position (vec3 0 0 0)] [#:skybox] [#:lights '()]</em></dt>
<dd>
<p>Render <var>model</var> with the transformation matrices <var>model-matrix</var>
and <var>view-matrix</var> applied.  <var>camera-position</var> is the world
position of the camera, for correct specular lighting calculations.
<var>skybox</var> is used to apply ambient lighting to the model.
<var>lights</var> contains all of the dynamic lights (see <a href="Lights.html">Lights</a>) that
should have an effect on the model.
</p></dd></dl>

<p>Models are composed of simpler data types: meshes, primitives, and
materials.  Let&rsquo;s start with materials.  A material controls the
appearance of a 3D object.  Is the object a rough stone?  Or maybe a
smooth metal?  Materials control all of this and more.
</p>
<p>There are two types of materials in Chickadee: Phong and PBR.
</p>
<hr />
<div class="header">
<p>
Next: <a href="Lights.html" accesskey="n" rel="next">Lights</a>, Previous: <a href="Tile-Maps.html" accesskey="p" rel="prev">Tile Maps</a>, Up: <a href="Graphics.html" accesskey="u" rel="up">Graphics</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>