index.html 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068
  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.2, mkdocs-material-5.5.3">
  8. <title>Shapes Reference - Jypyter Sketcher</title>
  9. <link rel="stylesheet" href="../assets/stylesheets/main.947af8d5.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="#list-of-shapes" 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. Shapes Reference
  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">
  103. <a href="../learningbyexample/" title="Learning by Example" class="md-nav__link">
  104. Learning by Example
  105. </a>
  106. </li>
  107. <li class="md-nav__item md-nav__item--active">
  108. <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
  109. <label class="md-nav__link md-nav__link--active" for="__toc">
  110. Shapes Reference
  111. <span class="md-nav__icon md-icon">
  112. <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>
  113. </span>
  114. </label>
  115. <a href="./" title="Shapes Reference" class="md-nav__link md-nav__link--active">
  116. Shapes Reference
  117. </a>
  118. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  119. <label class="md-nav__title" for="__toc">
  120. <span class="md-nav__icon md-icon">
  121. <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>
  122. </span>
  123. Table of contents
  124. </label>
  125. <ul class="md-nav__list" data-md-scrollfix>
  126. <li class="md-nav__item">
  127. <a href="#list-of-shapes" class="md-nav__link">
  128. List of Shapes
  129. </a>
  130. </li>
  131. <li class="md-nav__item">
  132. <a href="#line" class="md-nav__link">
  133. Line
  134. </a>
  135. <nav class="md-nav" aria-label="Line">
  136. <ul class="md-nav__list">
  137. <li class="md-nav__item">
  138. <a href="#yaml" class="md-nav__link">
  139. Yaml
  140. </a>
  141. </li>
  142. <li class="md-nav__item">
  143. <a href="#python" class="md-nav__link">
  144. Python
  145. </a>
  146. </li>
  147. </ul>
  148. </nav>
  149. </li>
  150. <li class="md-nav__item">
  151. <a href="#rectangle" class="md-nav__link">
  152. Rectangle
  153. </a>
  154. <nav class="md-nav" aria-label="Rectangle">
  155. <ul class="md-nav__list">
  156. <li class="md-nav__item">
  157. <a href="#yaml_1" class="md-nav__link">
  158. Yaml
  159. </a>
  160. </li>
  161. <li class="md-nav__item">
  162. <a href="#python_1" class="md-nav__link">
  163. Python
  164. </a>
  165. </li>
  166. </ul>
  167. </nav>
  168. </li>
  169. <li class="md-nav__item">
  170. <a href="#circle" class="md-nav__link">
  171. Circle
  172. </a>
  173. <nav class="md-nav" aria-label="Circle">
  174. <ul class="md-nav__list">
  175. <li class="md-nav__item">
  176. <a href="#yaml_2" class="md-nav__link">
  177. Yaml
  178. </a>
  179. </li>
  180. <li class="md-nav__item">
  181. <a href="#python_2" class="md-nav__link">
  182. Python
  183. </a>
  184. </li>
  185. </ul>
  186. </nav>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="#triangle" class="md-nav__link">
  190. Triangle
  191. </a>
  192. <nav class="md-nav" aria-label="Triangle">
  193. <ul class="md-nav__list">
  194. <li class="md-nav__item">
  195. <a href="#yaml_3" class="md-nav__link">
  196. Yaml
  197. </a>
  198. </li>
  199. <li class="md-nav__item">
  200. <a href="#python_3" class="md-nav__link">
  201. Python
  202. </a>
  203. </li>
  204. </ul>
  205. </nav>
  206. </li>
  207. <li class="md-nav__item">
  208. <a href="#distance-with-text" class="md-nav__link">
  209. Distance with text
  210. </a>
  211. <nav class="md-nav" aria-label="Distance with text">
  212. <ul class="md-nav__list">
  213. <li class="md-nav__item">
  214. <a href="#yaml_4" class="md-nav__link">
  215. Yaml
  216. </a>
  217. </li>
  218. <li class="md-nav__item">
  219. <a href="#python_4" class="md-nav__link">
  220. Python
  221. </a>
  222. </li>
  223. </ul>
  224. </nav>
  225. </li>
  226. <li class="md-nav__item">
  227. <a href="#text" class="md-nav__link">
  228. Text
  229. </a>
  230. <nav class="md-nav" aria-label="Text">
  231. <ul class="md-nav__list">
  232. <li class="md-nav__item">
  233. <a href="#yaml_5" class="md-nav__link">
  234. Yaml
  235. </a>
  236. </li>
  237. <li class="md-nav__item">
  238. <a href="#python_5" class="md-nav__link">
  239. Python
  240. </a>
  241. </li>
  242. </ul>
  243. </nav>
  244. </li>
  245. <li class="md-nav__item">
  246. <a href="#cross" class="md-nav__link">
  247. Cross
  248. </a>
  249. <nav class="md-nav" aria-label="Cross">
  250. <ul class="md-nav__list">
  251. <li class="md-nav__item">
  252. <a href="#yaml_6" class="md-nav__link">
  253. Yaml
  254. </a>
  255. </li>
  256. <li class="md-nav__item">
  257. <a href="#python_6" class="md-nav__link">
  258. Python
  259. </a>
  260. </li>
  261. </ul>
  262. </nav>
  263. </li>
  264. <li class="md-nav__item">
  265. <a href="#axis" class="md-nav__link">
  266. Axis
  267. </a>
  268. <nav class="md-nav" aria-label="Axis">
  269. <ul class="md-nav__list">
  270. <li class="md-nav__item">
  271. <a href="#yaml_7" class="md-nav__link">
  272. Yaml
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="#python_7" class="md-nav__link">
  277. Python
  278. </a>
  279. </li>
  280. </ul>
  281. </nav>
  282. </li>
  283. <li class="md-nav__item">
  284. <a href="#arc" class="md-nav__link">
  285. Arc
  286. </a>
  287. <nav class="md-nav" aria-label="Arc">
  288. <ul class="md-nav__list">
  289. <li class="md-nav__item">
  290. <a href="#yaml_8" class="md-nav__link">
  291. Yaml
  292. </a>
  293. </li>
  294. <li class="md-nav__item">
  295. <a href="#python_8" class="md-nav__link">
  296. Python
  297. </a>
  298. </li>
  299. </ul>
  300. </nav>
  301. </li>
  302. <li class="md-nav__item">
  303. <a href="#arc_wtext" class="md-nav__link">
  304. Arc_wText
  305. </a>
  306. <nav class="md-nav" aria-label="Arc_wText">
  307. <ul class="md-nav__list">
  308. <li class="md-nav__item">
  309. <a href="#yaml_9" class="md-nav__link">
  310. Yaml
  311. </a>
  312. </li>
  313. <li class="md-nav__item">
  314. <a href="#python_9" class="md-nav__link">
  315. Python
  316. </a>
  317. </li>
  318. </ul>
  319. </nav>
  320. </li>
  321. <li class="md-nav__item">
  322. <a href="#arrow1" class="md-nav__link">
  323. Arrow1
  324. </a>
  325. <nav class="md-nav" aria-label="Arrow1">
  326. <ul class="md-nav__list">
  327. <li class="md-nav__item">
  328. <a href="#yaml_10" class="md-nav__link">
  329. Yaml
  330. </a>
  331. </li>
  332. <li class="md-nav__item">
  333. <a href="#python_10" class="md-nav__link">
  334. Python
  335. </a>
  336. </li>
  337. </ul>
  338. </nav>
  339. </li>
  340. <li class="md-nav__item">
  341. <a href="#force" class="md-nav__link">
  342. Force
  343. </a>
  344. <nav class="md-nav" aria-label="Force">
  345. <ul class="md-nav__list">
  346. <li class="md-nav__item">
  347. <a href="#yaml_11" class="md-nav__link">
  348. Yaml
  349. </a>
  350. </li>
  351. <li class="md-nav__item">
  352. <a href="#python_11" class="md-nav__link">
  353. Python
  354. </a>
  355. </li>
  356. </ul>
  357. </nav>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="#wall" class="md-nav__link">
  361. Wall
  362. </a>
  363. <nav class="md-nav" aria-label="Wall">
  364. <ul class="md-nav__list">
  365. <li class="md-nav__item">
  366. <a href="#yaml_12" class="md-nav__link">
  367. Yaml
  368. </a>
  369. </li>
  370. <li class="md-nav__item">
  371. <a href="#python_12" class="md-nav__link">
  372. Python
  373. </a>
  374. </li>
  375. </ul>
  376. </nav>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="#curve" class="md-nav__link">
  380. Curve
  381. </a>
  382. <nav class="md-nav" aria-label="Curve">
  383. <ul class="md-nav__list">
  384. <li class="md-nav__item">
  385. <a href="#yaml_13" class="md-nav__link">
  386. Yaml
  387. </a>
  388. </li>
  389. <li class="md-nav__item">
  390. <a href="#python_13" class="md-nav__link">
  391. Python
  392. </a>
  393. </li>
  394. </ul>
  395. </nav>
  396. </li>
  397. <li class="md-nav__item">
  398. <a href="#trajectory" class="md-nav__link">
  399. Trajectory
  400. </a>
  401. <nav class="md-nav" aria-label="Trajectory">
  402. <ul class="md-nav__list">
  403. <li class="md-nav__item">
  404. <a href="#yaml_14" class="md-nav__link">
  405. Yaml
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="#python_14" class="md-nav__link">
  410. Python
  411. </a>
  412. </li>
  413. </ul>
  414. </nav>
  415. </li>
  416. <li class="md-nav__item">
  417. <a href="#gravity" class="md-nav__link">
  418. Gravity
  419. </a>
  420. <nav class="md-nav" aria-label="Gravity">
  421. <ul class="md-nav__list">
  422. <li class="md-nav__item">
  423. <a href="#yaml_15" class="md-nav__link">
  424. Yaml
  425. </a>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="#python_15" class="md-nav__link">
  429. Python
  430. </a>
  431. </li>
  432. </ul>
  433. </nav>
  434. </li>
  435. <li class="md-nav__item">
  436. <a href="#moment" class="md-nav__link">
  437. Moment
  438. </a>
  439. <nav class="md-nav" aria-label="Moment">
  440. <ul class="md-nav__list">
  441. <li class="md-nav__item">
  442. <a href="#yaml_16" class="md-nav__link">
  443. Yaml
  444. </a>
  445. </li>
  446. <li class="md-nav__item">
  447. <a href="#python_16" class="md-nav__link">
  448. Python
  449. </a>
  450. </li>
  451. </ul>
  452. </nav>
  453. </li>
  454. <li class="md-nav__item">
  455. <a href="#text_warrow" class="md-nav__link">
  456. Text_wArrow
  457. </a>
  458. <nav class="md-nav" aria-label="Text_wArrow">
  459. <ul class="md-nav__list">
  460. <li class="md-nav__item">
  461. <a href="#yaml_17" class="md-nav__link">
  462. Yaml
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="#python_17" class="md-nav__link">
  467. Python
  468. </a>
  469. </li>
  470. </ul>
  471. </nav>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="#wheel" class="md-nav__link">
  475. Wheel
  476. </a>
  477. <nav class="md-nav" aria-label="Wheel">
  478. <ul class="md-nav__list">
  479. <li class="md-nav__item">
  480. <a href="#yaml_18" class="md-nav__link">
  481. Yaml
  482. </a>
  483. </li>
  484. <li class="md-nav__item">
  485. <a href="#python_18" class="md-nav__link">
  486. Python
  487. </a>
  488. </li>
  489. </ul>
  490. </nav>
  491. </li>
  492. <li class="md-nav__item">
  493. <a href="#spring" class="md-nav__link">
  494. Spring
  495. </a>
  496. <nav class="md-nav" aria-label="Spring">
  497. <ul class="md-nav__list">
  498. <li class="md-nav__item">
  499. <a href="#yaml_19" class="md-nav__link">
  500. Yaml
  501. </a>
  502. </li>
  503. <li class="md-nav__item">
  504. <a href="#python_19" class="md-nav__link">
  505. Python
  506. </a>
  507. </li>
  508. </ul>
  509. </nav>
  510. </li>
  511. <li class="md-nav__item">
  512. <a href="#dashpot" class="md-nav__link">
  513. Dashpot
  514. </a>
  515. <nav class="md-nav" aria-label="Dashpot">
  516. <ul class="md-nav__list">
  517. <li class="md-nav__item">
  518. <a href="#yaml_20" class="md-nav__link">
  519. Yaml
  520. </a>
  521. </li>
  522. <li class="md-nav__item">
  523. <a href="#python_20" class="md-nav__link">
  524. Python
  525. </a>
  526. </li>
  527. </ul>
  528. </nav>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="#code-to-display-the-above-defined-shapes" class="md-nav__link">
  532. Code to display the above defined shapes
  533. </a>
  534. <nav class="md-nav" aria-label="Code to display the above defined shapes">
  535. <ul class="md-nav__list">
  536. <li class="md-nav__item">
  537. <a href="#yaml_21" class="md-nav__link">
  538. Yaml
  539. </a>
  540. </li>
  541. <li class="md-nav__item">
  542. <a href="#python_21" class="md-nav__link">
  543. Python
  544. </a>
  545. </li>
  546. </ul>
  547. </nav>
  548. </li>
  549. </ul>
  550. </nav>
  551. </li>
  552. <li class="md-nav__item">
  553. <a href="../yamlsketcher/" title="YAML files Reference" class="md-nav__link">
  554. YAML files Reference
  555. </a>
  556. </li>
  557. <li class="md-nav__item">
  558. <a href="../gallerydoc/" title="Gallery" class="md-nav__link">
  559. Gallery
  560. </a>
  561. </li>
  562. <li class="md-nav__item">
  563. <a href="../resources/Gallery/" title="Gallery Notebook" class="md-nav__link">
  564. Gallery Notebook
  565. </a>
  566. </li>
  567. </ul>
  568. </nav>
  569. </div>
  570. </div>
  571. </div>
  572. <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
  573. <div class="md-sidebar__scrollwrap">
  574. <div class="md-sidebar__inner">
  575. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  576. <label class="md-nav__title" for="__toc">
  577. <span class="md-nav__icon md-icon">
  578. <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>
  579. </span>
  580. Table of contents
  581. </label>
  582. <ul class="md-nav__list" data-md-scrollfix>
  583. <li class="md-nav__item">
  584. <a href="#list-of-shapes" class="md-nav__link">
  585. List of Shapes
  586. </a>
  587. </li>
  588. <li class="md-nav__item">
  589. <a href="#line" class="md-nav__link">
  590. Line
  591. </a>
  592. <nav class="md-nav" aria-label="Line">
  593. <ul class="md-nav__list">
  594. <li class="md-nav__item">
  595. <a href="#yaml" class="md-nav__link">
  596. Yaml
  597. </a>
  598. </li>
  599. <li class="md-nav__item">
  600. <a href="#python" class="md-nav__link">
  601. Python
  602. </a>
  603. </li>
  604. </ul>
  605. </nav>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="#rectangle" class="md-nav__link">
  609. Rectangle
  610. </a>
  611. <nav class="md-nav" aria-label="Rectangle">
  612. <ul class="md-nav__list">
  613. <li class="md-nav__item">
  614. <a href="#yaml_1" class="md-nav__link">
  615. Yaml
  616. </a>
  617. </li>
  618. <li class="md-nav__item">
  619. <a href="#python_1" class="md-nav__link">
  620. Python
  621. </a>
  622. </li>
  623. </ul>
  624. </nav>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="#circle" class="md-nav__link">
  628. Circle
  629. </a>
  630. <nav class="md-nav" aria-label="Circle">
  631. <ul class="md-nav__list">
  632. <li class="md-nav__item">
  633. <a href="#yaml_2" class="md-nav__link">
  634. Yaml
  635. </a>
  636. </li>
  637. <li class="md-nav__item">
  638. <a href="#python_2" class="md-nav__link">
  639. Python
  640. </a>
  641. </li>
  642. </ul>
  643. </nav>
  644. </li>
  645. <li class="md-nav__item">
  646. <a href="#triangle" class="md-nav__link">
  647. Triangle
  648. </a>
  649. <nav class="md-nav" aria-label="Triangle">
  650. <ul class="md-nav__list">
  651. <li class="md-nav__item">
  652. <a href="#yaml_3" class="md-nav__link">
  653. Yaml
  654. </a>
  655. </li>
  656. <li class="md-nav__item">
  657. <a href="#python_3" class="md-nav__link">
  658. Python
  659. </a>
  660. </li>
  661. </ul>
  662. </nav>
  663. </li>
  664. <li class="md-nav__item">
  665. <a href="#distance-with-text" class="md-nav__link">
  666. Distance with text
  667. </a>
  668. <nav class="md-nav" aria-label="Distance with text">
  669. <ul class="md-nav__list">
  670. <li class="md-nav__item">
  671. <a href="#yaml_4" class="md-nav__link">
  672. Yaml
  673. </a>
  674. </li>
  675. <li class="md-nav__item">
  676. <a href="#python_4" class="md-nav__link">
  677. Python
  678. </a>
  679. </li>
  680. </ul>
  681. </nav>
  682. </li>
  683. <li class="md-nav__item">
  684. <a href="#text" class="md-nav__link">
  685. Text
  686. </a>
  687. <nav class="md-nav" aria-label="Text">
  688. <ul class="md-nav__list">
  689. <li class="md-nav__item">
  690. <a href="#yaml_5" class="md-nav__link">
  691. Yaml
  692. </a>
  693. </li>
  694. <li class="md-nav__item">
  695. <a href="#python_5" class="md-nav__link">
  696. Python
  697. </a>
  698. </li>
  699. </ul>
  700. </nav>
  701. </li>
  702. <li class="md-nav__item">
  703. <a href="#cross" class="md-nav__link">
  704. Cross
  705. </a>
  706. <nav class="md-nav" aria-label="Cross">
  707. <ul class="md-nav__list">
  708. <li class="md-nav__item">
  709. <a href="#yaml_6" class="md-nav__link">
  710. Yaml
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="#python_6" class="md-nav__link">
  715. Python
  716. </a>
  717. </li>
  718. </ul>
  719. </nav>
  720. </li>
  721. <li class="md-nav__item">
  722. <a href="#axis" class="md-nav__link">
  723. Axis
  724. </a>
  725. <nav class="md-nav" aria-label="Axis">
  726. <ul class="md-nav__list">
  727. <li class="md-nav__item">
  728. <a href="#yaml_7" class="md-nav__link">
  729. Yaml
  730. </a>
  731. </li>
  732. <li class="md-nav__item">
  733. <a href="#python_7" class="md-nav__link">
  734. Python
  735. </a>
  736. </li>
  737. </ul>
  738. </nav>
  739. </li>
  740. <li class="md-nav__item">
  741. <a href="#arc" class="md-nav__link">
  742. Arc
  743. </a>
  744. <nav class="md-nav" aria-label="Arc">
  745. <ul class="md-nav__list">
  746. <li class="md-nav__item">
  747. <a href="#yaml_8" class="md-nav__link">
  748. Yaml
  749. </a>
  750. </li>
  751. <li class="md-nav__item">
  752. <a href="#python_8" class="md-nav__link">
  753. Python
  754. </a>
  755. </li>
  756. </ul>
  757. </nav>
  758. </li>
  759. <li class="md-nav__item">
  760. <a href="#arc_wtext" class="md-nav__link">
  761. Arc_wText
  762. </a>
  763. <nav class="md-nav" aria-label="Arc_wText">
  764. <ul class="md-nav__list">
  765. <li class="md-nav__item">
  766. <a href="#yaml_9" class="md-nav__link">
  767. Yaml
  768. </a>
  769. </li>
  770. <li class="md-nav__item">
  771. <a href="#python_9" class="md-nav__link">
  772. Python
  773. </a>
  774. </li>
  775. </ul>
  776. </nav>
  777. </li>
  778. <li class="md-nav__item">
  779. <a href="#arrow1" class="md-nav__link">
  780. Arrow1
  781. </a>
  782. <nav class="md-nav" aria-label="Arrow1">
  783. <ul class="md-nav__list">
  784. <li class="md-nav__item">
  785. <a href="#yaml_10" class="md-nav__link">
  786. Yaml
  787. </a>
  788. </li>
  789. <li class="md-nav__item">
  790. <a href="#python_10" class="md-nav__link">
  791. Python
  792. </a>
  793. </li>
  794. </ul>
  795. </nav>
  796. </li>
  797. <li class="md-nav__item">
  798. <a href="#force" class="md-nav__link">
  799. Force
  800. </a>
  801. <nav class="md-nav" aria-label="Force">
  802. <ul class="md-nav__list">
  803. <li class="md-nav__item">
  804. <a href="#yaml_11" class="md-nav__link">
  805. Yaml
  806. </a>
  807. </li>
  808. <li class="md-nav__item">
  809. <a href="#python_11" class="md-nav__link">
  810. Python
  811. </a>
  812. </li>
  813. </ul>
  814. </nav>
  815. </li>
  816. <li class="md-nav__item">
  817. <a href="#wall" class="md-nav__link">
  818. Wall
  819. </a>
  820. <nav class="md-nav" aria-label="Wall">
  821. <ul class="md-nav__list">
  822. <li class="md-nav__item">
  823. <a href="#yaml_12" class="md-nav__link">
  824. Yaml
  825. </a>
  826. </li>
  827. <li class="md-nav__item">
  828. <a href="#python_12" class="md-nav__link">
  829. Python
  830. </a>
  831. </li>
  832. </ul>
  833. </nav>
  834. </li>
  835. <li class="md-nav__item">
  836. <a href="#curve" class="md-nav__link">
  837. Curve
  838. </a>
  839. <nav class="md-nav" aria-label="Curve">
  840. <ul class="md-nav__list">
  841. <li class="md-nav__item">
  842. <a href="#yaml_13" class="md-nav__link">
  843. Yaml
  844. </a>
  845. </li>
  846. <li class="md-nav__item">
  847. <a href="#python_13" class="md-nav__link">
  848. Python
  849. </a>
  850. </li>
  851. </ul>
  852. </nav>
  853. </li>
  854. <li class="md-nav__item">
  855. <a href="#trajectory" class="md-nav__link">
  856. Trajectory
  857. </a>
  858. <nav class="md-nav" aria-label="Trajectory">
  859. <ul class="md-nav__list">
  860. <li class="md-nav__item">
  861. <a href="#yaml_14" class="md-nav__link">
  862. Yaml
  863. </a>
  864. </li>
  865. <li class="md-nav__item">
  866. <a href="#python_14" class="md-nav__link">
  867. Python
  868. </a>
  869. </li>
  870. </ul>
  871. </nav>
  872. </li>
  873. <li class="md-nav__item">
  874. <a href="#gravity" class="md-nav__link">
  875. Gravity
  876. </a>
  877. <nav class="md-nav" aria-label="Gravity">
  878. <ul class="md-nav__list">
  879. <li class="md-nav__item">
  880. <a href="#yaml_15" class="md-nav__link">
  881. Yaml
  882. </a>
  883. </li>
  884. <li class="md-nav__item">
  885. <a href="#python_15" class="md-nav__link">
  886. Python
  887. </a>
  888. </li>
  889. </ul>
  890. </nav>
  891. </li>
  892. <li class="md-nav__item">
  893. <a href="#moment" class="md-nav__link">
  894. Moment
  895. </a>
  896. <nav class="md-nav" aria-label="Moment">
  897. <ul class="md-nav__list">
  898. <li class="md-nav__item">
  899. <a href="#yaml_16" class="md-nav__link">
  900. Yaml
  901. </a>
  902. </li>
  903. <li class="md-nav__item">
  904. <a href="#python_16" class="md-nav__link">
  905. Python
  906. </a>
  907. </li>
  908. </ul>
  909. </nav>
  910. </li>
  911. <li class="md-nav__item">
  912. <a href="#text_warrow" class="md-nav__link">
  913. Text_wArrow
  914. </a>
  915. <nav class="md-nav" aria-label="Text_wArrow">
  916. <ul class="md-nav__list">
  917. <li class="md-nav__item">
  918. <a href="#yaml_17" class="md-nav__link">
  919. Yaml
  920. </a>
  921. </li>
  922. <li class="md-nav__item">
  923. <a href="#python_17" class="md-nav__link">
  924. Python
  925. </a>
  926. </li>
  927. </ul>
  928. </nav>
  929. </li>
  930. <li class="md-nav__item">
  931. <a href="#wheel" class="md-nav__link">
  932. Wheel
  933. </a>
  934. <nav class="md-nav" aria-label="Wheel">
  935. <ul class="md-nav__list">
  936. <li class="md-nav__item">
  937. <a href="#yaml_18" class="md-nav__link">
  938. Yaml
  939. </a>
  940. </li>
  941. <li class="md-nav__item">
  942. <a href="#python_18" class="md-nav__link">
  943. Python
  944. </a>
  945. </li>
  946. </ul>
  947. </nav>
  948. </li>
  949. <li class="md-nav__item">
  950. <a href="#spring" class="md-nav__link">
  951. Spring
  952. </a>
  953. <nav class="md-nav" aria-label="Spring">
  954. <ul class="md-nav__list">
  955. <li class="md-nav__item">
  956. <a href="#yaml_19" class="md-nav__link">
  957. Yaml
  958. </a>
  959. </li>
  960. <li class="md-nav__item">
  961. <a href="#python_19" class="md-nav__link">
  962. Python
  963. </a>
  964. </li>
  965. </ul>
  966. </nav>
  967. </li>
  968. <li class="md-nav__item">
  969. <a href="#dashpot" class="md-nav__link">
  970. Dashpot
  971. </a>
  972. <nav class="md-nav" aria-label="Dashpot">
  973. <ul class="md-nav__list">
  974. <li class="md-nav__item">
  975. <a href="#yaml_20" class="md-nav__link">
  976. Yaml
  977. </a>
  978. </li>
  979. <li class="md-nav__item">
  980. <a href="#python_20" class="md-nav__link">
  981. Python
  982. </a>
  983. </li>
  984. </ul>
  985. </nav>
  986. </li>
  987. <li class="md-nav__item">
  988. <a href="#code-to-display-the-above-defined-shapes" class="md-nav__link">
  989. Code to display the above defined shapes
  990. </a>
  991. <nav class="md-nav" aria-label="Code to display the above defined shapes">
  992. <ul class="md-nav__list">
  993. <li class="md-nav__item">
  994. <a href="#yaml_21" class="md-nav__link">
  995. Yaml
  996. </a>
  997. </li>
  998. <li class="md-nav__item">
  999. <a href="#python_21" class="md-nav__link">
  1000. Python
  1001. </a>
  1002. </li>
  1003. </ul>
  1004. </nav>
  1005. </li>
  1006. </ul>
  1007. </nav>
  1008. </div>
  1009. </div>
  1010. </div>
  1011. <div class="md-content">
  1012. <article class="md-content__inner md-typeset">
  1013. <h1>Shapes Reference</h1>
  1014. <h2 id="list-of-shapes">List of Shapes</h2>
  1015. <p><a href="#code-to-display-the-above-defined-shapes">Code to display shapes</a></p>
  1016. <ul>
  1017. <li><a href="#line">Line</a>: defines a line providing start and end point</li>
  1018. <li><a href="#rectangle">Rectangle</a>: defines a rectangle providing bottom left corner, x dimension, y dimension</li>
  1019. <li><a href="#triangle">Triangle</a>: defines a triangle providing three corner</li>
  1020. <li><a href="#circle">Circle</a>: defines a circle proving center and radius</li>
  1021. <li><a href="#distance-with-text">Distance with text</a>: defines a sizing mark with a label </li>
  1022. <li><a href="#text">Text</a>: defines a given text positionned at the provided point</li>
  1023. <li><a href="#cross">Cross</a>: defines a cross positionned at the provided point</li>
  1024. <li><a href="#axis">Axis</a>: defines an axis at the given point with a given label</li>
  1025. <li><a href="#arc">Arc</a>: defines an Arc providing a center point, a radius, a starting angle and an angle (rotates clock-wise)</li>
  1026. <li><a href="#arc_wtext">Arc_wText</a>: defines an arc with text positionned left (moving clock-wise) of arc half-way</li>
  1027. <li><a href="#arrow1">Arrow1</a>: defines a line with arrow(s) given starting and ending point and arrow termination(s) -&gt;, \&lt;-&gt;, \&lt;-</li>
  1028. <li><a href="#force">Force</a>: defines an Indication of a force by an arrow and a text (symbol)</li>
  1029. <li><a href="#wall">Wall</a>: defines an hached box given starting, ending point and thickness, filled with a pattern</li>
  1030. <li><a href="#curve">Curve</a>: defines a general curve as a sequence of (x,y) coordinates</li>
  1031. <li><a href="#trajectory">Trajectory</a>: defines a general curve as a sequence of Point (subclass Curve)</li>
  1032. <li><a href="#gravity">Gravity</a>: defines a downward-pointing gravity arrow with the symbol g or user given symbol.</li>
  1033. <li><a href="#moment">Moment</a>: defines a Moment arrow with text given text, center and radius</li>
  1034. <li><a href="#text_warrow">Text_wArrow</a>: defines Text, but an arrow is drawn from the mid part of the text to some point arrow_tip</li>
  1035. <li><a href="#wheel">Wheel</a>: defines Hub and spokes Wheel given center, radius, spokes (default 10), inner_radius(default 1/5 of radius)</li>
  1036. <li><a href="#spring">Spring</a>: defines a vertical spring, starting at start and with length as total vertical length</li>
  1037. <li><a href="#dashpot">Dashpot</a>: defines a vertical dashpot of height <code>total_length</code> and <code>start</code> as bottom/starting point.</li>
  1038. </ul>
  1039. <h2 id="line">Line</h2>
  1040. <p><a href="#list-of-shapes">home</a> Defines a line providing start and end point</p>
  1041. <h3 id="yaml">Yaml</h3>
  1042. <pre><code class="yaml">name: line
  1043. shapes:
  1044. A: point(-5,-5)
  1045. B: point(5,5)
  1046. line: Line(A,B)
  1047. </code></pre>
  1048. <h3 id="python">Python</h3>
  1049. <pre><code class="python">A = point(-5,-5)
  1050. B = point(5,5)
  1051. line = Line(A,B)
  1052. line.set_name(&quot;line&quot;)
  1053. </code></pre>
  1054. <p><img alt="line" src="../reference/line.svg" /></p>
  1055. <h2 id="rectangle">Rectangle</h2>
  1056. <p><a href="#list-of-shapes">home</a> Defines a rectangle providing bottom left corner, x dimension, y dimension</p>
  1057. <h3 id="yaml_1">Yaml</h3>
  1058. <pre><code class="yaml">name: rectangle
  1059. shapes:
  1060. L: 8
  1061. h: 5
  1062. p: point(-(L/2),-(h/2))
  1063. rectangle: Rectangle(p,L,h)
  1064. </code></pre>
  1065. <h3 id="python_1">Python</h3>
  1066. <pre><code class="python">L = 8
  1067. h = 5
  1068. p = point(-(L/2),-(h/2))
  1069. rectangle = Rectangle(p,L,h)
  1070. rectangle.set_name(&quot;rectangle&quot;)
  1071. </code></pre>
  1072. <p><img alt="rectangle" src="../reference/rectangle.svg" /></p>
  1073. <h2 id="circle">Circle</h2>
  1074. <p><a href="#list-of-shapes">home</a> Defines a circle proving center and radius</p>
  1075. <h3 id="yaml_2">Yaml</h3>
  1076. <pre><code class="yaml">name: circle
  1077. shapes:
  1078. circle: Circle(point(0,0),5)
  1079. </code></pre>
  1080. <h3 id="python_2">Python</h3>
  1081. <pre><code class="python">circle = Circle(point(0,0),5)
  1082. circle.set_name(&quot;circle&quot;)
  1083. </code></pre>
  1084. <p><img alt="circle" src="../reference/circle.svg" /></p>
  1085. <h2 id="triangle">Triangle</h2>
  1086. <p><a href="#list-of-shapes">home</a> Defines a triangle providing three corner</p>
  1087. <h3 id="yaml_3">Yaml</h3>
  1088. <pre><code class="yaml">name: triangle
  1089. shapes:
  1090. L: 3.0
  1091. W: 4.0
  1092. triangle: Triangle(p1=(W/2,0), p2=(3*W/2,W/2), p3=(4*W/5.,L))
  1093. </code></pre>
  1094. <h3 id="python_3">Python</h3>
  1095. <pre><code class="python">L = 3.0
  1096. W = 4.0
  1097. triangle = Triangle(p1=(W/2,0), p2=(3*W/2,W/2), p3=(4*W/5.,L))
  1098. triangle.set_name(&quot;triangle&quot;)
  1099. </code></pre>
  1100. <p><img alt="triangle" src="../reference/triangle.svg" /></p>
  1101. <h2 id="distance-with-text">Distance with text</h2>
  1102. <p><a href="#list-of-shapes">home</a> Defines a sizing mark with a label </p>
  1103. <h3 id="yaml_4">Yaml</h3>
  1104. <pre><code class="yaml">name: dwt
  1105. shapes:
  1106. fontsize: 14
  1107. t: r'$ 2\pi R^2 $' # sample text
  1108. dwt: Distance_wText((-4,0), (8, 5), t, fontsize)
  1109. </code></pre>
  1110. <h3 id="python_4">Python</h3>
  1111. <pre><code class="python">fontsize=14
  1112. t = r'$ 2\pi R^2 $' # sample text
  1113. dwt = Distance_wText((-4,0), (8, 5), t, fontsize)
  1114. dwt.set_name(&quot;dwt&quot;)
  1115. </code></pre>
  1116. <p><img alt="Distance with text" src="../reference/distancewithtext.svg" /></p>
  1117. <h2 id="text">Text</h2>
  1118. <p><a href="#list-of-shapes">home</a> Defines a given text positionned at the provided point</p>
  1119. <h3 id="yaml_5">Yaml</h3>
  1120. <pre><code class="yaml">name: text
  1121. shapes:
  1122. text: Text(r'$c$', point(0,0))
  1123. </code></pre>
  1124. <h3 id="python_5">Python</h3>
  1125. <pre><code class="python">text = Text(r'$c$', point(0,0))
  1126. text.set_name(&quot;text&quot;)
  1127. </code></pre>
  1128. <p><img alt="Text" src="../reference/text.svg" /></p>
  1129. <h2 id="cross">Cross</h2>
  1130. <p><a href="#list-of-shapes">home</a> Defines a cross positionned at the provided point</p>
  1131. <h3 id="yaml_6">Yaml</h3>
  1132. <pre><code class="yaml">name: cross
  1133. shapes:
  1134. cross: Cross(point(0,0))
  1135. </code></pre>
  1136. <h3 id="python_6">Python</h3>
  1137. <pre><code class="python">cross = Cross(point(1,0))
  1138. cross.set_name(&quot;cross&quot;)
  1139. </code></pre>
  1140. <p><img alt="Cross" src="../reference/cross.svg" /></p>
  1141. <h2 id="axis">Axis</h2>
  1142. <p><a href="#list-of-shapes">home</a> Defines an axis at the given point with a given label</p>
  1143. <h3 id="yaml_7">Yaml</h3>
  1144. <pre><code class="yaml">name: axis
  1145. shapes:
  1146. axis: Axis((0,0), 5, 'x', rotation_angle=0)
  1147. </code></pre>
  1148. <h3 id="python_7">Python</h3>
  1149. <pre><code class="python">axis = Axis((0,0), 5, 'x', rotation_angle=0)
  1150. axis.set_name(&quot;axis&quot;)
  1151. </code></pre>
  1152. <p><img alt="Axis" src="../reference/axis.svg" /></p>
  1153. <h2 id="arc">Arc</h2>
  1154. <p><a href="#list-of-shapes">home</a> Defines an Arc providing a center point, a radius, a starting angle and an angle (rotates clock-wise)</p>
  1155. <h3 id="yaml_8">Yaml</h3>
  1156. <pre><code class="yaml">name: arc
  1157. shapes:
  1158. center: point(0,0)
  1159. radius: 1
  1160. angle: 120
  1161. start_angle: 180-angle
  1162. arc_angle: angle
  1163. arc: Arc(center, radius, start_angle, arc_angle)
  1164. </code></pre>
  1165. <h3 id="python_8">Python</h3>
  1166. <pre><code class="python">center = point(0,0)
  1167. radius = 1
  1168. angle = 120
  1169. start_angle = 180-angle
  1170. arc_angle = angle
  1171. arc = Arc(center, radius, start_angle, arc_angle)
  1172. arc.set_name(&quot;arc&quot;)
  1173. </code></pre>
  1174. <p><img alt="Arc" src="../reference/arc.svg" /></p>
  1175. <h2 id="arc_wtext">Arc_wText</h2>
  1176. <p><a href="#list-of-shapes">home</a> Defines an arc with text positionned left (moving clock-wise) of arc half-way</p>
  1177. <h3 id="yaml_9">Yaml</h3>
  1178. <pre><code class="yaml">name: arc_wtxt
  1179. shapes:
  1180. center: point(0,0)
  1181. radius: 1
  1182. angle: 120
  1183. start_angle: 180-angle
  1184. arc_angle: angle
  1185. arc_wtxt: &quot;Arc_wText(r'$&lt;bslash&gt;theta$', center, radius, start_angle, arc_angle)&quot;
  1186. </code></pre>
  1187. <h3 id="python_9">Python</h3>
  1188. <pre><code class="python">center = point(0,0)
  1189. radius = 1
  1190. angle = 120
  1191. start_angle = 180-angle
  1192. arc_angle = angle
  1193. arc_wtxt = Arc_wText(r'$\theta$', center, radius, start_angle, arc_angle)
  1194. arc_wtxt.set_name(&quot;arcwtxt&quot;)
  1195. </code></pre>
  1196. <p><img alt="Arc with Text" src="../reference/arcwtext.svg" /></p>
  1197. <h2 id="arrow1">Arrow1</h2>
  1198. <p><a href="#list-of-shapes">home</a> defines a line with arrow(s) given starting and ending point and arrow termination(s) -&gt;, \&lt;-&gt;, \&lt;-</p>
  1199. <h3 id="yaml_10">Yaml</h3>
  1200. <pre><code class="yaml">name: arrow1
  1201. shapes:
  1202. start: point(0,0)
  1203. end: point(5,5)
  1204. arrow1: Arrow1(start, end, style='&lt;-&gt;')
  1205. </code></pre>
  1206. <h3 id="python_10">Python</h3>
  1207. <pre><code class="python">start = point(0,0)
  1208. end = point(5,5)
  1209. arrow1 = Arrow1(start, end, style='&lt;-&gt;')
  1210. arrow1.set_name(&quot;arrow1&quot;)
  1211. </code></pre>
  1212. <p><img alt="Arrow1" src="../reference/arrow1.svg" /></p>
  1213. <h2 id="force">Force</h2>
  1214. <p><a href="#list-of-shapes">home</a> defines an Indication of a force by an arrow and a text (symbol)</p>
  1215. <h3 id="yaml_11">Yaml</h3>
  1216. <pre><code class="yaml">name: force
  1217. shapes:
  1218. x: 0
  1219. y: 0
  1220. contact: point(x, y)
  1221. vector: point(-3,-5)
  1222. force: Force(contact - vector, contact, r'$Force$', text_pos='start')
  1223. </code></pre>
  1224. <h3 id="python_11">Python</h3>
  1225. <pre><code class="python">x = 0
  1226. y = 0
  1227. contact = point(x, y)
  1228. vector = point(-3,-5)
  1229. force = Force(contact - vector, contact, r'$Force$', text_pos='start')
  1230. force.set_name(&quot;force&quot;)
  1231. </code></pre>
  1232. <p><img alt="Force" src="../reference/force.svg" /></p>
  1233. <h2 id="wall">Wall</h2>
  1234. <p><a href="#list-of-shapes">home</a> defines an hached box given starting, ending point and thickness, filled with a pattern</p>
  1235. <h3 id="yaml_12">Yaml</h3>
  1236. <pre><code class="yaml">name: wall
  1237. shapes:
  1238. theta: 30
  1239. L: 8
  1240. B: point(L-4,-2) # wall right end
  1241. A: point(-4,tan(radians(theta))*L-2) # wall left end
  1242. wall:
  1243. formula: Wall(x=[A[0], B[0]], y=[A[1], B[1]], thickness=-0.5,transparent=False)
  1244. style:
  1245. linecolor: black
  1246. </code></pre>
  1247. <h3 id="python_12">Python</h3>
  1248. <pre><code class="python">theta = 30
  1249. L = 8
  1250. B = point(L-4,-2) # wall right end
  1251. A = point(-4,tan(radians(theta))*L-2) # wall left end
  1252. wall= Wall(x=[A[0], B[0]], y=[A[1], B[1]], thickness=-0.5,transparent=False)
  1253. wall.set_linecolor('black')
  1254. wall.set_name(&quot;wall&quot;)
  1255. </code></pre>
  1256. <p><img alt="Wall" src="../reference/wall.svg" /></p>
  1257. <h2 id="curve">Curve</h2>
  1258. <p><a href="#list-of-shapes">home</a> defines a general curve as a sequence of (x,y) coordinates</p>
  1259. <h3 id="yaml_13">Yaml</h3>
  1260. <pre><code class="yaml">curve=&quot;&quot;&quot;\
  1261. name: curve
  1262. shapes:
  1263. N: 100
  1264. x: np.linspace(-2.0, 2.0, N)
  1265. y: x**3
  1266. curve: Curve(x,y)
  1267. &quot;&quot;&quot;
  1268. </code></pre>
  1269. <h3 id="python_13">Python</h3>
  1270. <pre><code class="python">N = 100
  1271. x = np.linspace(-2.0, 2.0, N)
  1272. y = x**3
  1273. curve = Curve(x,y)
  1274. curve.draw()
  1275. curve.set_name(&quot;curve&quot;)
  1276. </code></pre>
  1277. <p><img alt="Curve" src="../reference/curve.svg" /></p>
  1278. <h2 id="trajectory">Trajectory</h2>
  1279. <p><a href="#list-of-shapes">home</a> defines a general curve as a sequence of Point (subclass Curve)</p>
  1280. <h3 id="yaml_14">Yaml</h3>
  1281. <pre><code class="yaml">trajectory=&quot;&quot;&quot;\
  1282. name: trajectory
  1283. shapes:
  1284. P1: Point(1,-1)
  1285. P2: P1 + Point(0,2)
  1286. P3: P2 + Point(-2,0)
  1287. P4: P3 + Point(0,-2)
  1288. psq: |
  1289. [P1,P2,P3,P4]
  1290. trajectory: Trajectory(psq)
  1291. &quot;&quot;&quot;
  1292. </code></pre>
  1293. <h3 id="python_14">Python</h3>
  1294. <pre><code class="python">P1 = Point(1,-1)
  1295. P2 = P1 + Point(0,2)
  1296. P3 = P2 + Point(-2,0)
  1297. P4 = P3 + Point(0,-2)
  1298. psq = [P1,P2,P3,P4]
  1299. trajectory = Trajectory(psq)
  1300. trajectory.draw()
  1301. curve.set_name(&quot;trajectory&quot;)
  1302. </code></pre>
  1303. <p><img alt="Curve" src="../reference/trajectory.svg" /></p>
  1304. <h2 id="gravity">Gravity</h2>
  1305. <p><a href="#list-of-shapes">home</a> defines a downward-pointing gravity arrow with the symbol g or user given symbol.</p>
  1306. <h3 id="yaml_15">Yaml</h3>
  1307. <pre><code class="yaml">gravity=&quot;&quot;&quot;
  1308. name: gravity
  1309. shapes:
  1310. c: point(0,0)
  1311. r: 2
  1312. gravity:
  1313. formula: Gravity(c, r, text='$Mg$')
  1314. &quot;&quot;&quot;
  1315. </code></pre>
  1316. <h3 id="python_15">Python</h3>
  1317. <pre><code class="python">c = point(0,0)
  1318. r = 2
  1319. gravity = Gravity(c, r, text='$Mg$')
  1320. gravity.set_name(&quot;gravity&quot;)
  1321. </code></pre>
  1322. <p><img alt="Gravity" src="../reference/gravity.svg" /></p>
  1323. <h2 id="moment">Moment</h2>
  1324. <p><a href="#list-of-shapes">home</a> defines a Moment arrow with text given text, center and radius.</p>
  1325. <h3 id="yaml_16">Yaml</h3>
  1326. <pre><code class="yaml">moment=&quot;&quot;&quot;
  1327. name: moment
  1328. shapes:
  1329. moment: Moment(&quot;$T$&quot;, point(0,0), 2)
  1330. &quot;&quot;&quot;
  1331. </code></pre>
  1332. <h3 id="python_16">Python</h3>
  1333. <pre><code class="python">moment = Moment(&quot;$T$&quot;, point(0,0), 2)
  1334. moment.shape_name=&quot;moment&quot;
  1335. </code></pre>
  1336. <p><img alt="Moment" src="../reference/moment.svg" /></p>
  1337. <h2 id="text_warrow">Text_wArrow</h2>
  1338. <p><a href="#list-of-shapes">home</a> Text, but an arrow is drawn from the mid part of the text to some point arrow_tip</p>
  1339. <h3 id="yaml_17">Yaml</h3>
  1340. <pre><code class="yaml">txtarrow=&quot;&quot;&quot;
  1341. name: txtarrow
  1342. shapes:
  1343. txtarrow: Text_wArrow(&quot;$Text$&quot;, point(0,0), point(2,2))
  1344. &quot;&quot;&quot;
  1345. </code></pre>
  1346. <h3 id="python_17">Python</h3>
  1347. <pre><code class="python">txtarrow = Text_wArrow(&quot;$Text$&quot;, point(0,0), point(2,2))
  1348. txtarrow.set_name(&quot;txtarrow&quot;)
  1349. </code></pre>
  1350. <p><img alt="Text_wArrow" src="../reference/textwarrow.svg" /></p>
  1351. <h2 id="wheel">Wheel</h2>
  1352. <p><a href="#list-of-shapes">home</a> Hub and spokes Wheel given center, radius, spokes (default 10), inner_radius(default 1/5 of radius)</p>
  1353. <h3 id="yaml_18">Yaml</h3>
  1354. <pre><code class="yaml">wheel=&quot;&quot;&quot;
  1355. name: wheel
  1356. shapes:
  1357. wheel: Wheel(point(0,0), 5)
  1358. &quot;&quot;&quot;
  1359. </code></pre>
  1360. <h3 id="python_18">Python</h3>
  1361. <pre><code class="python">wheel = Wheel(point(0,0), 5)
  1362. wheel.set_name(&quot;wheel&quot;)
  1363. </code></pre>
  1364. <p><img alt="Wheel" src="../reference/wheel.svg" /></p>
  1365. <h2 id="spring">Spring</h2>
  1366. <p><a href="#list-of-shapes">home</a> Specify a vertical spring, starting at start and with length as total vertical length</p>
  1367. <h3 id="yaml_19">Yaml</h3>
  1368. <pre><code class="yaml">spring=&quot;&quot;&quot;
  1369. name: spring
  1370. shapes:
  1371. spring:
  1372. formula: Spring(point(0,0),5)
  1373. style:
  1374. linecolor: black
  1375. linewidth: 1
  1376. &quot;&quot;&quot;
  1377. </code></pre>
  1378. <h3 id="python_19">Python</h3>
  1379. <pre><code class="python">spring = Spring(point(0,0),5)
  1380. spring.set_linecolor('black')
  1381. spring.set_linewidth(1)
  1382. spring.set_name(&quot;spring&quot;)
  1383. </code></pre>
  1384. <p><img alt="Spring" src="../reference/spring.svg" /></p>
  1385. <h2 id="dashpot">Dashpot</h2>
  1386. <p><a href="#list-of-shapes">home</a> Defines a vertical dashpot of height <code>total_length</code> and <code>start</code> as bottom/starting point.</p>
  1387. <h3 id="yaml_20">Yaml</h3>
  1388. <pre><code class="yaml">dashpot=&quot;&quot;&quot;
  1389. name: dashpot
  1390. shapes:
  1391. dashpot: Dashpot(point(0,0),5)
  1392. &quot;&quot;&quot;
  1393. </code></pre>
  1394. <h3 id="python_20">Python</h3>
  1395. <pre><code class="python">dashpot = Dashpot(point(0,0),5)
  1396. dashpot.set_name(&quot;dashpot&quot;)
  1397. </code></pre>
  1398. <p><img alt="Dashpot" src="../reference/dashpot.svg" /></p>
  1399. <h2 id="code-to-display-the-above-defined-shapes">Code to display the above defined shapes</h2>
  1400. <p><a href="#list-of-shapes">home</a> In order to display the various shapes, use the following code in a jupyter notebook</p>
  1401. <pre><code class="python">[1]: %matplotlib widget
  1402. [2]: from pysketcher import *
  1403. [3]: from math import tan, radians, sin, cos # needed for python code
  1404. [4]: import numpy as np
  1405. [6]: drawing_tool.set_coordinate_system(xmin=-10, xmax=10,ymin=-10, ymax=10,axis=True)
  1406. [5]: drawing_tool.mpl.gcf().canvas
  1407. </code></pre>
  1408. <p>for Yaml, you need to add those extra steps</p>
  1409. <pre><code class="python">head = &quot;&quot;&quot;\
  1410. libraries: [&quot;from math import tan, radians, sin, cos&quot;,&quot;from pysketcher import *&quot;,&quot;import numpy as np&quot;]
  1411. myfig={}
  1412. sketch = Sketch(myfig)
  1413. sketch.append(head)
  1414. </code></pre>
  1415. <p>The above code initialize myfig sketch space loading into it libraries references so samples can use tan, radians, si, cos and all the objects defined in pysketcher (the module name of jupytersketcher) and numpy as well: this is used by the yaml definition of shapes</p>
  1416. <h3 id="yaml_21">Yaml</h3>
  1417. <pre><code class="python">myfig={}
  1418. sketch=&quot;&quot;&quot;
  1419. # put here the yaml 'object' definition
  1420. &quot;&quot;&quot;
  1421. drawing_tool.erase()
  1422. sketch.append(sketch)
  1423. # replace 'object' by the actual one
  1424. d = myfig['object'].draw()
  1425. drawing_tool.display()
  1426. display(SVG(Sketch.matplotlib2SVG()))
  1427. </code></pre>
  1428. <h3 id="python_21">Python</h3>
  1429. <pre><code class="python">drawing_tool.erase()
  1430. # put the code of the object case here
  1431. # replace object by the actual name line, rectangle, circle...
  1432. object.draw()
  1433. drawing_tool.display()
  1434. display(SVG(Sketch.matplotlib2SVG()))
  1435. </code></pre>
  1436. </article>
  1437. </div>
  1438. </div>
  1439. </main>
  1440. <footer class="md-footer">
  1441. <div class="md-footer-nav">
  1442. <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
  1443. <a href="../learningbyexample/" title="Learning by Example" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
  1444. <div class="md-footer-nav__button md-icon">
  1445. <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>
  1446. </div>
  1447. <div class="md-footer-nav__title">
  1448. <div class="md-ellipsis">
  1449. <span class="md-footer-nav__direction">
  1450. Previous
  1451. </span>
  1452. Learning by Example
  1453. </div>
  1454. </div>
  1455. </a>
  1456. <a href="../yamlsketcher/" title="YAML files Reference" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
  1457. <div class="md-footer-nav__title">
  1458. <div class="md-ellipsis">
  1459. <span class="md-footer-nav__direction">
  1460. Next
  1461. </span>
  1462. YAML files Reference
  1463. </div>
  1464. </div>
  1465. <div class="md-footer-nav__button md-icon">
  1466. <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>
  1467. </div>
  1468. </a>
  1469. </nav>
  1470. </div>
  1471. <div class="md-footer-meta md-typeset">
  1472. <div class="md-footer-meta__inner md-grid">
  1473. <div class="md-footer-copyright">
  1474. Made with
  1475. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1476. Material for MkDocs
  1477. </a>
  1478. </div>
  1479. </div>
  1480. </div>
  1481. </footer>
  1482. </div>
  1483. <script src="../assets/javascripts/vendor.c3dc8c49.min.js"></script>
  1484. <script src="../assets/javascripts/bundle.f9edbbd5.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>
  1485. <script>
  1486. app = initialize({
  1487. base: "..",
  1488. features: [],
  1489. search: Object.assign({
  1490. worker: "../assets/javascripts/worker/search.8e2cddea.min.js"
  1491. }, typeof search !== "undefined" && search)
  1492. })
  1493. </script>
  1494. <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-MML-AM_CHTML"></script>
  1495. </body>
  1496. </html>