jupytersketcher/jupysketch-doc/docs/yamlsketcher.md

Content

• YAML sketcher file grammar
• Libraries, Pysketcher Object creation, Styles, Transform
• Example
• Code to read or write a yaml sketcher file

YAML sketcher file grammar

Sketcher file EBNF Grammar is

Sketch         ::= Sketch_Name Parts
Sketch_Name    ::= "-" " " "name: " Identifier Comment? "\n"
Parts          ::= "-" " " "parts:\n" Comment? Part+
Part           ::= Part_Name Shapes
Part_Name      ::= INDENT "-" " " "name: " Identifier Comment? "\n" DEDENT
Shapes         ::= INDENT " " " " "shapes:\n" Comment? Shape+ DEDENT
Shape          ::= Expression| DoAction | SketchObject
Expression     ::= INDENT Identifier ":" "|\n"? PyRightHandExpression Comment? "\n" DEDENT
DoAction       ::= INDENT Identifier ":" Comment? "\n" Action DEDENT
Action         ::= INDENT "action:" PyExpression Comment? "\n" DEDENT
SketchObject   ::= INDENT Formula Styles? Transforms? DEDENT
Formula        ::= INDENT "|\n"? SketcherCreator Comment? "\n" DEDENT
SketcherCreator::= SketcherClass "(" PyFunctionArgs ")"
SketcherClass  ::= "Line" | "Rectangle" | "Triangle" | "Circle" | "Distance_wText" | "Text" | "Cross" | "Axis" |
"Arc" | "Arc_wText" | "Arrow1" | "Force" | "Wall" | "Curve" | "Trajectory" | "Gravity" | "Moment" | "Text_wArrow" | "Wheel" | "Spring" | "Dashpot"
Styles         ::= INDENT "style:\n" Style+ DEDENT
Style          ::= LineStyle | LineWidth | LineColor | Arrow | Filled_Curves | Shadow
LineStyle      ::= INDENT "linestyle:" " " ("solid" | "dashed" | "dashdot" | "dotted") "\n" DEDENT
LineWidth      ::= INDENT "linewidth:" " " Integer "\n" DEDENT
LineColor      ::= INDENT "linescolor:" " " MatplotLibLine_Colors "\n" DEDENT
Filled_Curves  ::= INDENT "filled_curves:" (Color | Pattern | Color Pattern) Comment? "\n" DEDENT
Color          ::= INDENT "color:" MatplotLibLine_Colors Comment? "\n" DEDENT
Pattern        ::= INDENT "pattern:" MatplotLibPattern Comment? "\n" DEDENT
Arrow          ::= INDENT "linestyle:" " " ("->" | "<-" | "<->") Comment? "\n" DEDENT
Shadow         ::= INDENT "shadow:" " " Integer Comment? "\n" DEDENT
Transforms     ::= INDENT "transform:" "|\n"? Transform+ "\n" DEDENT
Transform      ::= Sketchertransform | "[" Sketchertransform+ "]"
Sketchertransform ::= ("rotate" | "translate" | "..." ) "(" PyFunctionArgs ")"
Integer        ::=[1-9][0-9]*
Identifier     ::= [A-Za-z][_A-Za-z0-9]+
Comment        ::= "#" STRING

Here is the railroad grammar diagram:

Yaml Sketcher railroad diagram

[Built thanks]

Libraries, Pysketcher Object creation, Styles, Transform

Libraries

The libraries token defined in the grammar is

• a single import directive
• a list [] of import directive
• one of the import must be pysketcher!

from pysketcher import *

Pysketcher object creation

• The Python pysktecher object creation is a python class object statment.
• The possible class are defined in this section
• Every parameter of the object creation can be an expression, based upon variables defined before in the YAML file

Styles

The list of possible style correspond to the list of set_<style> members of the corresponding pysketcher class used for the object creation. This function will be applied to the current object under creation. Parameters of this function can be variable defined upstream.

Transform

The transform token defined in the grammer is

• a single transform statement
• a list [] of transform statments
• a tranform statement is a transformation function that can be applied to the object under construction
• example of transform function are rotate, translate
• parameters of the transform function can be expression based upon upstream variables definition

Example

!!omap
- name: unknown
- parts:
  - name: head
    shapes:
      libraries: ['from math import tan, radians, sin, cos', from pysketcher import
          *]
  - name: constants
    shapes:
      fontsize: 18       # size of the characters
      g: 9.81            # constant gravity
      theta: 30.0        # inclined plane angle
      L: 10.0            # sketch sizing parameter
      a: 1.0             #
      xmin: 0.0          # sketech min Abscissa
      ymin: -3.0         # sketech min Ordinate     
      rl: 2.0            # rectangle width
      rL: 1.0            # rectangle length
  - name: frame
    shapes:
      setframe:          # sketch setup
        action: drawing_tool.set_coordinate_system(xmin=xmin-L/5, xmax=xmin+1.5*L,ymin=ymin,
          ymax=ymin+1.5*L,instruction_file='tmp_mpl_friction.py')
      setblackline:      # default frame values and actions
        action: drawing_tool.set_linecolor('black')
      B: point(a+L,0)                    # wall right end
      A: point(a,tan(radians(theta))*L)  # wall left end
      normal_vec: point(sin(radians(theta)),cos(radians(theta)))   # Vector normal to wall
      tangent_vec: point(cos(radians(theta)),-sin(radians(theta))) # Vector tangent to wall
      help_line: Line(A,B)               # wall line
      x: a + 3*L/10.                     # contact point Abscissa
      y: help_line(x=x)                  # contact point Ordinate
      contact: point(x, y)               # contact point: middle of the rectangle bottom edge
      c: contact + rL/2*normal_vec
  - name: body
    shapes:
      rectangle:
        formula: Rectangle(contact, rl, rL)
        style:
          linecolor: blue
          filled_curves: blue
        transform: ['rotate(-theta, contact)', translate(-rl/2*tangent_vec)]
      N:
        formula: Force(contact - rl*normal_vec, contact, r'$N$', text_pos='start')
        style:
          linecolor: black
      wheel:
        formula: "Composition({'outer': rectangle})"
        style:
          shadow: 1
      mc:
        formula: Text(r'$c$', c)
      body:
        formula: "Composition({'wheel': wheel, 'N': N, 'mc': mc})"
        style:
          linecolor: black
  - name: plan
    shapes:
      mB:
        formula: Text(r'$B$',B)
      mA:
        formula: Text(r'$A$', A)
      wall:
        formula: Wall(x=[A[0], B[0]], y=[A[1], B[1]], thickness=-0.25,transparent=False)
        style:
          linecolor: black
      x_const:
        formula: Line(contact, contact + point(0,4))
        style:
          linestyle: dotted
        transform: rotate(-theta, contact)
      x_axis:
        formula: Axis(start=contact+ 2*rl*normal_vec, length=2*rl,label='$x$', rotation_angle=-theta)
      plan:
        formula: "Composition({'body': body, 'inclined wall': wall, 'x start': x_const,\
          \ 'x axis': x_axis, 'mA': mA, 'mB': mB})"
  - name: friction
    shapes:
      mg:
        formula: Gravity(c, rl, text='$Mg$')
        style:
          linecolor: black
      angle:
        formula: Arc_wText(r'$<bslash>theta$', center=B, radius=3, start_angle=180-theta,
          arc_angle=theta, fontsize=fontsize)
        style:
          linecolor: black
          linewidth: 1
      ground:
        formula: Line((B[0]-L/10., 0), (B[0]-L/2.,0))
        stlye:
          linecolor: black
          linestyle: dashed
          linewidth: 1
      friction:
        formula: "Composition({'plan': plan, 'ground': ground, 'mg': mg, 'angle':\
          \ angle})"

Code to read or write a yaml sketcher file

To read a YAML Pysketcher file definition:

from pysketcher import *
myfig={}
sketch = Sketch(myfig)
sketch.file2Sketch("dryfriction.yml")
#...............  can now use sketch to draw something ..................

To write a YAML Pysketcher file definition:

from pysketcher import *
myfig={}
sketch = Sketch(myfig)
#.............  need to create some Pysketcher objects in the sketch .................
sketch.file2Sketch("dryfriction.yml")