index.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="shortcut icon" href="../assets/images/favicon.png">
  7. <meta name="generator" content="mkdocs-1.1, mkdocs-material-5.4.0">
  8. <title>Learning by Example - Jypyter Sketcher</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.fe0cca5b.min.css">
  10. <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
  11. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
  12. <style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
  13. </head>
  14. <body dir="ltr">
  15. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  16. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  17. <label class="md-overlay" for="__drawer"></label>
  18. <div data-md-component="skip">
  19. <a href="#a-language-to-describe-a-sketch" class="md-skip">
  20. Skip to content
  21. </a>
  22. </div>
  23. <div data-md-component="announce">
  24. </div>
  25. <header class="md-header" data-md-component="header">
  26. <nav class="md-header-nav md-grid" aria-label="Header">
  27. <a href=".." title="Jypyter Sketcher" class="md-header-nav__button md-logo" aria-label="Jypyter Sketcher">
  28. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  29. </a>
  30. <label class="md-header-nav__button md-icon" for="__drawer">
  31. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
  32. </label>
  33. <div class="md-header-nav__title" data-md-component="header-title">
  34. <div class="md-header-nav__ellipsis">
  35. <span class="md-header-nav__topic md-ellipsis">
  36. Jypyter Sketcher
  37. </span>
  38. <span class="md-header-nav__topic md-ellipsis">
  39. Learning by Example
  40. </span>
  41. </div>
  42. </div>
  43. <label class="md-header-nav__button md-icon" for="__search">
  44. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  45. </label>
  46. <div class="md-search" data-md-component="search" role="dialog">
  47. <label class="md-search__overlay" for="__search"></label>
  48. <div class="md-search__inner" role="search">
  49. <form class="md-search__form" name="search">
  50. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active">
  51. <label class="md-search__icon md-icon" for="__search">
  52. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
  53. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  54. </label>
  55. <button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
  56. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
  57. </button>
  58. </form>
  59. <div class="md-search__output">
  60. <div class="md-search__scrollwrap" data-md-scrollfix>
  61. <div class="md-search-result" data-md-component="search-result">
  62. <div class="md-search-result__meta">
  63. Initializing search
  64. </div>
  65. <ol class="md-search-result__list"></ol>
  66. </div>
  67. </div>
  68. </div>
  69. </div>
  70. </div>
  71. </nav>
  72. </header>
  73. <div class="md-container" data-md-component="container">
  74. <main class="md-main" data-md-component="main">
  75. <div class="md-main__inner md-grid">
  76. <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
  77. <div class="md-sidebar__scrollwrap">
  78. <div class="md-sidebar__inner">
  79. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  80. <label class="md-nav__title" for="__drawer">
  81. <a href=".." title="Jypyter Sketcher" class="md-nav__button md-logo" aria-label="Jypyter Sketcher">
  82. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
  83. </a>
  84. Jypyter Sketcher
  85. </label>
  86. <ul class="md-nav__list" data-md-scrollfix>
  87. <li class="md-nav__item">
  88. <a href=".." title="Home" class="md-nav__link">
  89. Home
  90. </a>
  91. </li>
  92. <li class="md-nav__item">
  93. <a href="../about/" title="About" class="md-nav__link">
  94. About
  95. </a>
  96. </li>
  97. <li class="md-nav__item">
  98. <a href="../presentation/" title="Presentation" class="md-nav__link">
  99. Presentation
  100. </a>
  101. </li>
  102. <li class="md-nav__item md-nav__item--active">
  103. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  104. <label class="md-nav__link md-nav__link--active" for="__toc">
  105. Learning by Example
  106. <span class="md-nav__icon md-icon">
  107. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 9h14V7H3v2m0 4h14v-2H3v2m0 4h14v-2H3v2m16 0h2v-2h-2v2m0-10v2h2V7h-2m0 6h2v-2h-2v2z"/></svg>
  108. </span>
  109. </label>
  110. <a href="./" title="Learning by Example" class="md-nav__link md-nav__link--active">
  111. Learning by Example
  112. </a>
  113. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  114. <label class="md-nav__title" for="__toc">
  115. <span class="md-nav__icon md-icon">
  116. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  117. </span>
  118. Table of contents
  119. </label>
  120. <ul class="md-nav__list" data-md-scrollfix>
  121. <li class="md-nav__item">
  122. <a href="#a-language-to-describe-a-sketch" class="md-nav__link">
  123. A language to describe a sketch
  124. </a>
  125. </li>
  126. <li class="md-nav__item">
  127. <a href="#example" class="md-nav__link">
  128. Example
  129. </a>
  130. <nav class="md-nav" aria-label="Example">
  131. <ul class="md-nav__list">
  132. <li class="md-nav__item">
  133. <a href="#the-final-sketch" class="md-nav__link">
  134. The final sketch
  135. </a>
  136. </li>
  137. <li class="md-nav__item">
  138. <a href="#support-files" class="md-nav__link">
  139. Support files
  140. </a>
  141. </li>
  142. <li class="md-nav__item">
  143. <a href="#the-yaml-definition" class="md-nav__link">
  144. The yaml definition
  145. </a>
  146. <nav class="md-nav" aria-label="The yaml definition">
  147. <ul class="md-nav__list">
  148. <li class="md-nav__item">
  149. <a href="#libraries" class="md-nav__link">
  150. Libraries
  151. </a>
  152. </li>
  153. <li class="md-nav__item">
  154. <a href="#constants-construction-parameters" class="md-nav__link">
  155. Constants: Construction parameters
  156. </a>
  157. </li>
  158. <li class="md-nav__item">
  159. <a href="#frame-core-geometric-parameters" class="md-nav__link">
  160. Frame: core geometric parameters
  161. </a>
  162. </li>
  163. <li class="md-nav__item">
  164. <a href="#the-body-object" class="md-nav__link">
  165. The body object
  166. </a>
  167. </li>
  168. <li class="md-nav__item">
  169. <a href="#the-plan-object" class="md-nav__link">
  170. The plan object
  171. </a>
  172. </li>
  173. <li class="md-nav__item">
  174. <a href="#the-friction-sketch" class="md-nav__link">
  175. The friction sketch
  176. </a>
  177. </li>
  178. </ul>
  179. </nav>
  180. </li>
  181. <li class="md-nav__item">
  182. <a href="#using-the-parser" class="md-nav__link">
  183. Using the parser
  184. </a>
  185. </li>
  186. <li class="md-nav__item">
  187. <a href="#friction-sketch-hierarchy" class="md-nav__link">
  188. "friction" sketch hierarchy
  189. </a>
  190. </li>
  191. </ul>
  192. </nav>
  193. </li>
  194. </ul>
  195. </nav>
  196. </li>
  197. <li class="md-nav__item">
  198. <a href="../shapereference/" title="Shapes Reference" class="md-nav__link">
  199. Shapes Reference
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../yamlsketcher/" title="YAML files Reference" class="md-nav__link">
  204. YAML files Reference
  205. </a>
  206. </li>
  207. <li class="md-nav__item">
  208. <a href="../gallerydoc/" title="Gallery" class="md-nav__link">
  209. Gallery
  210. </a>
  211. </li>
  212. </ul>
  213. </nav>
  214. </div>
  215. </div>
  216. </div>
  217. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  218. <div class="md-sidebar__scrollwrap">
  219. <div class="md-sidebar__inner">
  220. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  221. <label class="md-nav__title" for="__toc">
  222. <span class="md-nav__icon md-icon">
  223. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  224. </span>
  225. Table of contents
  226. </label>
  227. <ul class="md-nav__list" data-md-scrollfix>
  228. <li class="md-nav__item">
  229. <a href="#a-language-to-describe-a-sketch" class="md-nav__link">
  230. A language to describe a sketch
  231. </a>
  232. </li>
  233. <li class="md-nav__item">
  234. <a href="#example" class="md-nav__link">
  235. Example
  236. </a>
  237. <nav class="md-nav" aria-label="Example">
  238. <ul class="md-nav__list">
  239. <li class="md-nav__item">
  240. <a href="#the-final-sketch" class="md-nav__link">
  241. The final sketch
  242. </a>
  243. </li>
  244. <li class="md-nav__item">
  245. <a href="#support-files" class="md-nav__link">
  246. Support files
  247. </a>
  248. </li>
  249. <li class="md-nav__item">
  250. <a href="#the-yaml-definition" class="md-nav__link">
  251. The yaml definition
  252. </a>
  253. <nav class="md-nav" aria-label="The yaml definition">
  254. <ul class="md-nav__list">
  255. <li class="md-nav__item">
  256. <a href="#libraries" class="md-nav__link">
  257. Libraries
  258. </a>
  259. </li>
  260. <li class="md-nav__item">
  261. <a href="#constants-construction-parameters" class="md-nav__link">
  262. Constants: Construction parameters
  263. </a>
  264. </li>
  265. <li class="md-nav__item">
  266. <a href="#frame-core-geometric-parameters" class="md-nav__link">
  267. Frame: core geometric parameters
  268. </a>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="#the-body-object" class="md-nav__link">
  272. The body object
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="#the-plan-object" class="md-nav__link">
  277. The plan object
  278. </a>
  279. </li>
  280. <li class="md-nav__item">
  281. <a href="#the-friction-sketch" class="md-nav__link">
  282. The friction sketch
  283. </a>
  284. </li>
  285. </ul>
  286. </nav>
  287. </li>
  288. <li class="md-nav__item">
  289. <a href="#using-the-parser" class="md-nav__link">
  290. Using the parser
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="#friction-sketch-hierarchy" class="md-nav__link">
  295. "friction" sketch hierarchy
  296. </a>
  297. </li>
  298. </ul>
  299. </nav>
  300. </li>
  301. </ul>
  302. </nav>
  303. </div>
  304. </div>
  305. </div>
  306. <div class="md-content">
  307. <article class="md-content__inner md-typeset">
  308. <h1>Learning by Example</h1>
  309. <h2 id="a-language-to-describe-a-sketch">A language to describe a sketch</h2>
  310. <p>Pysketcher initial version <a href="">HPL Pysketcher</a> enable sketch definition in python. HPL is showing the hierachical nature of sketches. This is implemented via the Composition function. One can further grasp this using the graphviz_dot function applied to discover the composition herarchy implemented as a graphviz image <a href="#friction-sketch-hierarchy">see The hierarchy of the "friction" sketch</a> at the end of this page.</p>
  311. <p>Due to the hierarchical nature of sketches, it is quite straightforward to think about using yaml as the syntax for defining a sketch.</p>
  312. <p>Benefits are the following:</p>
  313. <ul>
  314. <li>Leaner sketch writing as only data relevant to the context needs to be defined</li>
  315. <li>A more straightforward reading for the same reason</li>
  316. <li>A more robust sketch definition <ul>
  317. <li>The same set of rules is applied to generate a sketch</li>
  318. <li>No further python idiom is be intermingled as opposed to the case of python defined sketches</li>
  319. <li>Don't make me wrong! Data defined versus program defined there is no winner, it's just a matter of context</li>
  320. </ul>
  321. </li>
  322. </ul>
  323. <h2 id="example">Example</h2>
  324. <p>This example provides the yaml content to define the Dry Friction case</p>
  325. <h3 id="the-final-sketch">The final sketch</h3>
  326. <p><img alt="dryfriction sketch" src="../images/dryfriction.svg" /></p>
  327. <p>An inclined plan (the A-B edge) supports a blue rectangle which is dragged down by gravity. The plan makes an angle <span><span class="MathJax_Preview">\theta</span><script type="math/tex">\theta</script></span> with the ground level. Sketch implementation notebook includes a controller enabling the <span><span class="MathJax_Preview">\theta</span><script type="math/tex">\theta</script></span> angle to change. The whole plan, including the body, can rotate arround point B.</p>
  328. <h3 id="support-files">Support files</h3>
  329. <p>The example we are developing now is based upon the "Dry Friction mockup" notebook</p>
  330. <ul>
  331. <li>the rendered html version of the notbook can be viewed <a href="../resources/DryFriction.html">here</a></li>
  332. <li>the notebook can be download <a href="../resources/DryFriction.ipynb">here</a></li>
  333. </ul>
  334. <h3 id="the-yaml-definition">The yaml definition</h3>
  335. <p>Sketcher language is defined as a yaml compliant file or string. The yaml file is a dictionnary of "objects". Objects can be regular python objects or sketcher objects.
  336. A skertcher object is composed as follow:</p>
  337. <ul>
  338. <li><strong>a formula</strong>: it's a leaf object, like Rectangle, Circle, Line etc or a composition</li>
  339. <li><strong>a style list</strong>: line or fill colors, line stroke... declared as a yaml hierarchy</li>
  340. <li><strong>a transformation list</strong>: the defined object can be transformed using sketcher transformation: translation, rotation...</li>
  341. </ul>
  342. <p>As a general rule, a new object suppose all parameters to be defined before they are used to construct it.</p>
  343. <p><strong>For example, you can create a circle if the center and the radius have been defined earlier in the file.</strong></p>
  344. <p>The general layout of a sketcher file is as follow:</p>
  345. <ul>
  346. <li><strong>Libraries, Construction Variables, Frame</strong><ul>
  347. <li>declaration of the libraries used by the objects further declared: at least pysketcher is mandatory</li>
  348. <li>various global variable which encompass the "Construction" variables which define the object main physical dimensions, positions...</li>
  349. <li>some "actions" corresponding to executable python sentences<ul>
  350. <li>One mandatory action is the setting of the drawing frame (drawing_tool.set_coordinate_system): it must be declared before any other pysketcher object is used.</li>
  351. <li>Other use case of action is the setting of global parameters like default line color: (drawing_tool.set_linecolor('black')) for example</li>
  352. </ul>
  353. </li>
  354. <li>this is stored in the head string thereafter</li>
  355. <li>The example uses the following objects<ul>
  356. <li>libraries: setting the libraries used for this sketch</li>
  357. <li>constants: all the sketch dimensionning data</li>
  358. <li>frame: all the shapes or geometric objects which will be used by the other shapes</li>
  359. </ul>
  360. </li>
  361. </ul>
  362. </li>
  363. <li><strong>Sketcher Objects</strong><ul>
  364. <li>Usually starting with the declaration of Pysketcher leaf objects (Geometry object like Line, Circle, Rectangle...)</li>
  365. <li>May be aggregated using the composition object</li>
  366. <li>Composition can be made of composition object (recursive behaviour)</li>
  367. <li>Grouping leafs and composition will be further used to apply transformation latter on (based on the "physics")</li>
  368. <li>The example uese three group of shapes<ul>
  369. <li>The body object</li>
  370. <li>The plan object</li>
  371. <li>The friction main object</li>
  372. </ul>
  373. </li>
  374. <li>The plan includes the body</li>
  375. <li>The friction includes the plan (that will be able to rotate as a group) and the ground (will stay fixed)</li>
  376. </ul>
  377. </li>
  378. </ul>
  379. <h4 id="libraries">Libraries</h4>
  380. <pre><code class="python">libraries = &quot;&quot;&quot;\
  381. name: head
  382. shapes:
  383. libraries: [&quot;from math import tan, radians, sin, cos&quot;,&quot;from pysketcher import *&quot;]
  384. &quot;&quot;&quot;
  385. </code></pre>
  386. <h4 id="constants-construction-parameters">Constants: Construction parameters</h4>
  387. <pre><code class="python">constants = &quot;&quot;&quot;\
  388. name: constants
  389. shapes:
  390. fontsize: 18 # size of the characters
  391. g: 9.81 # constant gravity
  392. theta: 30.0 # inclined plane angle
  393. L: 10.0 # sketch sizing parameter
  394. a: 1.0 #
  395. xmin: 0.0 # sketech min Abscissa
  396. ymin: -3.0 # sketech min Ordinate
  397. rl: 2.0 # rectangle width
  398. rL: 1.0 # rectangle length
  399. &quot;&quot;&quot;
  400. </code></pre>
  401. <h4 id="frame-core-geometric-parameters">Frame: core geometric parameters</h4>
  402. <pre><code class="python">frame = &quot;&quot;&quot;\
  403. name: frame
  404. shapes:
  405. setframe: # sketch setup
  406. action: &quot;drawing_tool.set_coordinate_system(xmin=xmin-L/5, xmax=xmin+1.5*L,ymin=ymin, ymax=ymin+1.5*L,instruction_file='tmp_mpl_friction.py')&quot;
  407. setblackline: # default frame values and actions
  408. action: &quot;drawing_tool.set_linecolor('black')&quot;
  409. B: point(a+L,0) # wall right end
  410. A: point(a,tan(radians(theta))*L) # wall left end
  411. normal_vec: point(sin(radians(theta)),cos(radians(theta))) # Vector normal to wall
  412. tangent_vec: point(cos(radians(theta)),-sin(radians(theta))) # Vector tangent to wall
  413. help_line: Line(A,B) # wall line
  414. x: a + 3*L/10. # contact point Abscissa
  415. y: help_line(x=x) # contact point Ordinate
  416. contact: point(x, y) # contact point: middle of the rectangle bottom edge
  417. c: contact + rL/2*normal_vec
  418. &quot;&quot;&quot;
  419. </code></pre>
  420. <h4 id="the-body-object">The body object</h4>
  421. <pre><code class="python">body = &quot;&quot;&quot;\
  422. name: body
  423. shapes:
  424. rectangle:
  425. formula: Rectangle(contact, rl, rL)
  426. style:
  427. linecolor: blue
  428. filled_curves: blue
  429. transform: [&quot;rotate(-theta, contact)&quot;,
  430. &quot;translate(-rl/2*tangent_vec)&quot;]
  431. N:
  432. formula: Force(contact - rl*normal_vec, contact, r'$N$', text_pos='start')
  433. style:
  434. linecolor: black
  435. wheel:
  436. formula: &quot;Composition({'outer': rectangle})&quot;
  437. style:
  438. shadow: 1
  439. mc:
  440. formula: Text(r'$c$', c)
  441. body:
  442. formula: &quot;Composition({'wheel': wheel, 'N': N, 'mc': mc})&quot;
  443. style:
  444. linecolor: black
  445. &quot;&quot;&quot;
  446. </code></pre>
  447. <h4 id="the-plan-object">The plan object</h4>
  448. <pre><code class="python">plan = &quot;&quot;&quot;\
  449. name: plan
  450. shapes:
  451. mB:
  452. formula: Text(r'$B$',B)
  453. mA:
  454. formula: Text(r'$A$', A)
  455. wall:
  456. formula: Wall(x=[A[0], B[0]], y=[A[1], B[1]], thickness=-0.25,transparent=False)
  457. style:
  458. linecolor: black
  459. x_const:
  460. formula: Line(contact, contact + point(0,4))
  461. style:
  462. linestyle: dotted
  463. transform: rotate(-theta, contact)
  464. x_axis:
  465. formula: &quot;Axis(start=contact+ 2*rl*normal_vec, length=2*rl,label='$x$', rotation_angle=-theta)&quot;
  466. plan:
  467. formula: &quot;Composition({'body': body, 'inclined wall': wall, 'x start': x_const, 'x axis': x_axis, 'mA': mA, 'mB': mB})&quot;
  468. &quot;&quot;&quot;
  469. </code></pre>
  470. <h4 id="the-friction-sketch">The friction sketch</h4>
  471. <pre><code class="python">friction = &quot;&quot;&quot;\
  472. name: friction
  473. shapes:
  474. mg:
  475. formula: Gravity(c, rl, text='$Mg$')
  476. style:
  477. linecolor: black
  478. angle:
  479. formula: &quot;Arc_wText(r'$&lt;bslash&gt;theta$', center=B, radius=3, start_angle=180-theta, arc_angle=theta, fontsize=fontsize)&quot;
  480. style:
  481. linecolor: black
  482. linewidth: 1
  483. ground:
  484. formula: Line((B[0]-L/10., 0), (B[0]-L/2.,0))
  485. stlye:
  486. linecolor: black
  487. linestyle: dashed
  488. linewidth: 1
  489. friction:
  490. formula: &quot;Composition({'plan': plan, 'ground': ground, 'mg': mg, 'angle': angle})&quot;
  491. &quot;&quot;&quot;
  492. </code></pre>
  493. <h3 id="using-the-parser">Using the parser</h3>
  494. <p>To parse the above example, the following code do the job.</p>
  495. <ol>
  496. <li>libraries, constants and frame must be used first as all the other bits needs one or more variable they defines.</li>
  497. <li>After, any other sketch can be parsed, the order just need to respect precedence (if one object uses another it must be parsed after)</li>
  498. <li>this setting allows naturally a modular definition of sketch objects</li>
  499. </ol>
  500. <p>The parser checks for syntax precedence and warns of any detected error.</p>
  501. <pre><code class="python">myfig = {}
  502. if sketchParse(libraries,myfig):
  503. if sketchParse(constants,myfig):
  504. if sketchParse(frame,myfig):
  505. if sketchParse(body,myfig):
  506. if sketchParse(plan,myfig):
  507. if sketchParse(friction,myfig):
  508. print(&quot;success&quot;)
  509. </code></pre>
  510. <h3 id="friction-sketch-hierarchy">"friction" sketch hierarchy</h3>
  511. <p><img alt="" src="../images/dotdryfriction.svg" /></p>
  512. </article>
  513. </div>
  514. </div>
  515. </main>
  516. <footer class="md-footer">
  517. <div class="md-footer-nav">
  518. <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
  519. <a href="../presentation/" title="Presentation" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  520. <div class="md-footer-nav__button md-icon">
  521. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
  522. </div>
  523. <div class="md-footer-nav__title">
  524. <div class="md-ellipsis">
  525. <span class="md-footer-nav__direction">
  526. Previous
  527. </span>
  528. Presentation
  529. </div>
  530. </div>
  531. </a>
  532. <a href="../shapereference/" title="Shapes Reference" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
  533. <div class="md-footer-nav__title">
  534. <div class="md-ellipsis">
  535. <span class="md-footer-nav__direction">
  536. Next
  537. </span>
  538. Shapes Reference
  539. </div>
  540. </div>
  541. <div class="md-footer-nav__button md-icon">
  542. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
  543. </div>
  544. </a>
  545. </nav>
  546. </div>
  547. <div class="md-footer-meta md-typeset">
  548. <div class="md-footer-meta__inner md-grid">
  549. <div class="md-footer-copyright">
  550. Made with
  551. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  552. Material for MkDocs
  553. </a>
  554. </div>
  555. </div>
  556. </div>
  557. </footer>
  558. </div>
  559. <script src="../assets/javascripts/vendor.d710d30a.min.js"></script>
  560. <script src="../assets/javascripts/bundle.b39636ac.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents"}</script>
  561. <script>
  562. app = initialize({
  563. base: "..",
  564. features: [],
  565. search: Object.assign({
  566. worker: "../assets/javascripts/worker/search.a68abb33.min.js"
  567. }, typeof search !== "undefined" && search)
  568. })
  569. </script>
  570. <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-MML-AM_CHTML"></script>
  571. </body>
  572. </html>