gbrault
/
jupytersketcher
mirror of https://github.com/gbrault/jupytersketcher.git


			
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366
							

<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
      
      <link rel="shortcut icon" href="../assets/images/favicon.png">
      <meta name="generator" content="mkdocs-1.1, mkdocs-material-5.4.0">
    
    
        <title>Reference - Jypyter Sketcher</title>
      
    
      <link rel="stylesheet" href="../assets/stylesheets/main.fe0cca5b.min.css">
      
      
        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
        <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>
      
    
  </head>
  
  
    <body dir="ltr">
  
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
        
        <a href="#list-of-shapes" class="md-skip">
          Skip to content
        </a>
      
    </div>
    <div data-md-component="announce">
      
    </div>
    
      <header class="md-header" data-md-component="header">
  <nav class="md-header-nav md-grid" aria-label="Header">
    <a href=".." title="Jypyter Sketcher" class="md-header-nav__button md-logo" aria-label="Jypyter Sketcher">
      
  
  <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>

    </a>
    <label class="md-header-nav__button md-icon" for="__drawer">
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
    </label>
    <div class="md-header-nav__title" data-md-component="header-title">
      
        <div class="md-header-nav__ellipsis">
          <span class="md-header-nav__topic md-ellipsis">
            Jypyter Sketcher
          </span>
          <span class="md-header-nav__topic md-ellipsis">
            
              Reference
            
          </span>
        </div>
      
    </div>
    
      <label class="md-header-nav__button md-icon" for="__search">
        <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>
      </label>
      
<div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <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">
      <label class="md-search__icon md-icon" for="__search">
        <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>
        <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>
      </label>
      <button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
        <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>
      </button>
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
    
    
  </nav>
</header>
    
    <div class="md-container" data-md-component="container">
      
        
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href=".." title="Jypyter Sketcher" class="md-nav__button md-logo" aria-label="Jypyter Sketcher">
      
  
  <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>

    </a>
    Jypyter Sketcher
  </label>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
  <li class="md-nav__item">
    <a href=".." title="Home" class="md-nav__link">
      Home
    </a>
  </li>

    
  <li class="md-nav__item">
    <a href="../about/" title="About" class="md-nav__link">
      About
    </a>
  </li>

    
  <li class="md-nav__item">
    <a href="../sketcher/" title="Definition" class="md-nav__link">
      Definition
    </a>
  </li>

    
  <li class="md-nav__item md-nav__item--active">
    
    <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
    
    
      <label class="md-nav__link md-nav__link--active" for="__toc">
        Reference
        <span class="md-nav__icon md-icon">
          <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>
        </span>
      </label>
    
    <a href="./" title="Reference" class="md-nav__link md-nav__link--active">
      Reference
    </a>
    
      
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon">
        <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>
      </span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#list-of-shapes" class="md-nav__link">
    List of Shapes
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#line" class="md-nav__link">
    Line
  </a>
  
    <nav class="md-nav" aria-label="Line">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#rectangle" class="md-nav__link">
    Rectangle
  </a>
  
    <nav class="md-nav" aria-label="Rectangle">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_1" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_1" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#circle" class="md-nav__link">
    Circle
  </a>
  
    <nav class="md-nav" aria-label="Circle">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_2" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_2" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#triangle" class="md-nav__link">
    Triangle
  </a>
  
    <nav class="md-nav" aria-label="Triangle">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_3" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_3" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#distance-with-text" class="md-nav__link">
    Distance with text
  </a>
  
    <nav class="md-nav" aria-label="Distance with text">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_4" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_4" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#text" class="md-nav__link">
    Text
  </a>
  
    <nav class="md-nav" aria-label="Text">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_5" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_5" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#cross" class="md-nav__link">
    Cross
  </a>
  
    <nav class="md-nav" aria-label="Cross">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_6" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_6" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#axis" class="md-nav__link">
    Axis
  </a>
  
    <nav class="md-nav" aria-label="Axis">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_7" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_7" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#arc" class="md-nav__link">
    Arc
  </a>
  
    <nav class="md-nav" aria-label="Arc">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_8" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_8" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#arc_wtext" class="md-nav__link">
    Arc_wText
  </a>
  
    <nav class="md-nav" aria-label="Arc_wText">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_9" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_9" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#arrow1" class="md-nav__link">
    Arrow1
  </a>
  
    <nav class="md-nav" aria-label="Arrow1">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_10" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_10" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#force" class="md-nav__link">
    Force
  </a>
  
    <nav class="md-nav" aria-label="Force">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_11" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_11" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#wall" class="md-nav__link">
    Wall
  </a>
  
    <nav class="md-nav" aria-label="Wall">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_12" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_12" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#code-to-display-the-above-defined-shapes" class="md-nav__link">
    Code to display the above defined shapes
  </a>
  
    <nav class="md-nav" aria-label="Code to display the above defined shapes">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_13" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_13" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
    </ul>
  
</nav>
    
  </li>

    
  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
    <label class="md-nav__title" for="__toc">
      <span class="md-nav__icon md-icon">
        <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>
      </span>
      Table of contents
    </label>
    <ul class="md-nav__list" data-md-scrollfix>
      
        <li class="md-nav__item">
  <a href="#list-of-shapes" class="md-nav__link">
    List of Shapes
  </a>
  
</li>
      
        <li class="md-nav__item">
  <a href="#line" class="md-nav__link">
    Line
  </a>
  
    <nav class="md-nav" aria-label="Line">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#rectangle" class="md-nav__link">
    Rectangle
  </a>
  
    <nav class="md-nav" aria-label="Rectangle">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_1" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_1" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#circle" class="md-nav__link">
    Circle
  </a>
  
    <nav class="md-nav" aria-label="Circle">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_2" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_2" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#triangle" class="md-nav__link">
    Triangle
  </a>
  
    <nav class="md-nav" aria-label="Triangle">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_3" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_3" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#distance-with-text" class="md-nav__link">
    Distance with text
  </a>
  
    <nav class="md-nav" aria-label="Distance with text">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_4" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_4" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#text" class="md-nav__link">
    Text
  </a>
  
    <nav class="md-nav" aria-label="Text">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_5" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_5" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#cross" class="md-nav__link">
    Cross
  </a>
  
    <nav class="md-nav" aria-label="Cross">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_6" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_6" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#axis" class="md-nav__link">
    Axis
  </a>
  
    <nav class="md-nav" aria-label="Axis">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_7" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_7" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#arc" class="md-nav__link">
    Arc
  </a>
  
    <nav class="md-nav" aria-label="Arc">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_8" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_8" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#arc_wtext" class="md-nav__link">
    Arc_wText
  </a>
  
    <nav class="md-nav" aria-label="Arc_wText">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_9" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_9" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#arrow1" class="md-nav__link">
    Arrow1
  </a>
  
    <nav class="md-nav" aria-label="Arrow1">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_10" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_10" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#force" class="md-nav__link">
    Force
  </a>
  
    <nav class="md-nav" aria-label="Force">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_11" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_11" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#wall" class="md-nav__link">
    Wall
  </a>
  
    <nav class="md-nav" aria-label="Wall">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_12" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_12" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
        <li class="md-nav__item">
  <a href="#code-to-display-the-above-defined-shapes" class="md-nav__link">
    Code to display the above defined shapes
  </a>
  
    <nav class="md-nav" aria-label="Code to display the above defined shapes">
      <ul class="md-nav__list">
        
          <li class="md-nav__item">
  <a href="#yaml_13" class="md-nav__link">
    Yaml
  </a>
  
</li>
        
          <li class="md-nav__item">
  <a href="#python_13" class="md-nav__link">
    Python
  </a>
  
</li>
        
      </ul>
    </nav>
  
</li>
      
    </ul>
  
</nav>
                  </div>
                </div>
              </div>
            
          
          <div class="md-content">
            <article class="md-content__inner md-typeset">
              
                
                  <h1>Reference</h1>
                
                <h2 id="list-of-shapes">List of Shapes</h2>
<p><a href="#code-to-display-the-above-defined-shapes">Code to display shapes</a></p>
<ul>
<li><a href="#line">Line</a>: defines a line providing start and end point</li>
<li><a href="#rectangle">Rectangle</a>: defines a rectangle providing bottom left corner, x dimension, y dimension</li>
<li><a href="#triangle">Triangle</a>: defines a triangle providing three corner</li>
<li><a href="#circle">Circle</a>: defines a circle proving center and radius</li>
<li><a href="#distance-with-text">Distance with text</a>: defines a sizing mark with a label </li>
<li><a href="#text">Text</a>: defines a given text positionned at the provided point</li>
<li><a href="#cross">Cross</a>: defines a cross positionned at the provided point</li>
<li><a href="#axis">Axis</a>: defines an axis at the given point with a given label</li>
<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>
<li><a href="#arc_wtext">Arc_wText</a>: defines an arc with text positionned left (moving clock-wise) of arc half-way</li>
<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>
<li><a href="#force">Force</a>: defines an Indication of a force by an arrow and a text (symbol)</li>
<li><a href="#wall">Wall</a>: defines an hached box given starting, ending point and thickness, filled with a pattern</li>
<li><a href="#"></a></li>
</ul>
<h2 id="line">Line</h2>
<p><a href="#list-of-shapes">home</a> Defines a line providing start and end point</p>
<h3 id="yaml">Yaml</h3>
<pre><code class="yaml">A: point(-5,-5)
B: point(5,5)
line: Line(A,B)
</code></pre>

<h3 id="python">Python</h3>
<pre><code class="python">A = point(-5,-5)
B = point(5,5)
line = Line(A,B)
</code></pre>

<p><img alt="line" src="line.svg" /></p>
<h2 id="rectangle">Rectangle</h2>
<p><a href="#list-of-shapes">home</a> Defines a rectangle providing bottom left corner, x dimension, y dimension</p>
<h3 id="yaml_1">Yaml</h3>
<pre><code class="yaml">L: 8
h: 5
p: point(-(L/2),-(h/2))
rectangle: Rectangle(p,L,h)
</code></pre>

<h3 id="python_1">Python</h3>
<pre><code class="python">L = 8
h = 5
p = point(-(L/2),-(h/2))
rectangle = Rectangle(p,L,h)
</code></pre>

<p><img alt="rectangle" src="rectangle.svg" /></p>
<h2 id="circle">Circle</h2>
<p><a href="#list-of-shapes">home</a> Defines a circle proving center and radius</p>
<h3 id="yaml_2">Yaml</h3>
<pre><code class="yaml">circle: Circle(point(0,0),5)
</code></pre>

<h3 id="python_2">Python</h3>
<pre><code class="python">circle = Circle(point(0,0),5)
</code></pre>

<p><img alt="circle" src="circle.svg" /></p>
<h2 id="triangle">Triangle</h2>
<p><a href="#list-of-shapes">home</a> Defines a triangle providing three corner</p>
<h3 id="yaml_3">Yaml</h3>
<pre><code class="yaml">L: 3.0
W: 4.0
triangle: Triangle(p1=(W/2,0), p2=(3*W/2,W/2), p3=(4*W/5.,L))
</code></pre>

<h3 id="python_3">Python</h3>
<pre><code class="python">L = 3.0
W = 4.0
triangle = Triangle(p1=(W/2,0), p2=(3*W/2,W/2), p3=(4*W/5.,L))
</code></pre>

<p><img alt="triangle" src="triangle.svg" /></p>
<h2 id="distance-with-text">Distance with text</h2>
<p><a href="#list-of-shapes">home</a> Defines a sizing mark with a label </p>
<h3 id="yaml_4">Yaml</h3>
<pre><code class="yaml">fontsize: 14
t: r'$ 2\pi R^2 $'  # sample text
dwt: Distance_wText((-4,0), (8, 5), t, fontsize)
</code></pre>

<h3 id="python_4">Python</h3>
<pre><code class="python">fontsize=14
t = r'$ 2\pi R^2 $'  # sample text
dwt = Distance_wText((-4,0), (8, 5), t, fontsize)
</code></pre>

<p><img alt="Distance with text" src="distancewithtext.svg" /></p>
<h2 id="text">Text</h2>
<p><a href="#list-of-shapes">home</a> Defines a given text positionned at the provided point</p>
<h3 id="yaml_5">Yaml</h3>
<pre><code class="yaml">text: Text(r'$c$', point(0,0))
</code></pre>

<h3 id="python_5">Python</h3>
<pre><code class="python">text = Text(r'$c$', point(0,0))
</code></pre>

<p><img alt="Text" src="text.svg" /></p>
<h2 id="cross">Cross</h2>
<p><a href="#list-of-shapes">home</a> Defines a cross positionned at the provided point</p>
<h3 id="yaml_6">Yaml</h3>
<pre><code class="yaml">cross: Cross(point(0,0))
</code></pre>

<h3 id="python_6">Python</h3>
<pre><code class="python">cross = Cross(point(1,0))
</code></pre>

<p><img alt="Cross" src="cross.svg" /></p>
<h2 id="axis">Axis</h2>
<p><a href="#list-of-shapes">home</a> Defines an axis at the given point with a given label</p>
<h3 id="yaml_7">Yaml</h3>
<pre><code class="yaml">axis: Axis((0,0), 5, 'x', rotation_angle=0)
</code></pre>

<h3 id="python_7">Python</h3>
<pre><code class="python">axis = Axis((0,0), 5, 'x', rotation_angle=0)
</code></pre>

<p><img alt="Axis" src="axis.svg" /></p>
<h2 id="arc">Arc</h2>
<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>
<h3 id="yaml_8">Yaml</h3>
<pre><code class="yaml">center: point(0,0)
radius: 1
angle: 120
start_angle: 180-angle
arc_angle: angle
arc: Arc(center, radius, start_angle, arc_angle)
</code></pre>

<h3 id="python_8">Python</h3>
<pre><code class="python">center = point(0,0)
radius = 1
angle = 120
start_angle = 180-angle
arc_angle = angle
arc = Arc(center, radius, start_angle, arc_angle)
</code></pre>

<p><img alt="Arc" src="arc.svg" /></p>
<h2 id="arc_wtext">Arc_wText</h2>
<p><a href="#list-of-shapes">home</a> Defines an arc with text positionned left (moving clock-wise) of arc half-way</p>
<h3 id="yaml_9">Yaml</h3>
<pre><code class="yaml">center: point(0,0)
radius: 1
angle: 120
start_angle: 180-angle
arc_angle: angle
arc_wtxt: &quot;Arc_wText(r'$&lt;bslash&gt;theta$', center, radius, start_angle, arc_angle)&quot;
</code></pre>

<h3 id="python_9">Python</h3>
<pre><code class="python">center = point(0,0)
radius = 1
angle = 120
start_angle = 180-angle
arc_angle = angle
arc_wtxt = Arc_wText(r'$\theta$', center, radius, start_angle, arc_angle)
</code></pre>

<p><img alt="Arc with Text" src="arcwtext.svg" /></p>
<h2 id="arrow1">Arrow1</h2>
<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>
<h3 id="yaml_10">Yaml</h3>
<pre><code class="yaml">start: point(0,0)
end: point(5,5)
arrow1: Arrow1(start, end, style='&lt;-&gt;')
</code></pre>

<h3 id="python_10">Python</h3>
<pre><code class="python">start = point(0,0)
end = point(5,5)
arrow1 = Arrow1(start, end, style='&lt;-&gt;')
</code></pre>

<p><img alt="Arrow1" src="arrow1.svg" /></p>
<h2 id="force">Force</h2>
<p><a href="#list-of-shapes">home</a> defines an Indication of a force by an arrow and a text (symbol)</p>
<h3 id="yaml_11">Yaml</h3>
<pre><code class="yaml">x: 0
y: 0
contact: point(x, y)
vector: point(-3,-5)
force: Force(contact - vector, contact, r'$Force$', text_pos='start')
</code></pre>

<h3 id="python_11">Python</h3>
<pre><code class="python">x = 0
y = 0
contact = point(x, y)
vector = point(-3,-5)
force = Force(contact - vector, contact, r'$Force$', text_pos='start')
</code></pre>

<p><img alt="Force" src="force.svg" /></p>
<h2 id="wall">Wall</h2>
<p><a href="#list-of-shapes">home</a> defines an hached box given starting, ending point and thickness, filled with a pattern</p>
<h3 id="yaml_12">Yaml</h3>
<pre><code class="yaml">theta: 30
L: 8
B: point(L-4,-2)                      # wall right end
A: point(-4,tan(radians(theta))*L-2)  # wall left end
wall: 
    formula: Wall(x=[A[0], B[0]], y=[A[1], B[1]], thickness=-0.5,transparent=False)
    style:
        linecolor: black
</code></pre>

<h3 id="python_12">Python</h3>
<pre><code class="python">theta = 30
L = 8
B = point(L-4,-2)                      # wall right end
A = point(-4,tan(radians(theta))*L-2)  # wall left end
wall= Wall(x=[A[0], B[0]], y=[A[1], B[1]], thickness=-0.5,transparent=False)
wall.set_linecolor('black')
</code></pre>

<p><img alt="Wall" src="wall.svg" /></p>
<h2 id="code-to-display-the-above-defined-shapes">Code to display the above defined shapes</h2>
<p><a href="#list-of-shapes">home</a> In order to display the various shapes, use the following code in a jupyter notebook</p>
<pre><code class="python">[1]: %matplotlib widget
[2]: from pysketcher import *
[3]: from math import tan, radians, sin, cos # needed for python code
[4]: drawing_tool.set_coordinate_system(xmin=-10, xmax=10,ymin=-10, ymax=10,axis=True)
[5]: drawing_tool.mpl.gcf().canvas
</code></pre>

<p>for Yaml, you need to add those extra steps</p>
<pre><code class="python">head = &quot;&quot;&quot;\
libraries: [&quot;from math import tan, radians, sin, cos&quot;,&quot;from pysketcher import *&quot;]
myfig={}
sketchParse(head,myfig)
</code></pre>

<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): this is used by the yaml definition of shapes</p>
<h3 id="yaml_13">Yaml</h3>
<pre><code class="python">myfig={}
sketch=&quot;&quot;&quot;
# put here the yaml 'object' definition
&quot;&quot;&quot;
drawing_tool.erase()
sketchParse(sketch,myfig)
# replace 'object' by the actual one
d = myfig['object'].draw() 
drawing_tool.display()
</code></pre>

<h3 id="python_13">Python</h3>
<pre><code class="python">drawing_tool.erase()
# put the code of the object case here
# replace object by the actual name line, rectangle, circle...
object.draw()
drawing_tool.display()
</code></pre>
                
              
            </article>
          </div>
        </div>
      </main>
      
        
<footer class="md-footer">
  
    <div class="md-footer-nav">
      <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
        
          <a href="../sketcher/" title="Definition" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
            <div class="md-footer-nav__button md-icon">
              <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>
            </div>
            <div class="md-footer-nav__title">
              <div class="md-ellipsis">
                <span class="md-footer-nav__direction">
                  Previous
                </span>
                Definition
              </div>
            </div>
          </a>
        
        
      </nav>
    </div>
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-footer-copyright">
        
        Made with
        <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
          Material for MkDocs
        </a>
      </div>
      
    </div>
  </div>
</footer>
      
    </div>
    
      <script src="../assets/javascripts/vendor.d710d30a.min.js"></script>
      <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>
      
      <script>
        app = initialize({
          base: "..",
          features: [],
          search: Object.assign({
            worker: "../assets/javascripts/worker/search.a68abb33.min.js"
          }, typeof search !== "undefined" && search)
        })
      </script>
      
        <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-MML-AM_CHTML"></script>
      
    
  </body>
</html>