PageRenderTime 51ms CodeModel.GetById 12ms RepoModel.GetById 1ms app.codeStats 0ms

/Languages/IronPython/Samples/Direct3D/readme.htm

http://github.com/IronLanguages/main
HTML | 5154 lines | 3500 code | 1606 blank | 48 comment | 0 complexity | c43fd7937dd862529aa3ab5214c8e60d MD5 | raw file
Possible License(s): CPL-1.0, BSD-3-Clause, ISC, GPL-2.0, MPL-2.0-no-copyleft-exception

Large files files are truncated, but you can click here to view the full file

    

  1. <html>
    2. 

  2. 

  3. <head>
    4. 

  4. <meta http-equiv=Content-Type content="text/html; charset=windows-1252">
    5. 

  5. <meta name=Generator content="Microsoft Word 12 (filtered)">
    6. 

  6. <title>3D Graphics in IronPython</title> 
    7. 

  7. 

  8. <style>
    9. 

  9. <!--
    10. 

  10.  /* Font Definitions */
    11. 

  11.  @font-face
    12. 

  12. 	{font-family:"Cambria Math";
    13. 

  13. 	panose-1:2 4 5 3 5 4 6 3 2 4;}
    14. 

  14. @font-face
    15. 

  15. 	{font-family:Tahoma;
    16. 

  16. 	panose-1:2 11 6 4 3 5 4 4 2 4;}
    17. 

  17. @font-face
    18. 

  18. 	{font-family:Consolas;
    19. 

  19. 	panose-1:2 11 6 9 2 2 4 3 2 4;}
    20. 

  20.  /* Style Definitions */
    21. 

  21.  span.MsoHyperlink
    22. 

  22. 	{color:blue;
    23. 

  23. 	text-decoration:underline;}
    24. 

  24. p.Offset, div.Offset
    25. 

  25. 	{
    26. 

  26. 	mso-style-name: Offset;
    27. 

  27. 	margin-top: 0in;
    28. 

  28. 	margin-right: .5in;
    29. 

  29. 	margin-bottom: 0in;
    30. 

  30. 	margin-left: .5in;
    31. 

  31. 	margin-bottom: .0001pt;
    32. 

  32. 	border: none;
    33. 

  33. 	padding: 0in;
    34. 

  34. 	font-size: 12.0pt;
    35. 

  35. 	font-family: Verdana;
    36. 

  36. }
    37. 

  37. p.OffsetHeader, div.OffsetHeader
    38. 

  38. 	{
    39. 

  39. 	mso-style-name: "Offset Header";
    40. 

  40. 	margin-top: 0in;
    41. 

  41. 	margin-right: .5in;
    42. 

  42. 	margin-bottom: 0in;
    43. 

  43. 	margin-left: .5in;
    44. 

  44. 	margin-bottom: .0001pt;
    45. 

  45. 	text-align: center;
    46. 

  46. 	border: none;
    47. 

  47. 	padding: 0in;
    48. 

  48. 	font-size: 12.0pt;
    49. 

  49. 	font-family: Verdana;
    50. 

  50. 	font-weight: bold;
    51. 

  51. }
    52. 

  52. @page Section1
    53. 

  53. 	{size:8.5in 11.0in;
    54. 

  54. 	margin:1.0in 1.25in 1.0in 1.25in;}
    55. 

  55.  /* List Definitions */
    56. 

  56.   -->
    57. 

  57. </style>
    58. 

  58. 

  59. <link rel="stylesheet" type="text/css" href="../Samples.css">
    60. 

  60. 

  61. </head>
    62. 

  62. 

  63. <body lang=EN-US link=blue vlink=purple>
    64. 

  64. 

  65. <div class=Section1>
    66. 

  66. 

  67.     <hr />
    68. 

  68.         <p class="CopyrightText">
    69. 

  69.             Information in this document is subject to change without notice. The example companies,
    70. 

  70.             organizations, products, people, and events depicted herein are fictitious. No association
    71. 

  71.             with any real company, organization, product, person or event is intended or should
    72. 

  72.             be inferred. Complying with all applicable copyright laws is the responsibility
    73. 

  73.             of the user. Without limiting the rights under copyright, no part of this document
    74. 

  74.             may be reproduced, stored in or introduced into a retrieval system, or transmitted
    75. 

  75.             in any form or by any means (electronic, mechanical, photocopying, recording, or
    76. 

  76.             otherwise), or for any purpose, without the express written permission of Microsoft
    77. 

  77.             Corporation.</p>
    78. 

  78.         <p class="CopyrightText">
    79. 

  79.             &nbsp;</p>
    80. 

  80.         <p class="CopyrightText">
    81. 

  81.             Microsoft may have patents, patent applications, trademarked, copyrights, or other
    82. 

  82.             intellectual property rights covering subject matter in this document. Except as
    83. 

  83.             expressly provided in any written license agreement from Microsoft, the furnishing
    84. 

  84.             of this document does not give you any license to these patents, trademarks, copyrights,
    85. 

  85.             or other intellectual property.</p>
    86. 

  86.         <p class="CopyrightText">
    87. 

  87.             &nbsp;</p>
    88. 

  88.         <div class="Section1">
    89. 

  89. 			<p class="CopyrightText">© Microsoft Corporation. All rights 
    90. 

  90. 			reserved.</p>
    91. 

  91. 			<p class="CopyrightText">&nbsp;</p>
    92. 

  92. 			<p class="CopyrightText">Microsoft, MS-DOS, MS, Windows, Windows NT, 
    93. 

  93. 			MSDN, Active Directory, BizTalk, SQL Server, SharePoint, Outlook, PowerPoint, FrontPage, Visual Basic, 
    94. 

  94. 			Visual C++, Visual J++, Visual InterDev, Visual SourceSafe, Visual C#, Visual J#,&nbsp; and Visual Studio 
    95. 

  95. 			are either registered trademarks or trademarks of Microsoft Corporation in the U.S.A. and/or other 
    96. 

  96. 			countries.</p>
    97. 

  97. 			<p class="CopyrightText">&nbsp;</p>
    98. 

  98. 			<p class="CopyrightText">Other product and company names herein may 
    99. 

  99. 			be the trademarks of their respective owners.</div>
    100. 

  100. 	<hr>
    101. 

  101. 	<p class="body">&nbsp;</p>
    102. 

  102. 	<p class="CopyrightText">This source code is subject to terms and conditions of the Apache License, Version 2.0. A 
    103. 

  103.     copy of the license can be found in the License.html file at the root of this distribution. If 
    104. 

  104.     you cannot locate the  Apache License, Version 2.0, please send an email to
    105. 

  105.     ironpy@microsoft.com. By using this source code in any fashion, you are agreeing to be bound 
    106. 

  106.     by the terms of the Apache License, Version 2.0.</p>
    107. 

  107. 	<p class="CopyrightText">
    108. 

  108.             &nbsp;</p>
    109. 

  109. 	<p class="CopyrightText">
    110. 

  110.             &nbsp;</p>
    111. 

  111. 	<p class=Normal><b>
    112. 

  112. 	<span style='font-size:16.0pt;font-family:"Arial","sans-serif"'>3D
    113. 

  113. Graphics in IronPython</span></b></p>
    114. 

  114. 

  115. <p class=Normal><span style='font-size:14.0pt;font-family:"Arial","sans-serif"'>A
    116. 

  116. Flexible DirectX Framework in IronPython</span></p>
    117. 

  117. 

  118. <p class=Normal><span style='font-size:14.0pt;font-family:"Arial","sans-serif"'>By
    119. 

  119. Lee Culver</span></p>
    120. 

  120. 

  121. <p class=Normal><span style='font-size:10.0pt;font-family:"Courier New"'>&nbsp;</span></p>
    122. 

  122. 

  123. <p class=Normal><span style='font-size:10.0pt;font-family:"Courier New"'>&nbsp;</span></p>
    124. 

  124. 

  125. <p class=Toc1><span
    126. 

  126. class=MsoHyperlink><a href="#_Toc140655628">Getting Started<span
    127. 

  127. style='color:windowtext;display:none;text-decoration:none'>. 2</span></a></span></p>
    128. 

  128. 

  129. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655629">Introduction<span
    130. 

  130. style='color:windowtext;display:none;text-decoration:none'>. 2</span></a></span></p>
    131. 

  131. 

  132. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655630">Prerequisites<span
    133. 

  133. style='color:windowtext;display:none;text-decoration:none'>. 2</span></a></span></p>
    134. 

  134. 

  135. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655631">How to Use
    136. 

  136. this Tutorial<span style='color:windowtext;display:none;text-decoration:none'> 2</span></a></span></p>
    137. 

  137. 

  138. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655632">Objectives
    139. 

  139. for this Tutorial<span style='color:windowtext;display:none;text-decoration:
    140. 

  140. none'> </span><span
    141. 

  141. style='color:windowtext;display:none;text-decoration:none'>2</span></a></span></p>
    142. 

  142. 

  143. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655633">Final Note<span
    144. 

  144. style='color:windowtext;display:none;text-decoration:none'>. 2</span></a></span></p>
    145. 

  145. 

  146. <p class=Toc1><span class=MsoHyperlink><a href="#_Toc140655634">Creating the
    147. 

  147. Framework for a DirectX Application<span style='color:windowtext;display:none;
    148. 

  148. text-decoration:none'>. </span><span
    149. 

  149. style='color:windowtext;display:none;text-decoration:none'>3</span></a></span></p>
    150. 

  150. 

  151. </div>
    152. 

  152. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655635">Loading
    153. 

  153. Assemblies and Importing Them<span style='color:windowtext;display:none;
    154. 

  154. text-decoration:none'>.. </span>
    155. 

  155. <span
    156. 

  156. style='color:windowtext;display:none;text-decoration:none'>3</span></a></span></p>
    157. 

  157. <div class=Section1>
    158. 

  158. 

  159. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655636">The
    160. 

  160. RenderWindow Class<span style='color:windowtext;display:none;text-decoration:
    161. 

  161. none'>. </span><span
    162. 

  162. style='color:windowtext;display:none;text-decoration:none'>4</span></a></span></p>
    163. 

  163. 

  164. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655637">Code
    165. 

  165. Checkpoint 1<span style='color:windowtext;display:none;text-decoration:none'>. 6</span></a></span></p>
    166. 

  166. 

  167. <p class=Toc1><span class=MsoHyperlink><a href="#_Toc140655638">Your First
    168. 

  168. DirectX Application (in IronPython)<span style='color:windowtext;display:none;
    169. 

  169. text-decoration:none'> </span><span
    170. 

  170. style='color:windowtext;display:none;text-decoration:none'>6</span></a></span></p>
    171. 

  171. 

  172. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655639">Setting up
    173. 

  173. DirectX<span style='color:windowtext;display:none;text-decoration:none'>.. 6</span></a></span></p>
    174. 

  174. 

  175. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655640">Code
    176. 

  176. Checkpoint 2<span style='color:windowtext;display:none;text-decoration:none'>. 9</span></a></span></p>
    177. 

  177. 

  178. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655641">An
    179. 

  179. Introduction to Duck Typing<span style='color:windowtext;display:none;
    180. 

  180. text-decoration:none'>. </span><span
    181. 

  181. style='color:windowtext;display:none;text-decoration:none'>9</span></a></span></p>
    182. 

  182. 

  183. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655642">Loading
    184. 

  184. Meshes<span style='color:windowtext;display:none;text-decoration:none'>. 10</span></a></span></p>
    185. 

  185. 

  186. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655643">Rendering
    187. 

  187. Meshes<span style='color:windowtext;display:none;text-decoration:none'>. 11</span></a></span></p>
    188. 

  188. 

  189. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655644">Code
    190. 

  190. Checkpoint 3<span style='color:windowtext;display:none;text-decoration:none'>. 13</span></a></span></p>
    191. 

  191. 

  192. <p class=Toc1><span class=MsoHyperlink><a href="#_Toc140655645">Cameras,
    193. 

  193. Moving Objects, and Events<span style='color:windowtext;display:none;
    194. 

  194. text-decoration:none'>. </span><span
    195. 

  195. style='color:windowtext;display:none;text-decoration:none'>13</span></a></span></p>
    196. 

  196. 

  197. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655646">The Event
    198. 

  198. System<span style='color:windowtext;display:none;text-decoration:none'>.. 14</span></a></span></p>
    199. 

  199. 

  200. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655647">Code
    201. 

  201. Checkpoint 4<span style='color:windowtext;display:none;text-decoration:none'>. 17</span></a></span></p>
    202. 

  202. 

  203. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655648">Exercises<span
    204. 

  204. style='color:windowtext;display:none;text-decoration:none'>. 17</span></a></span></p>
    205. 

  205. 

  206. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655649">Moving
    207. 

  207. Objects on Screen<span style='color:windowtext;display:none;text-decoration:
    208. 

  208. none'>. </span><span
    209. 

  209. style='color:windowtext;display:none;text-decoration:none'>17</span></a></span></p>
    210. 

  210. 

  211. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655650">Rotating
    212. 

  212. Objects on the Screen<span style='color:windowtext;display:none;text-decoration:
    213. 

  213. none'>. </span><span
    214. 

  214. style='color:windowtext;display:none;text-decoration:none'>20</span></a></span></p>
    215. 

  215. 

  216. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655651">Putting it
    217. 

  217. All Together<span style='color:windowtext;display:none;text-decoration:none'> 20</span></a></span></p>
    218. 

  218. 

  219. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655652">Cameras<span
    220. 

  220. style='color:windowtext;display:none;text-decoration:none'>. 21</span></a></span></p>
    221. 

  221. 

  222. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655653">Code
    223. 

  223. Checkpoint<span style='color:windowtext;display:none;text-decoration:none'> 23</span></a></span></p>
    224. 

  224. 

  225. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655654">Exercises<span
    226. 

  226. style='color:windowtext;display:none;text-decoration:none'>. 23</span></a></span></p>
    227. 

  227. 

  228. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655655">Framework
    229. 

  229. Optimization<span style='color:windowtext;display:none;text-decoration:none'>. 24</span></a></span></p>
    230. 

  230. 

  231. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655656">Adding Other
    232. 

  232. Types of Objects<span style='color:windowtext;display:none;text-decoration:
    233. 

  233. none'>. </span><span
    234. 

  234. style='color:windowtext;display:none;text-decoration:none'>26</span></a></span></p>
    235. 

  235. 

  236. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655657">A Better
    237. 

  237. Main Function<span style='color:windowtext;display:none;text-decoration:none'>. 28</span></a></span></p>
    238. 

  238. 

  239. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655658">Code Checkpoint
    240. 

  240. 6<span style='color:windowtext;display:none;text-decoration:none'>. 29</span></a></span></p>
    241. 

  241. 

  242. <p class=Toc1><span class=MsoHyperlink><a href="#_Toc140655659">Cool Things
    243. 

  243. to Do with the Project<span style='color:windowtext;display:none;text-decoration:
    244. 

  244. none'> </span><span
    245. 

  245. style='color:windowtext;display:none;text-decoration:none'>30</span></a></span></p>
    246. 

  246. 

  247. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655660">Moving
    248. 

  248. Objects Around, Part I<span style='color:windowtext;display:none;text-decoration:
    249. 

  249. none'>. </span><span
    250. 

  250. style='color:windowtext;display:none;text-decoration:none'>30</span></a></span></p>
    251. 

  251. 

  252. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655661">Moving
    253. 

  253. Objects Around, Part II<span style='color:windowtext;display:none;text-decoration:
    254. 

  254. none'>. </span><span
    255. 

  255. style='color:windowtext;display:none;text-decoration:none'>31</span></a></span></p>
    256. 

  256. 

  257. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655662">Moving
    258. 

  258. Objects Around, Part III<span style='color:windowtext;display:none;text-decoration:
    259. 

  259. none'>. </span><span
    260. 

  260. style='color:windowtext;display:none;text-decoration:none'>33</span></a></span></p>
    261. 

  261. 

  262. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655663">Auto
    263. 

  263. Tracking<span style='color:windowtext;display:none;text-decoration:none'>. 35</span></a></span></p>
    264. 

  264. 

  265. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655664">Gravity and
    266. 

  266. Free Floating Bodies<span style='color:windowtext;display:none;text-decoration:
    267. 

  267. none'>. </span><span
    268. 

  268. style='color:windowtext;display:none;text-decoration:none'>36</span></a></span></p>
    269. 

  269. 

  270. <p class=Toc1><span class=MsoHyperlink><a href="#_Toc140655665">Where to Go
    271. 

  271. from Here<span style='color:windowtext;display:none;text-decoration:none'>. 40</span></a></span></p>
    272. 

  272. 

  273. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655666">Managed
    274. 

  274. DirectX and XNA<span style='color:windowtext;display:none;text-decoration:none'>.. 40</span></a></span></p>
    275. 

  275. 

  276. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655667">IronPython<span
    277. 

  277. style='color:windowtext;display:none;text-decoration:none'>. 41</span></a></span></p>
    278. 

  278. 

  279. <p class=Toc2><span class=MsoHyperlink><a href="#_Toc140655668">Extending
    280. 

  280. the Framework<span style='color:windowtext;display:none;text-decoration:none'>. 41</span></a></span></p>
    281. 

  281. 

  282. <p class=Normal><span style='font-size:10.0pt;font-family:"Courier New"'>&nbsp;</span></p>
    283. 

  283. 

  284. <p class=Normal><span style='font-size:10.0pt;font-family:"Courier New"'>&nbsp;</span></p>
    285. 

  285. 

  286. <h1><a name="_Toc140655628">Getting Started</a></h1>
    287. 

  287. 

  288. <p class=Normal>&nbsp;</p>
    289. 

  289. 

  290. <h2><a name="_Toc140655629">Introduction</a></h2>
    291. 

  291. 

  292. <p class=Normal>In this tutorial we will be creating a highly flexible
    293. 

  293. Python graphical framework as an introduction to IronPython.  By the end of
    294. 

  294. this tutorial you will have a better understanding of IronPython, a basic grasp
    295. 

  295. of DirectX, and a better understanding of how IronPython utilizes and interacts
    296. 

  296. with the .NET framework. </p>
    297. 

  297. 

  298. <h2><a name="_Toc140655630">Prerequisites</a></h2>
    299. 

  299. 

  300. <p class=Normal>This tutorial assumes only a basic knowledge of the Python
    301. 

  301. syntax and how to use some of its basic constructs (such as lists and tuples). 
    302. 

  302. No prior knowledge of DirectX or Windows.Forms is required, though a basic
    303. 

  303. grasp of the .Net platform will go a long way to understanding a few sections
    304. 

  304. of code.</p>
    305. 

  305. 

  306. <p class=Normal>&nbsp;</p>
    307. 

  307. 

  308. <p class=Normal>We will be building this application from scratch, and all
    309. 

  309. portions of the code will be fully explained.  Note that if you are already
    310. 

  310. familiar with Python, you should probably skip the sections labeled “For Python
    311. 

  311. Beginners.”</p>
    312. 

  312. 

  313. <p class=Normal>&nbsp;</p>
    314. 

  314. 

  315. <p class="body">
    316. 

  316.             Further, you will need the following:</p>
    317. 

  317. 	<ul>
    318. 

  318. 			<li class="normal">IronPython 2.6 distribution
    319. 

  319. 			<ul>
    320. 

  320. 				<li>If you are new to IronPython, please go over the tutorial
    321. 

  321. that comes with this distribution</li>
    322. 

  322. 				<li>Download from 
    323. 

  323. 				<a href="http://ironpython.codeplex.com/Release/ProjectReleases.aspx?ReleaseId=12482">here</a></li>
    324. 

  324. 			</ul>
    325. 

  325. 			</li>
    326. 

  326. 			<li class="normal">DirectX End-user Runtime and a compatible video card<ul>
    327. 

  327. 				<li>Download from 
    328. 

  328. 					<a href="http://www.microsoft.com/games/en-US/aboutgfw/Pages/directx10-a.aspx">here</a>.</li>
    329. 

  329. 			</ul>
    330. 

  330. 			</li>
    331. 

  331. </ul>
    332. 

  332.     <p class=Normal>&nbsp;</p><p class=Normal><b><font size="3">Important Note </font></b></p>
    333. 

  333.     <p class=Normal>If you've previously installed a DirectX SDK there's a good chance you might have the 
    334. 

  334. Managed DirectX 2.0 Beta assembly installed.&nbsp; This assembly is incompatible with the Python sample code 
    335. 

  335. distributed with this tutorial and cannot be uninstalled.&nbsp; If you experience difficulties running the 
    336. 

  336. samples (particularly when there are error messages stating that the <i>Matrix</i> class has no 
    337. 

  337. <i>LookAtLH</i> method) and are sure you meet the prerequisites above, please replace all occurrences 
    338. 

  338. of:</p><p class=Normal><b>&nbsp;&nbsp;&nbsp; </b><i>clr.AddReference(“Microsoft.DirectX”)</i></p>
    339. 

  339. <p class=Normal>with:</p><p class=Normal><b>&nbsp;&nbsp;&nbsp; </b><i>clr.AddReferenceByName('Microsoft.DirectX, Version=1.0.2902.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35')</i></p>
    340. 

  340. <p class=Normal>&nbsp;</p><p class=Normal>throughout the samples.&nbsp; This change basically means that the 
    341. 

  341. sample code will use Managed DirectX 1 instead of the 2.0 beta which would normally have precedence.</p>
    342. 

  342. 

  343. <h2><a name="_Toc140655631">How to Use this Tutorial</a></h2>
    344. 

  344. 

  345. <p class=Normal>This tutorial will start from a small set of code and slowly
    346. 

  346. build a full framework from scratch.  Throughout this tutorial you should be
    347. 

  347. slowly adding code to a Python source file of your own and watching the results
    348. 

  348. as we build it.  There is no substitute for actual programming; I highly
    349. 

  349. recommend that you resist the urge to simply read along.</p>
    350. 

  350. 

  351. <p class=Normal>&nbsp;</p>
    352. 

  352. 

  353. <h2><a name="_Toc140655632">Objectives for this Tutorial</a></h2>
    354. 

  354. 

  355. <p class=Normal>By the end of the first part of this tutorial we will build a framework which will allow you to import any number of DirectX meshes and view 
    356. 

  356. them inside of a .NET form.&nbsp; The framework will provide methods for positioning and rotating objects and the camera, as well as examples of using the 
    357. 

  357. framework to implement more advanced functionality such as having objects move around a track and have cameras auto-track objects in the scene.&nbsp; Lastly, we 
    358. 

  358. will implement a small scale demo which demonstrates Newton’s law of universal
    359. 

  359. gravitation, which will allow you to specify an arbitrary number of free
    360. 

  360. floating bodies in space (planets), and watch them interact with each other.</p>
    361. 

  361. 

  362. <p class=Normal>&nbsp;</p>
    363. 

  363. 

  364. <h2><a name="_Toc140655633">Final Note</a></h2>
    365. 

  365. 

  366. <p class=Normal>Throughout this tutorial be very careful to keep the same
    367. 

  367. indentation levels that have been used here.  In Python, white space is a part of
    368. 

  368. the language, and you must take care to ensure that everything is correctly
    369. 

  369. aligned or you will receive errors.  I suggest setting your text editor of
    370. 

  370. choice to use 4 spaces instead of tabs (which I have done for all code
    371. 

  371. presented here).</p>
    372. 

  372. 

  373. <p class=Normal>&nbsp;</p>
    374. 

  374. 

  375. <p class=Normal>Lastly, if you are getting compile errors, check to make
    376. 

  376. sure you have not inserted extra returns in the middle of statements.  The code
    377. 

  377. may be slightly skewed if you have word wrap turned on.</p>
    378. 

  378. 

  379. <p class=Normal>&nbsp;</p>
    380. 

  380. 

  381. <h1><a name="_Toc140655634">Creating the Framework for a DirectX Application</a></h1>
    382. 

  382. 

  383. <p class=Normal>&nbsp;</p>
    384. 

  384. 

  385. <h3><a name="_Toc140655635">Loading Assemblies and Importing Them</a></h3>
    386. 

  386. 

  387. <p class=Normal>&nbsp;</p>
    388. 

  388. 

  389. <p class=Normal>The first thing we will do is add a few references to
    390. 

  390. assemblies we will be using.  Create a new file called “tutorial.py” and add
    391. 

  391. the following code to it:</p>
    392. 

  392. 

  393. <p class=Normal>&nbsp;</p>
    394. 

  394. 

  395. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    396. 

  396. background:silver;margin-left:.25in;margin-right:.25in'>
    397. 

    398. 

  398. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    399. 

  399. border:none;padding:0in'>import clr</p>
    400. 

    401. 

  401. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    402. 

  402. border:none;padding:0in'>clr.AddReferenceByPartialName(&quot;System.Drawing&quot;)</p>
    403. 

    404. 

  404. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    405. 

  405. border:none;padding:0in'>clr.AddReferenceByPartialName(&quot;System.Windows.Forms&quot;)</p>
    406. 

    407. 

  407. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    408. 

  408. border:none;padding:0in'>clr.AddReferenceByPartialName(&quot;Microsoft.DirectX&quot;)</p><p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    409. 

  409. border:none;padding:0in'>clr.AddReferenceByPartialName(&quot;Microsoft.DirectX.Direct3D&quot;)<span style="background-color: #C0C0C0; background-position: 0% 0%"><br>
    410. 

  410. </span>clr.AddReferenceByPartialName(&quot;Microsoft.DirectX.Direct3DX&quot;)</p>
    411. 

  411. 

  412. </div>
    413. 

  413. 

  414. <p class=Normal>&nbsp;</p>
    415. 

  415. 

  416. <p class=Normal>If you do not add the reference to assemblies that you use,
    417. 

  417. the IronPython interpreter will not know how to load them.  If you run into
    418. 

  418. problems where an import statement does not give the expected results, check to
    419. 

  419. make sure you have referenced all of the appropriate assemblies first.  Note
    420. 

  420. that IronPython automatically adds the “System” library.</p><p class=Normal>&nbsp;</p><p class=Normal>If you encounter 
    421. 

  421. difficulties running the snippet of code above, please see the <b>Important Notes</b> section in the 
    422. 

  422. <a href="#_Toc140655630">Prerequisites</a>.</p>
    423. 

  423. 

  424. <p class=Normal>&nbsp;</p>
    425. 

  425. 

  426. <div>
    427. 

  427. 

  428. <table cellspacing=0 cellpadding=0 hspace=0 vspace=0 align=right>
    429. 

  429.  <tr>
    430. 

  430.   <td valign=top align=left style='padding-top:0in;padding-right:0in;
    431. 

  431.   padding-bottom:0in;padding-left:0in'>
    432. 

  432.   <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    433. 

  433.   margin-left:.5in;margin-right:.5in'>
    434. 

  434.   <p class=OffsetHeader style='margin:0in;margin-bottom:.0001pt;border:none;
    435. 

  435.   padding:0in'>New to IronPython?</p>
    436. 

  436.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    437. 

  437.   padding:0in'>The clr import is not just a library; it actually changes the
    438. 

  438.   dynamics of several basic constructs.  To see this first hand, open up a
    439. 

  439.   fresh IronPython interpreter and run this code:</p>
    440. 

  440.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    441. 

  441.   padding:0in'>&nbsp;</p>
    442. 

  442.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    443. 

  443.   padding:0in'><span style='font-size:10.0pt;font-family:"Courier New"'>print
    444. 

  444.   dir([])</span></p>
    445. 

  445.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    446. 

  446.   padding:0in'><span style='font-size:10.0pt;font-family:"Courier New"'>import
    447. 

  447.   clr</span></p>
    448. 

  448.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    449. 

  449.   padding:0in'><span style='font-size:10.0pt;font-family:"Courier New"'>print
    450. 

  450.   dir([])</span></p>
    451. 

  451.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    452. 

  452.   padding:0in'><span style='font-size:10.0pt;font-family:"Courier New"'>&nbsp;</span></p>
    453. 

  453.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    454. 

  454.   padding:0in'>Notice that it adds a number of functions which makes IronPython
    455. 

  455.   very similar to .NET (though all of the Python functions are still there). 
    456. 

  456.   This also replaces the standard Python string with the .Net string class. 
    457. 

  457.   Throughout this tutorial I will be using the IronPython methods instead of
    458. 

  458.   the standard Python methods as this produces a more consistent code base.</p>
    459. 

  459.   </div>
    460. 

  460.   </td>
    461. 

  461.  </tr>
    462. 

  462. </table>
    463. 

  463. 

  464. </div>
    465. 

  465. 

  466. <br clear=ALL>
    467. 

  467. 

  468. <p class=Normal>&nbsp;</p>
    469. 

  469. 

  470. <p class=Normal>Next we will import all of the libraries we will need for
    471. 

  471. this tutorial.</p>
    472. 

  472. 

  473. <p class=Normal>&nbsp;</p>
    474. 

  474. 

  475. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    476. 

  476. background:silver;margin-left:.25in;margin-right:.25in'>
    477. 

    478. 

  478. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    479. 

  479. border:none;padding:0in'>import System</p>
    480. 

    481. 

  481. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    482. 

  482. border:none;padding:0in'>from System import Drawing</p>
    483. 

    484. 

  484. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    485. 

  485. border:none;padding:0in'>from System.Windows import Forms</p>
    486. 

    487. 

  487. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    488. 

  488. border:none;padding:0in'>from Microsoft import DirectX</p>
    489. 

    490. 

  490. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    491. 

  491. border:none;padding:0in'>from Microsoft.DirectX import Direct3D</p>
    492. 

    493. 

  493. </div>
    494. 

  494. 

  495. <p class=Normal>&nbsp;</p>
    496. 

  496. 

  497. <p class=Normal>In this tutorial I have kept namespaces and never imported
    498. 

  498. everything into the global namespace.  This will make the rest of the tutorial
    499. 

  499. slightly more verbose, but it will also be very explicit as to which functions
    500. 

  500. we are calling.</p>
    501. 

  501. 

  502. <p class=Normal>&nbsp;</p>
    503. 

  503. 

  504. <h3><a name="_Toc140655636">The RenderWindow Class</a></h3>
    505. 

  505. 

  506. <p class=Normal>&nbsp;</p>
    507. 

  507. 

  508. <p class=Normal>The next thing we need to do is to create a new Form to
    509. 

  509. house our application.  In IronPython we can natively derive from any .Net
    510. 

  510. class which is not sealed or a value type.  We will define a constructor which
    511. 

  511. takes in a single argument (a class which contains a “Paused” attribute). 
    512. 

  512. Though I am calling this variable sceneManager here, and we will be providing a
    513. 

  513. class called SceneManager later, we could easily swap it for any other class
    514. 

  514. which understands how to pause and unpause the system:</p>
    515. 

  515. 

  516. <p class=Normal><span style='font-size:10.0pt;font-family:"Courier New"'>&nbsp;</span></p>
    517. 

  517. 

  518. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    519. 

  519. background:silver;margin-left:.25in;margin-right:.25in'>
    520. 

    521. 

  521. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    522. 

  522. border:none;padding:0in'>class RenderWindow(Forms.Form):</p>
    523. 

    524. 

  524. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    525. 

  525. border:none;padding:0in'>    def __init__(self, sceneManager):</p>
    526. 

    527. 

  527. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    528. 

  528. border:none;padding:0in'>        self.SceneManager = sceneManager</p>
    529. 

    530. 

  530. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    531. 

  531. border:none;padding:0in'>        self.Text = &quot;IronPython Direct3D&quot;</p>
    532. 

    533. 

  533. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    534. 

  534. border:none;padding:0in'>        self.ClientSize = Drawing.Size(640, 480)</p>
    535. 

    536. 

  536. </div>
    537. 

  537. 

  538. <p class=Normal>&nbsp;</p>
    539. 

  539. 

  540. <p class=Normal>Here we have set our own instance variable SceneManager to
    541. 

  541. be the sceneManager variable that was passed in.  We have also set the “Text”
    542. 

  542. and “ClientSize” properties, which are properties defined by the Forms.Form
    543. 

  543. class.</p>
    544. 

  544. 

  545. <p class=Normal>&nbsp;</p>
    546. 

  546. 

  547. <div>
    548. 

  548. 

  549. <table cellspacing=0 cellpadding=0 hspace=0 vspace=0 align=right>
    550. 

  550.  <tr>
    551. 

  551.   <td valign=top align=left style='padding-top:0in;padding-right:0in;
    552. 

  552.   padding-bottom:0in;padding-left:0in'>
    553. 

  553.   <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    554. 

  554.   margin-left:.5in;margin-right:.5in'>
    555. 

  555.   <p class=OffsetHeader style='margin:0in;margin-bottom:.0001pt;border:none;
    556. 

  556.   padding:0in'>New to Python?</p>
    557. 

  557.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    558. 

  558.   padding:0in'>When defining a class’s method in Python, you always add a
    559. 

  559.   parameter for the object you are currently operating on.  In languages such
    560. 

  560.   as C# or C++ this parameter is implicitly passed as the “this” parameter. 
    561. 

  561.   Note that we cannot access a class’s member methods or data without using
    562. 

  562.   this self parameter.</p>
    563. 

  563.   </div>
    564. 

  564.   </td>
    565. 

  565.  </tr>
    566. 

  566. </table>
    567. 

  567. 

  568. </div>
    569. 

  569. 

  570. <br clear=ALL>
    571. 

  571. 

  572. <p class=Normal>&nbsp;</p>
    573. 

  573. 

  574. <p class=Normal>Next, we want our window to close (and the application to
    575. 

  575. exit) whenever the escape key is pressed.  We will override the OnKeyDown
    576. 

  576. method of Forms.Form to do this.</p>
    577. 

  577. 

  578. <p class=Normal>&nbsp;</p>
    579. 

  579. 

  580. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    581. 

  581. background:silver;margin-left:.25in;margin-right:.25in'>
    582. 

    583. 

  583. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    584. 

  584. border:none;padding:0in'>    def OnKeyDown(self, args):</p>
    585. 

    586. 

  586. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    587. 

  587. border:none;padding:0in'>        if args.KeyCode ==
    588. 

  588. System.Windows.Forms.Keys.Escape:</p>
    589. 

  589. 

  590. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    591. 

  591. border:none;padding:0in'>            self.Dispose()</p>
    592. 

    593. 

  593. </div>
    594. 

  594. 

  595. <p class=Normal>&nbsp;</p>
    596. 

  596. 

  597. <p class=Normal>Finally, we want the application to pause and stop rendering
    598. 

  598. any time the application is minimized or not visible.  For now we will set the
    599. 

  599. Paused variable on the SceneManager variable we have created.  We will actually
    600. 

  600. implement the code for this later.</p>
    601. 

  601. 

  602. <p class=Normal>&nbsp;</p>
    603. 

  603. 

  604. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    605. 

  605. background:silver;margin-left:.25in;margin-right:.25in'>
    606. 

    607. 

  607. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    608. 

  608. border:none;padding:0in'>    def OnResize(self, args):</p>
    609. 

    610. 

  610. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    611. 

  611. border:none;padding:0in'>        self.SceneManager.Paused = not self.Visible or
    612. 

  612. \</p>
    613. 

  613. 

  614. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    615. 

  615. border:none;padding:0in'>                (self.WindowState ==
    616. 

  616. Forms.FormWindowState.Minimized)</p>
    617. 

  617. 

  618. </div>
    619. 

  619. 

  620. <p class=Normal>&nbsp;</p>
    621. 

  621. 

  622. <p class=Normal>Next we are going to add the shell of the SceneManager
    623. 

  623. class.  The first three methods are very simple (and we will revisit their
    624. 

  624. implementations later).  The first is the constructor, the second is a method
    625. 

  625. which sets up DirectX, and the third is the Render method, which is called
    626. 

  626. from within our render loop.  We will cover these in detail later.</p>
    627. 

  627. 

  628. <p class=Normal>&nbsp;</p>
    629. 

  629. 

  630. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    631. 

  631. background:silver;margin-left:.25in;margin-right:.25in'>
    632. 

    633. 

  633. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    634. 

  634. border:none;padding:0in'>class SceneManager(object):</p>
    635. 

    636. 

  636. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    637. 

  637. border:none;padding:0in'>    def __init__(self):</p>
    638. 

    639. 

  639. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    640. 

  640. border:none;padding:0in'>        pass</p>
    641. 

    642. 

  642. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    643. 

  643. border:none;padding:0in'>&nbsp;</p>
    644. 

    645. 

  645. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    646. 

  646. border:none;padding:0in'>    def InitGraphics(self, handle):</p>
    647. 

    648. 

  648. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    649. 

  649. border:none;padding:0in'>        return True</p>
    650. 

    651. 

  651. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    652. 

  652. border:none;padding:0in'>&nbsp;</p>
    653. 

    654. 

  654. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    655. 

  655. border:none;padding:0in'>    def Render(self):</p>
    656. 

    657. 

  657. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    658. 

  658. border:none;padding:0in'>        pass</p>
    659. 

    660. 

  660. </div>
    661. 

  661. 

  662. <p class=Normal>&nbsp;</p>
    663. 

  663. 

  664. <div>
    665. 

  665. 

  666. <table cellspacing=0 cellpadding=0 hspace=0 vspace=0 align=right>
    667. 

  667.  <tr>
    668. 

  668.   <td valign=top align=left style='padding-top:0in;padding-right:0in;
    669. 

  669.   padding-bottom:0in;padding-left:0in'>
    670. 

  670.   <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    671. 

  671.   margin-left:.5in;margin-right:.5in'>
    672. 

  672.   <p class=OffsetHeader style='margin:0in;margin-bottom:.0001pt;border:none;
    673. 

  673.   padding:0in'>New to Python?</p>
    674. 

  674.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    675. 

  675.   padding:0in'>Whenever we define a method or class which has no body, we
    676. 

  676.   always must use the pass keyword.  This keyword has no meaning outside of
    677. 

  677.   saying “empty code block.”</p>
    678. 

  678.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    679. 

  679.   padding:0in'>&nbsp;</p>
    680. 

  680.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    681. 

  681.   padding:0in'>Note that we have returned True from InitGraphics.  One
    682. 

  682.   important thing to note about Python is that any time you do not return a
    683. 

  683.   value, you are implicitly returning the None type (which is roughly
    684. 

  684.   equivalent to null, with a few exceptions).  This is why you will see some
    685. 

  685.   code paths in Python which have return statements and some which do not. 
    686. 

  686.   This is perfectly valid, and generally accepted as normal.</p>
    687. 

  687.   </div>
    688. 

  688.   </td>
    689. 

  689.  </tr>
    690. 

  690. </table>
    691. 

  691. 

  692. </div>
    693. 

  693. 

  694. <br clear=ALL>
    695. 

  695. 

  696. <p class=Normal>&nbsp;</p>
    697. 

  697. 

  698. <p class=Normal>Next we need to create the render loop for the application. 
    699. 

  699. This loop will pump the Windows.Forms event queue and call the Render method:</p>
    700. 

  700. 

  701. <p class=Normal style='text-autospace:none'><span style='font-size:10.0pt;
    702. 

  702. font-family:Consolas'>&nbsp;</span></p>
    703. 

    704. 

  704. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    705. 

  705. background:silver;margin-left:.25in;margin-right:.25in'>
    706. 

    707. 

  707. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    708. 

  708. border:none;padding:0in'>    def Go(self, window):</p>
    709. 

    710. 

  710. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    711. 

  711. border:none;padding:0in'>        while window.Created:</p>
    712. 

    713. 

  713. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    714. 

  714. border:none;padding:0in'>            self.Render()</p>
    715. 

    716. 

  716. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    717. 

  717. border:none;padding:0in'>            Forms.Application.DoEvents()</p>
    718. 

    719. 

  719. </div>
    720. 

  720. 

  721. <p class=Normal><span style='font-size:10.0pt;font-family:Consolas'>&nbsp;</span></p>
    722. 

  722. 

  723. <p class=Normal>Finally, we will create the main function which creates the
    724. 

  724. basic objects and starts the render loop.</p>
    725. 

  725. 

  726. <p class=Normal>&nbsp;</p>
    727. 

  727. 

  728. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    729. 

  729. background:silver;margin-left:.25in;margin-right:.25in'>
    730. 

    731. 

  731. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    732. 

  732. border:none;padding:0in'>def main():</p>
    733. 

    734. 

  734. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    735. 

  735. border:none;padding:0in'>    sceneManager = SceneManager()</p>
    736. 

    737. 

  737. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    738. 

  738. border:none;padding:0in'>    window = RenderWindow(sceneManager)</p>
    739. 

    740. 

  740. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    741. 

  741. border:none;padding:0in'>&nbsp;</p>
    742. 

    743. 

  743. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    744. 

  744. border:none;padding:0in'>    if not sceneManager.InitGraphics(window.Handle):</p>
    745. 

    746. 

  746. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    747. 

  747. border:none;padding:0in'>        Forms.MessageBox.Show(&quot;Could not init
    748. 

  748. Direct3D.&quot;)</p>
    749. 

  749. 

  750. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    751. 

  751. border:none;padding:0in'>&nbsp;</p>
    752. 

    753. 

  753. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    754. 

  754. border:none;padding:0in'>    else:</p>
    755. 

    756. 

  756. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    757. 

  757. border:none;padding:0in'>        window.Show()</p>
    758. 

    759. 

  759. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    760. 

  760. border:none;padding:0in'>        sceneManager.Go(window)</p>
    761. 

    762. 

  762. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    763. 

  763. border:none;padding:0in'>&nbsp;</p>
    764. 

    765. 

  765. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    766. 

  766. border:none;padding:0in'>if __name__ == '__main__':</p>
    767. 

    768. 

  768. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    769. 

  769. border:none;padding:0in'>    main()</p>
    770. 

    771. 

  771. </div>
    772. 

  772. 

  773. <p class=Normal>&nbsp;</p>
    774. 

  774. 

  775. <div>
    776. 

  776. 

  777. <table cellspacing=0 cellpadding=0 hspace=0 vspace=0 align=right>
    778. 

  778.  <tr>
    779. 

  779.   <td valign=top align=left style='padding-top:0in;padding-right:0in;
    780. 

  780.   padding-bottom:0in;padding-left:0in'>
    781. 

  781.   <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    782. 

  782.   margin-left:.5in;margin-right:.5in'>
    783. 

  783.   <p class=OffsetHeader style='margin:0in;margin-bottom:.0001pt;border:none;
    784. 

  784.   padding:0in'>New to Python?</p>
    785. 

  785.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    786. 

  786.   padding:0in'>In a Python script it is ok to have code which runs at the file
    787. 

  787.   level (that is, not inside of a function, not inside of a class).  This code
    788. 

  788.   is run every time the code is imported.  If you want to have the code run
    789. 

  789.   only when the module is explicitly ran (not imported) we use the built in
    790. 

  790.   __name__ variable to determine if we have been explicitly invoked from the
    791. 

  791.   command line.  It will always equal ‘__main__’ if we have been run from the
    792. 

  792.   command line.  If the module was loaded using the “import” statement,
    793. 

  793.   __name__ would be the name of the file otherwise.</p>
    794. 

  794.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    795. 

  795.   padding:0in'>&nbsp;</p>
    796. 

  796.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    797. 

  797.   padding:0in'>We have explicitly created a main function so that if this code
    798. 

  798.   is imported into an IronPython console, the main function can be invoked
    799. 

  799.   explicitly.  If we replaced the call to main with the contents of the main
    800. 

  800.   function, there would be no way to run the code outside of actually running
    801. 

  801.   it from the command line (and not importing it).  This is sometimes
    802. 

  802.   desirable, but not in our application.  We will be using this much later in
    803. 

  803.   the tutorial when we actually import our framework from a separate file.</p>
    804. 

  804.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    805. 

  805.   padding:0in'>&nbsp;</p>
    806. 

  806.   <p class=Offset style='margin:0in;margin-bottom:.0001pt;border:none;
    807. 

  807.   padding:0in'>Notice also that creating a class does not use the “new” keyword
    808. 

  808.   like C# and C++ do.  The syntax for creating a new class is the exact same
    809. 

  809.   as calling a function.  This is by design.  In many cases we can use function
    810. 

  810.   calls and class constructors interchangeably when we are passing functions as
    811. 

  811.   parameters.</p>
    812. 

  812.   </div>
    813. 

  813.   </td>
    814. 

  814.  </tr>
    815. 

  815. </table>
    816. 

  816. 

  817. </div>
    818. 

  818. 

  819. <br clear=ALL>
    820. 

  820. 

  821. <p class=Normal>&nbsp;</p>
    822. 

  822. 

  823. <p class=Normal>&nbsp;</p>
    824. 

  824. 

  825. <h2><a name="_Toc140655637">Code Checkpoint 1</a></h2>
    826. 

  826. 

  827. <p class=Normal>&nbsp;</p>
    828. 

  828. 

  829. <p class=Normal>Run the code from within IronPython.  You should see an empty
    830. 

  830. Windows.Forms window.  If you are having problems with the code, you should
    831. 

  831. compare your source file with checkpoint1.py.</p>
    832. 

  832. 

  833. <p class=Normal>&nbsp;</p>
    834. 

  834. 

  835. <h1><a name="_Toc140655638">Your First DirectX Application (in IronPython)</a></h1>
    836. 

  836. 

  837. <p class=Normal>&nbsp;</p>
    838. 

  838. 

  839. <p class=Normal>In this section we will create a basic scene in DirectX.  By
    840. 

  840. the end of this section, we will have created a DirectX context, rendered a
    841. 

  841. mesh to the scene, and explored the Python concept of Duck Typing along the
    842. 

  842. way.</p>
    843. 

  843. 

  844. <p class=Normal>&nbsp;</p>
    845. 

  845. 

  846. <h2><a name="_Toc140655639">Setting up DirectX</a></h2>
    847. 

  847. 

  848. <p class=Normal>This section will deal exclusively with the SceneManager
    849. 

  849. class.  The first thing we need to do is initialize a few variables which we
    850. 

  850. will be using in this code.  Be sure to always remove the “pass” statement when
    851. 

  851. we add code to empty methods.</p>
    852. 

  852. 

  853. <p class=Normal>&nbsp;</p>
    854. 

  854. 

  855. <p class=Normal>We will add three variables:  The first will contain our
    856. 

  856. DirectX device when we have created it.  The second will determine if the
    857. 

  857. DirectX context is paused (in case we are minimized or hidden).  The third will
    858. 

  858. be the background color for the DirectX rendering device.</p>
    859. 

  859. 

  860. <p class=Normal>&nbsp;</p>
    861. 

  861. 

  862. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    863. 

  863. background:silver;margin-left:.25in;margin-right:.25in'>
    864. 

    865. 

  865. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    866. 

  866. border:none;padding:0in'>class SceneManager(object):</p>
    867. 

    868. 

  868. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    869. 

  869. border:none;padding:0in'>    def __init__(self):</p>
    870. 

    871. 

  871. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    872. 

  872. border:none;padding:0in'>        self.Device = None</p>
    873. 

    874. 

  874. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    875. 

  875. border:none;padding:0in'>        self.Paused = False</p>
    876. 

    877. 

  877. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    878. 

  878. border:none;padding:0in'>        self.Background = System.Drawing.Color.Black</p>
    879. 

    880. 

  880. </div>
    881. 

  881. 

  882. <p class=Normal>&nbsp;</p>
    883. 

  883. 

  884. <p class=Normal>Next we will fill in the InitGraphics method.  This
    885. 

  885. section of code creates the DirectX device we will use in this tutorial.</p>
    886. 

  886. 

  887. <p class=Normal>&nbsp;</p>
    888. 

  888. 

  889. <p class=Normal>The first thing we will do is set up the parameters that we
    890. 

  890. will pass to DirectX.  We will set DirectX to be in windowed mode, set the swap
    891. 

  891. effect for drawing frames, and enable the auto depth stencil (so that DirectX
    892. 

  892. tracks the depth of our objects for us).  For more information on the specifics
    893. 

  893. on these properties and parameters, consult the DirectX documentation.  Since
    894. 

  894. creating a DirectX device requires a window handle to place it in, we will take
    895. 

  895. in a “handle” parameter to use this.</p>
    896. 

  896. 

  897. <p class=Normal>&nbsp;</p>
    898. 

  898. 

  899. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    900. 

  900. background:silver;margin-left:.25in;margin-right:.25in'>
    901. 

    902. 

  902. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    903. 

  903. border:none;padding:0in'>    def InitGraphics(self, handle):</p>
    904. 

    905. 

  905. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    906. 

  906. border:none;padding:0in'>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; params = Direct3D.PresentParameters()</p>
    907. 

    908. 

  908. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    909. 

  909. border:none;padding:0in'>        params.Windowed = True</p>
    910. 

    911. 

  911. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    912. 

  912. border:none;padding:0in'>        params.SwapEffect =
    913. 

  913. Direct3D.SwapEffect.Discard</p>
    914. 

  914. 

  915. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    916. 

  916. border:none;padding:0in'>        params.EnableAutoDepthStencil = True</p>
    917. 

    918. 

  918. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    919. 

  919. border:none;padding:0in'>        params.AutoDepthStencilFormat =
    920. 

  920. Direct3D.DepthFormat.D16</p>
    921. 

  921. 

  922. </div>
    923. 

  923. 

  924. <p class=Normal>&nbsp;</p>
    925. 

  925. 

  926. <p class=Normal>Now we need to actually create the Direct3D device.  Note
    927. 

  927. that we are passing in the handle parameter to the constructor of the Direct3D
    928. 

  928. device.  This is what tells DirectX to use the window that we have created.  We
    929. 

  929. also pass in the PresentParameters object we just created.   For more specifics
    930. 

  930. on the Device creation parameters, consult the managed DirectX documentation. </p>
    931. 

  931. 

  932. <p class=Normal>&nbsp;</p>
    933. 

  933. 

  934. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    935. 

  935. background:silver;margin-left:.25in;margin-right:.25in'>
    936. 

    937. 

  937. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    938. 

  938. border:none;padding:0in'>        self.Device = Direct3D.Device(0,
    939. 

  939. Direct3D.DeviceType.Hardware, handle,</p>
    940. 

  940. 

  941. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    942. 

  942. border:none;padding:0in'>                                     
    943. 

  943. Direct3D.CreateFlags.SoftwareVertexProcessing,</p>
    944. 

  944. 

  945. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    946. 

  946. border:none;padding:0in'>                                      params)</p>
    947. 

    948. 

  948. </div>
    949. 

  949. 

  950. <p class=Normal>&nbsp;</p>
    951. 

  951. 

  952. <p class=Normal>After creating the device, we need to set a couple of
    953. 

  953. properties on the Device.  The first thing we need to do is enable the
    954. 

  954. ZBuffer.  If we did not do this, we could not draw in 3 dimensions (which is
    955. 

  955. basically the point of this tutorial).  We also need to set the ambient light
    956. 

  956. to be a full white.  There are multiple types of lighting which DirectX uses:
    957. 

  957. diffuse, ambient, specular and emissive.  A full treatise on lighting would be
    958. 

  958. far beyond the scope of this document.  For this tutorial we are going to
    959. 

  959. simply set the ambient light to full (white), and force every mesh we load to
    960. 

  960. use ambient lighting.  This, effectively, turns off lighting so we do not have
    961. 

  961. to worry about it.</p>
    962. 

  962. 

  963. <p class=Normal>&nbsp;</p>
    964. 

  964. 

  965. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    966. 

  966. background:silver;margin-left:.25in;margin-right:.25in'>
    967. 

    968. 

  968. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    969. 

  969. border:none;padding:0in'>        self.Device.RenderState.ZBufferEnable =
    970. 

  970. True</p>
    971. 

  971. 

  972. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    973. 

  973. border:none;padding:0in'>        self.Device.RenderState.Ambient =
    974. 

  974. Drawing.Color.White</p>
    975. 

  975. 

  976. </div>
    977. 

  977. 

  978. <p class=Normal>&nbsp;</p>
    979. 

  979. 

  980. <p class=Normal>&nbsp;</p>
    981. 

  981. 

  982. <p class=Normal>Next we need to set up two of the three matricies which
    983. 

  983. DirectX uses to render the scene.  The Projection matrix is the most
    984. 

  984. complicated.  It basically transforms the 3D matrix of objects into a 2
    985. 

  985. dimensional plane to display on the screen.  We will not have to deal with this
    986. 

  986. matrix after we have set it the first time.</p>
    987. 

  987. 

  988. <p class=Normal>&nbsp;</p>
    989. 

  989. 

  990. <p class=Normal>The second matrix DirectX uses is the View matrix which
    991. 

  991. defines where the camera is looking.  DirectX has some very nice methods which
    992. 

  992. allow us to deal with cameras in a very natural way.  The
    993. 

  993. Matrix.LookAtLH takes in three parameters.  The first is the position
    994. 

  994. of the camera.  The second is what the camera looks at.  The third is the “up”
    995. 

  995. vector, which is the up direction for the camera.  Setting the up vector
    996. 

  996. incorrectly would result in the scene being rotated in strange ways.</p>
    997. 

  997. 

  998. <p class=Normal>&nbsp;</p>
    999. 

  999. 

  1000. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    1001. 

  1001. background:silver;margin-left:.25in;margin-right:.25in'>
    1002. 

    1003. 

  1003. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1004. 

  1004. border:none;padding:0in'>        self.Device.Transform.Projection =
    1005. 

  1005. DirectX.Matrix.PerspectiveFovLH(System.Math.PI/4.0, 1, 1, 100)</p>
    1006. 

  1006. 

  1007. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1008. 

  1008. border:none;padding:0in'>        self.Device.Transform.View =
    1009. 

  1009. DirectX.Matrix.LookAtLH(DirectX.Vector3(<span style='font-size:10.0pt'>0,
    1010. 

  1010. 3, -5</span>), DirectX.Vector3(0, 0, 0), DirectX.Vector3(0, 1, 0))</p>
    1011. 

  1011. 

  1012. </div>
    1013. 

  1013. 

  1014. <p class=Normal>&nbsp;</p>
    1015. 

  1015. 

  1016. <p class=Normal>The rest of our code simply sets the Paused property to be
    1017. 

  1017. false.  We will return true to indicate no error occurred.</p>
    1018. 

  1018. 

  1019. <p class=Normal>&nbsp;</p>
    1020. 

  1020. 

  1021. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    1022. 

  1022. background:silver;margin-left:.25in;margin-right:.25in'>
    1023. 

    1024. 

  1024. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1025. 

  1025. border:none;padding:0in'>        # ensure we are not paused</p>
    1026. 

    1027. 

  1027. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1028. 

  1028. border:none;padding:0in'>        self.Paused = False</p>
    1029. 

    1030. 

  1030. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1031. 

  1031. border:none;padding:0in'>        return True</p>
    1032. 

    1033. 

  1033. </div>
    1034. 

  1034. 

  1035. <p class=Normal>&nbsp;</p>
    1036. 

  1036. 

  1037. <p class=Normal>The last thing we need to do is render the scene.  For now
    1038. 

  1038. this code is very basic, but we will be adding to it later.  First, we only
    1039. 

  1039. render if the Device has already been created and we are not paused.</p>
    1040. 

  1040. 

  1041. <p class=Normal>&nbsp;</p>
    1042. 

  1042. 

  1043. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 0in 4.0pt;
    1044. 

  1044. background:silver;margin-left:.25in;margin-right:.25in'>
    1045. 

    1046. 

  1046. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1047. 

  1047. border:none;padding:0in'>    def Render(self):</p>
    1048. 

    1049. 

  1049. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1050. 

  1050. border:none;padding:0in'>        if self.Device is None or self.Paused:</p>
    1051. 

    1052. 

  1052. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1053. 

  1053. border:none;padding:0in'>            return</p>
    1054. 

    1055. 

  1055. </div>
    1056. 

  1056. 

  1057. <p class=Normal>&nbsp;</p>
    1058. 

  1058. 

  1059. <p class=Normal>At the beginning of each render, we clear the scene with a
    1060. 

  1060. specific background color (which we set in the constructor).</p>
    1061. 

  1061. 

  1062. <p class=Normal>&nbsp;</p>
    1063. 

  1063. 

  1064. <div style='border:solid windowtext 1.0pt;padding:1.0pt 4.0pt 1.0pt 4.0pt;
    1065. 

  1065. background:silver;margin-left:.25in;margin-right:.25in'>
    1066. 

    1067. 

  1067. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1068. 

  1068. border:none;padding:0in'>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; self.Device.Clear(Direct3D.ClearFlags.Target | Direct3D.ClearFlags.ZBuffer,</p>
    1069. 

    1070. 

  1070. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1071. 

  1071. border:none;padding:0in'>           &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; self.Background, </p>
    1072. 

  1072. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1073. 

  1073. border:none;padding:0in'>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 1, </p>
    1074. 

  1074. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1075. 

  1075. border:none;padding:0in'>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 0)</p>
    1076. 

    1077. 

  1077. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1078. 

  1078. border:none;padding:0in'>        self.Device.BeginScene()</p>
    1079. 

    1080. 

  1080. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1081. 

  1081. border:none;padding:0in'>&nbsp;</p>
    1082. 

    1083. 

  1083. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1084. 

  1084. border:none;padding:0in'>        # scene render here</p>
    1085. 

    1086. 

  1086. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1087. 

  1087. border:none;padding:0in'>&nbsp;</p>
    1088. 

    1089. 

  1089. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1090. 

  1090. border:none;padding:0in'>        self.Device.EndScene()</p>
    1091. 

    1092. 

  1092. <p class=Code-Highlighted style='margin:0in;margin-bottom:.0001pt;background:silver;
    1093. 

  1093. border:none;padding:0in'>        self.Device.Present()</p>
    1094. 

    1095. 

  1095. </div>
    1096. 

  1096. 

  1097. <p class=Normal>&nbsp;</p>
    1098. 

  1098. 

  1099. <p class=Normal>Run the application.  We have now created a DirectX render
    1100. 

  1100. loop in under 100 lines of IronPython code.  Now we need to make something
    1101. 

  1101. useful out of it…</p>
    1102. 

  1102. 

  1103. <p class=Normal>&nbsp;</p>
    1104. 

  1104. 

  1105. <h2><a name="_Toc140655640">Code Checkpoint 2</a></h2>
    1106. 

  1106. 

  1107. <p class=Normal>Run your Python application.  At this point you should have
    1108. 

  1108. the same window as the previous checkpoint, but with a black DirectX context. 
    1109. 

  1109. If you are having problems with the code, you should compare your source file
    1110. 

  1110. with checkpoint2.py.</p>
    1111. 

  1111. 

  1112. <p class=Normal>&nbsp;</p>
    1113. 

  1113. 

  1114. <h2><a name="_Toc140655641">An Introduction to Duck Typing</a></h2>
    1115. 

  1115. 

  1116. <p class=Normal>&nbsp;</p>
    1117. 

  1117. 

  1118. <p class=Normal>Now that we have an application running, what we need to do is
    1119. 

  1119. load a mesh and render it in the scene.  To do this, DirectX needs four pieces
    1120. 

  1120. of information: the Mesh, the World Matrix (to position the object), a list of
    1121. 

  1121. materials, and a list of textures.  We will provide one extra constraint that
    1122. 

  1122. we will use: every object we render in the scene will need a Name so that we
    1123. 

  1123. can place it into a …
    1124.

Large files files are truncated, but you can click here to view the full file