README and license

README.md

@@ -9,10 +9,17 @@ particles overlap.
 
 Run with
 ```bash
-  ./src/jam [configuration_file]
+  ./src/jam [configuration_file] [-L lattice]
 ```
-where `[configuration_file]` is an optional argument that specifies a file with
-a list of particle positions that will be loaded on initial execution.
+
+* `[configuration_file]` is an optional argument that specifies a file with
+    a list of particle positions that will be loaded on initial execution.
+
+* `[-L lattice]` is an optional argument that specifies a background grid that
+  constrains the position of the particles. So far, the `lattice` argument must
+  be `square` for the square lattice, or, to specify the unit length of the
+  lattice: `square:<unit_length>`.
+  
 
 
 # Dependencies
@@ -59,11 +66,8 @@ Commands can be executed by typing `:` (similarly to vim).
 
 # Current developments
 
-So far, Jam only supports cross-shaped particles, but work is in progress to
-support arbitrary shapes consisting of rectangles, circle arcs and triangles
-(check out the `dev` branch to follow the progress).
-
-Support for lattice configurations is also ongoing.
+So far, Jam supports particles made of combinations of rectangles, but there is
+no infrastructure to set the shape of the particle at runtime.
 
 
 # License

src/element.py

@@ -0,0 +1,272 @@
+# Copyright 2021-2023 Ian Jauslin
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+## elements that polyominoes are made of
+import math
+import sys
+
+from point import Point,l_infinity,l_2
+from tools import isint_nonzero,sgn,in_interval,ceil_grid,floor_grid
+from kivy.graphics import Rectangle,Ellipse,Line
+
+# parent class of all elements
+class Element():
+    def __init__(self,x,y,size,**kwargs):
+        self.pos=Point(x,y)
+        self.size=size
+
+    # set position
+    def setpos(self,x,y):
+        self.pos.x=x
+        self.pos.y=y
+
+
+    # override in each subclass
+    # draw element
+    def draw(self,painter):
+        return
+
+    # override in each subclass
+    # draw boundary
+    def stroke(self,painter):
+        return
+
+    # override in each subclass
+    # check whether an element interacts with square
+    def check_interaction(self,element):
+        return False
+
+    # override in each subclass
+    # whether x is in the support of the element
+    def in_support(self,x):
+        return False
+
+    # override in each subclass
+    # check whether an element is touching self
+    def check_touch(self,element):
+        return False
+
+    # override in each subclass
+    # find position along a line that comes in contact with the line going through element.pos in direction v
+    def move_on_line_to_stick(self,element,v):
+        return Point(0,0)
+
+    # override in each subclass
+    # move along edge of element
+    # delta is the impossible move that was asked for
+    def move_along(self,delta,element):
+        return element
+
+
+# rectangular element
+# the size of the y component is specified by an aspect ratio: size_x=size, size_y=size*aspect
+class Element_square(Element):
+    def __init__(self,x,y,size,**kwargs):
+        self.pos=Point(x,y)
+        self.size=size
+        self.aspect=kwargs.get("aspect",1.0)
+
+    # draw element
+    def draw(self,painter):
+        Rectangle(pos=(painter.pos_tocoord_x(self.pos.x-0.5*self.size),painter.pos_tocoord_y(self.pos.y-0.5*self.size*self.aspect)),size=(self.size*painter.base_size,self.size*self.aspect*painter.base_size))
+
+    # draw boundary
+    def stroke(self,painter):
+        # convert to graphical coordinates
+        coordx=painter.pos_tocoord_x(square.pos.x)
+        coordy=painter.pos_tocoord_y(square.pos.y)
+
+        Line(points=(
+        *(coordx-0.5*self.size*painter.base_size,coordy-0.5*self.size*self.aspect*painter.base_size),
+        *(coordx-0.5*self.size*painter.base_size,coordy+0.5*self.size*self.aspect*painter.base_size),
+        *(coordx+0.5*self.size*painter.base_size,coordy+0.5*self.size*self.aspect*painter.base_size),
+        *(coordx+0.5*self.size*painter.base_size,coordy-0.5*self.size*self.aspect*painter.base_size),
+        *(coordx-0.5*self.size*painter.base_size,coordy-0.5*self.size*self.aspect*painter.base_size)
+        ))
+
+    # check whether an element interacts with square
+    # TODO: this only works if element is a square!
+    def check_interaction(self,element):
+        # allow for error
+        return max(abs(element.pos.x-self.pos.x)/(self.size+element.size),abs(element.pos.y-self.pos.y)/(self.size*self.aspect+element.size*element.aspect))<1/2-1e-11
+
+    # whether x is in the support of the element
+    def in_support(self,x):
+        return max(abs(self.pos.x-x.x),abs(self.pos.y-x.y)/self.aspect)<=1/2
+
+    # check whether an element is touching self
+    # TODO: this only works if element is a square!
+    def check_touch(self,element):
+        # allow for error
+        if in_interval(max(abs(element.pos.x-self.pos.x)/(self.size+element.size),abs(element.pos.y-self.pos.y)/(self.size*self.aspect+element.size*element.aspect)),1/2-1e-11,1/2+1e-11):
+                return True
+        return False
+
+    # find position along a line that comes in contact with the line going through element.pos in direction v
+    # TODO: this only works if element is a square!
+    def move_on_line_to_stick(self,element,v):
+        size_x=(self.size+element.size)/2
+        size_y=(self.size*self.aspect+element.size*element.aspect)/2
+        # compute intersections with four lines making up square
+        if v.x!=0:
+            if v.y!=0:
+                intersections=[\
+                Point(self.pos.x+size_x,element.pos.y+v.y/v.x*(self.pos.x+size_x-element.pos.x)),\
+                Point(self.pos.x-size_x,element.pos.y+v.y/v.x*(self.pos.x-size_x-element.pos.x)),\
+                Point(element.pos.x+v.x/v.y*(self.pos.y+size_y-element.pos.y),self.pos.y+size_y),\
+                Point(element.pos.x+v.x/v.y*(self.pos.y-size_y-element.pos.y),self.pos.y-size_y)\
+                ]
+            else:
+                intersections=[\
+                Point(self.pos.x+size_x,element.pos.y),\
+                Point(self.pos.x-size_x,element.pos.y)
+                ]
+        else:
+            if v.y!=0:
+                intersections=[\
+                Point(element.pos.x,self.pos.y+size_y),\
+                Point(element.pos.x,self.pos.y-size_y)\
+                ]
+            else:
+                print("error: move_on_line_to_stick called with v=0, please file a bug report with the developer",file=sys.stderr)
+                exit(-1)
+
+        # compute closest one, on square
+        closest=None
+        dist=math.inf
+        for i in range(0,len(intersections)):
+            # check that it is on square
+            if abs(intersections[i].x-self.pos.x)<=size_x+1e-11 and abs(intersections[i].y-self.pos.y)<=size_y+1e-11:
+                if (intersections[i]-element.pos)**2<dist:
+                    closest=intersections[i]
+                    dist=(intersections[i]-element.pos)**2
+
+        if closest==None:
+            print("error: cannot move particle at (",element.pos.x,",",element.pos.y,") to the boundary of (",self.pos.x,",",self.pos.y,") in direction (",v.x,",",v.y,")",file=sys.stderr)
+            exit(-1)
+
+        # return difference to pos
+        return closest-element.pos
+
+    # move along edge of square
+    # TODO: this only works if element is a square!
+    def move_along(self,delta,element):
+        size_x=(self.size+element.size)/2
+        size_y=(self.size*self.aspect+element.size*element.aspect)/2
+        rel=element.pos-self.pos
+        # check if the particle is stuck in the x direction
+        if isint_nonzero(rel.x/size_x):
+            # check y direction
+            if isint_nonzero(rel.y/size_y):
+                # in corner
+                if sgn(delta.y)==-sgn(rel.y):
+                    # stuck in x direction
+                    return self.move_stuck_x(delta,element)
+                elif sgn(delta.x)==-sgn(rel.x):
+                    # stuck in y direction
+                    return self.move_stuck_y(delta,element)
+                # stuck in both directions
+                return element.pos
+            else:
+                # stuck in x direction
+                return self.move_stuck_x(delta,element)
+        elif isint_nonzero(rel.y/size_y):
+            # stuck in y direction
+            return self.move_stuck_y(delta,element)
+        # this should never happen
+        else:
+            print("error: stuck particle has non-integer relative position: (",rel.x,",",rel.y,")",file=sys.stderr)
+            exit(-1)
+    # move when stuck in the x direction
+    def move_stuck_x(self,delta,element):
+        size_y=(self.size*self.aspect+element.size*element.aspect)/2
+        # only move in y direction
+        candidate=Point(0,delta.y)
+        # do not move past corners
+        rel=element.pos.y-self.pos.y
+        if delta.y>0:
+            if rel<ceil_grid(rel,size_y)-1e-11 and delta.y+rel>ceil_grid(rel,size_y)+1e-11 and ceil_grid(rel,size_y)!=0:
+                # stick to corner
+                candidate.y=ceil_grid(rel,size_y)+self.pos.y-element.pos.y
+        else:
+            if rel>floor_grid(rel,size_y)+1e-11 and delta.y+rel<floor_grid(rel,size_y)-1e-11 and floor_grid(rel,size_y)!=0:
+                # stick to corner
+                candidate.y=floor_grid(rel,size_y)+self.pos.y-element.pos.y
+        return candidate
+    # move when stuck in the y direction
+    def move_stuck_y(self,delta,element):
+        size_x=(self.size+element.size)/2
+        # onlx move in x direction
+        candidate=Point(delta.x,0)
+        # do not move past corners
+        rel=element.pos.x-self.pos.x
+        if delta.x>0:
+            if rel<ceil_grid(rel,size_x)-1e-11 and delta.x+rel>ceil_grid(rel,size_x)+1e-11 and ceil_grid(rel,size_x)!=0:
+                # stick to corner
+                candidate.x=ceil_grid(rel,size_x)+self.pos.x-element.pos.x
+        else:
+            if rel>floor_grid(rel,size_x)+1e-11 and delta.x+rel<floor_grid(rel,size_x)-1e-11 and floor_grid(rel,size_x)!=0:
+                # stick to corner
+                candidate.x=floor_grid(rel,size_x)+self.pos.x-element.pos.x
+        return candidate
+
+
+# circular elements
+# (size is the diameter)
+class Element_circle(Element):
+    # draw element
+    def draw(self,painter):
+        Ellipse(pos=(painter.pos_tocoord_x(self.pos.x-0.5*self.size),painter.pos_tocoord_y(self.pos.y-0.5*self.size)),size=(self.size*painter.base_size,self.size*painter.base_size))
+
+    # draw boundary
+    def stroke(self,painter):
+        Line(circle=(painter.pos_tocoord_x(self.pos.x),painter.pos_tocoord_y(self.pos.y),self.size*0.5*painter.base_size))
+
+    # check whether an element interacts with square
+    # TODO: this only works if element is a circle!
+    def check_interaction(self,element):
+        # allow for error
+        return l_2(element.pos-self.pos)<(self.size+element.size)/2-1e-11
+
+    # whether x is in the support of the element
+    def in_support(self,x):
+        return l_2(self.pos-x)<=1/2
+
+    # check whether an element is touching self
+    # TODO: this only works if element is a circle!
+    def check_touch(self,element):
+        # allow for error
+        if in_interval(l_2(element.pos-self.pos),(self.size+element.size)/2-1e-11,(self.size+element.size)/2+1e-11):
+                return True
+        return False
+
+    # find position along a line that comes in contact with the line going through element.pos in direction v
+    # TODO: this only works if element is a circle!
+    def move_on_line_to_stick(self,element,v):
+        # relative position
+        x=element.pos-self.pos
+        # radius of collision circle
+        R=(element.size+self.size)/2
+
+        # smallest root of t^2 v^2+2x.v t+x^2-R^2
+        t=(-v.dot(x)-math.sqrt(v.dot(x)*v.dot(x)-v.dot(v)*(x.dot(x)-R*R)))/v.dot(v)
+
+        # return difference to pos
+        return v*t
+
+    # move along edge of circle
+    # TODO: this only works if element is a circle!
+    def move_along(self,delta,element):
+        x=element.pos-self.pos+delta
+        return x/l_2(x)*(element.size+self.size)/2+self.pos-element.pos

src/filecheck.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# check that a file is creatable/writable/editable
+
 import os.path
 
 # check that a file can be edited

src/jam

@@ -14,18 +14,70 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import sys
+import os.path,os
+import filecheck
+from lattice import Lattice
+
+## read cli before loading kivy, in case there are errors
+
+# read cli
+openfile=""
+lattice=""
+def read_cli():
+    global openfile
+    global lattice
+
+    # init flag
+    flag=""
+
+    # loop over arguments
+    for arg in sys.argv[1:]:
+        # option flag
+        if arg[0]=='-':
+            # loop over options
+            for c in arg[1:]:
+                # lattice
+                if c=='L':
+                    flag="lattice"
+
+        else:
+            # read lattice argument
+            if flag=="lattice":
+                # test the specification
+                (obj,message)=Lattice.new(arg)
+                if obj==None:
+                    print(message,file=sys.stderr)
+                    exit(-1)
+                lattice=arg
+                # reset flag
+                flag=""
+
+            # no flags
+            else:
+                openfile=arg
+                (ret,message)=filecheck.check_edit(openfile)
+                if ret<0:
+                    print(message,file=sys.stderr)
+                    exit(-1)
+
+# read cli
+read_cli()
+
+
+## import kivy
+
+# disable kivy argument parser
+os.environ["KIVY_NO_ARGS"] = "1"
 
 from kivy.app import App
 from kivy.uix.widget import Widget
 from kivy.uix.boxlayout import BoxLayout
 from kivy.config import Config
-import sys
-import os.path
 
 from painter import Painter
 from status_bar import Status_bar
 from command_prompt import Command_prompt
-import filecheck
 
 # App class
 class Jam_app(App):
@@ -36,6 +88,9 @@ class Jam_app(App):
         # the file open for editing
         self.openfile=kwargs.get("openfile","")
 
+        # the lattice open for editing
+        self.lattice=kwargs.get("lattice","")
+
         # readonly mode
         self.readonly=False
 
@@ -63,24 +118,20 @@ class Jam_app(App):
             # set readonly mode
             self.readonly=not os.access(self.openfile,os.W_OK)
 
+        # load lattice
+        if self.lattice!="":
+            (obj,message)=Lattice.new(self.lattice)
+            self.painter.set_lattice(obj)
+
         return layout
 
 
+
 # disable red circles on right click
 Config.set('input', 'mouse', 'mouse,disable_multitouch')
 # do not exit on escape
 Config.set('kivy', 'exit_on_escape', 0)
 
-# read cli
-openfile=""
-if len(sys.argv)==2:
-    openfile=sys.argv[1]
-    # check file
-    (ret,message)=filecheck.check_edit(openfile)
-    if ret<0:
-        print(message,file=sys.stderr)
-        exit(-1)
-
 # run
 if __name__ == '__main__':
-    Jam_app(openfile=openfile).run()
+    Jam_app(openfile=openfile,lattice=lattice).run()

src/lattice.py

@@ -0,0 +1,76 @@
+# Copyright 2021-2023 Ian Jauslin
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# define background lattices
+
+from point import Point
+
+# parent class of all lattices
+class Lattice():
+    def __init__(self,**kwargs):
+        self.type=kwargs.get("type","")
+
+    # lattice point nearest to point
+    # overwrite in subclasses
+    def nearest(self,point):
+        return point
+
+    # delta to nearest point
+    def nearest_delta(self,point):
+        return self.nearest(point)-point
+
+    # draw lattice
+    # overwrite in subclasses
+    def draw(self,painter):
+        return
+
+    # return the lattice according to a specification
+    def new(spec):
+        specs=spec.split(":")
+        # check type of lattice
+        if specs[0]=="square":
+            return Lattice_square.new_square(specs[1:],spec)
+        else:
+            return(None,"error: unrecognized lattice type: '"+specs[0]+"'")
+
+
+# square lattice
+class Lattice_square(Lattice):
+    def __init__(self,**kwargs):
+
+        self.spacing=kwargs.get("spacing",1.)
+
+        super(Lattice_square,self).__init__(**kwargs,type="square")
+
+    # lattice point nearest to point
+    def nearest(self,point):
+        return Point(round(point.x/self.spacing)*self.spacing,round(point.y/self.spacing)*self.spacing)
+
+    # draw
+    def draw(self,painter):
+        painter.draw_grid(Point(self.spacing/2,self.spacing/2),self.spacing)
+
+    # return the lattice according to a specification
+    def new_square(specs,spec):
+        # no optional args
+        if len(specs)==0:
+            return (Lattice_square(),"")
+        if len(specs)>1:
+            return (None,"error: '"+spec+"' is not a valid specification for the square lattice: should be 'square[:spacing]'")
+        try:
+            spacing=float(specs[0])
+            return (Lattice_square(spacing=spacing),"")
+        except:
+            return (None,"error: '"+spec+"' is not a valid specification for the square lattice: should be 'square[:spacing]'")
+        

src/painter.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# main drawing class
+
 import sys
 import math
 from kivy.uix.widget import Widget
@@ -19,8 +21,7 @@ from kivy.core.window import Window
 from kivy.graphics import Color,Line
 
 from point import Point
-from polyomino import Cross
-from polyomino import Square_element
+from polyomino import Cross,Disk
 
 from tools import remove_fromlist
 
@@ -34,6 +35,9 @@ class Painter(Widget):
         # list of particles
         self.particles=[]
 
+        # underlying lattice
+        self.lattice=None
+
         # particle under mouse
         self.undermouse=None
 
@@ -54,6 +58,9 @@ class Painter(Widget):
         # modifiers
         self.modifiers=[]
 
+        # base size for all particles
+        self.base_size=50
+
         # init Widget
         super(Painter,self).__init__(**kwargs)
 
@@ -61,21 +68,38 @@ class Painter(Widget):
         self.keyboard = Window.request_keyboard(None,self,"text")
         self.keyboard.bind(on_key_down=self.on_key_down,on_key_up=self.on_key_up,on_textinput=self.on_textinput)
 
+        # redraw on resize
+        self.bind(size=lambda obj,value: self.draw())
+
     
     def reset(self):
         self.particles=[]
         self.undermouse=None
         self.draw()
 
+    # set lattice
+    def set_lattice(self,lattice):
+        self.lattice=lattice
+
+        # draw
+        self.draw()
+
+        # snap all existing particles to grid
+        for particle in self.particles:
+            delta=self.lattice.nearest_delta(particle.elements[0].pos)
+            if not self.check_interaction_any(particle,delta):
+                particle.move(delta)
+
+
     # convert logical coordinates (normalized and centered) to the ones that are plotted
     def pos_tocoord_x(self,x):
-        return self.width/2+x*Square_element.size
+        return self.width/2+x*self.base_size
     def pos_tocoord_y(self,y):
-        return self.height/2+y*Square_element.size
+        return self.height/2+y*self.base_size
     def coord_topos_x(self,x):
-        return (x-self.width/2)/Square_element.size
+        return (x-self.width/2)/self.base_size
     def coord_topos_y(self,y):
-        return (y-self.height/2)/Square_element.size
+        return (y-self.height/2)/self.base_size
         
 
 
@@ -88,10 +112,14 @@ class Painter(Widget):
             for particle in self.particles:
                 particle.draw(self)
 
+            # draw lattice
+            if self.lattice!=None:
+                self.lattice.draw(self)
+
             # draw grids
             for particle in self.particles:
                 if particle.grid>0:
-                    self.draw_grid(particle.squares[0].pos,particle.grid)
+                    self.draw_grid(particle.elements[0].pos,particle.grid)
 
             for particle in self.particles:
                 particle.draw(self,alpha=0.5)
@@ -101,17 +129,30 @@ class Painter(Widget):
         # height offset due to status bar and command prompt
         height_offset=self.app.status_bar.height+self.app.command_prompt.height
         # vertical lines
-        # offest wrt 0
-        offset=(pos.x-0.5)%mesh
-        for i in range(math.floor((self.width/Square_element.size-offset)/mesh)+1):
+        # lines right of pos
+        xx=pos.x+mesh/2
+        while self.pos_tocoord_x(xx)<self.width:
             Color(1,1,1)
-            Line(points=((i*mesh+offset)*Square_element.size,height_offset,(i*mesh+offset)*Square_element.size,self.height+height_offset))
-        # horizontal lines
-        # offset wrt 0
-        offset=(pos.y-0.5)%1-height_offset/Square_element.size
-        for i in range(math.floor((self.height/Square_element.size-offset)/mesh)+1):
+            Line(points=(self.pos_tocoord_x(xx),height_offset,self.pos_tocoord_x(xx),self.height+height_offset))
+            xx+=mesh
+        # lines left of pos
+        xx=pos.x-mesh/2
+        while self.pos_tocoord_x(xx)>0:
             Color(1,1,1)
-            Line(points=(0,(i*mesh+offset)*Square_element.size+height_offset,self.width,(i*mesh+offset)*Square_element.size+height_offset))
+            Line(points=(self.pos_tocoord_x(xx),height_offset,self.pos_tocoord_x(xx),self.height+height_offset))
+            xx-=mesh
+        # lines above pos
+        yy=pos.y+mesh/2
+        while self.pos_tocoord_y(yy)<self.height:
+            Color(1,1,1)
+            Line(points=(0,self.pos_tocoord_y(yy),self.width,self.pos_tocoord_y(yy)))
+            yy+=mesh
+        # lines below pos
+        yy=pos.y-mesh/2
+        while self.pos_tocoord_y(yy)>0:
+            Color(1,1,1)
+            Line(points=(0,self.pos_tocoord_y(yy),self.width,self.pos_tocoord_y(yy)))
+            yy-=mesh
 
 
     # respond to keyboard
@@ -153,10 +194,10 @@ class Painter(Widget):
             # zoom
             elif text=="+":
                 # increment by 10%
-                self.set_zoom(Square_element.size/50*1.1)
+                self.set_zoom(self.base_size/50*1.1)
             elif text=="-":
                 # decrease by 10%
-                self.set_zoom(Square_element.size/50*0.9)
+                self.set_zoom(self.base_size/50*0.9)
             elif text=="=":
                 # reset
                 self.set_zoom(1)
@@ -186,9 +227,14 @@ class Painter(Widget):
             touchx=self.coord_topos_x(touch.x)
             touchy=self.coord_topos_y(touch.y)
 
-            # create new cross
+            # create new particle
             if touch.button=="right":
                 new=Cross(touchx,touchy)
+                #new=Disk(touchx,touchy)
+                # snap to lattice
+                if self.lattice!=None:
+                    new.move(self.lattice.nearest_delta(new.elements[0].pos))
+
                 if not self.check_interaction_any(new,Point(0,0)):
                     # add to list
                     self.particles.append(new)
@@ -208,7 +254,7 @@ class Painter(Widget):
 
                 # record relative position of click with respect to reference
                 if self.undermouse!=None:
-                    self.offset=Point(touchx,touchy)-self.undermouse.squares[0].pos
+                    self.offset=Point(touchx,touchy)-self.undermouse.elements[0].pos
 
                 # no modifiers
                 if self.modifiers==[]:
@@ -251,18 +297,30 @@ class Painter(Widget):
 
     # respond to drag
     def on_touch_move(self,touch):
-        # convert to logical
-        touchx=self.coord_topos_x(touch.x)
-        touchy=self.coord_topos_y(touch.y)
 
         # only respond to touch in drawing area
         if self.collide_point(*touch.pos):
+            # convert to logical
+            touchx=self.coord_topos_x(touch.x)
+            touchy=self.coord_topos_y(touch.y)
+
             # only move on left click
             if touch.button=="left" and self.modifiers==[] and self.undermouse!=None:
                 # attempted move determined by the relative position to the relative position of click within self.undermouse
-                delta=self.adjust_move(Point(touchx,touchy)-(self.offset+self.undermouse.squares[0].pos),0)
-                for particle in self.selected:
-                    particle.move(delta)
+                delta=self.adjust_move(Point(touchx,touchy)-(self.offset+self.undermouse.elements[0].pos),0)
+
+                # snap to lattice
+                if self.lattice!=None:
+                    delta=self.lattice.nearest(delta)
+                    # check that the move is possible (which is not guaranteed after snapping to lattice)
+                    if not self.check_interaction_unselected_list(self.selected,delta):
+                        for particle in self.selected:
+                            particle.move(delta)
+
+                # no lattice, move is guaranteed to be acceptable
+                else:
+                    for particle in self.selected:
+                        particle.move(delta)
 
                 # redraw
                 self.draw()
@@ -305,9 +363,15 @@ class Painter(Widget):
     # check whether a candidate particle element with any of the unselected particles
     def check_interaction_unselected_element(self,element,offset):
         for particle in self.unselected:
-            for square in particle.squares:
-                if square.check_interaction(element.pos+offset):
+            for elt in particle.elements:
+                # add offset
+                element.pos+=offset
+                if elt.check_interaction(element):
+                    # reset offset
+                    element.pos-=offset
                     return True
+                # reset offset
+                element.pos-=offset
         return False
 
 
@@ -317,7 +381,7 @@ class Painter(Widget):
         # actual_delta is the smallest (componentwise) of all the computed delta's
         actual_delta=Point(math.inf,math.inf)
         for particle in self.selected:
-            for element in particle.squares:
+            for element in particle.elements:
                 # compute adjustment move due to unselected obstacles
                 adjusted_delta=self.adjust_move_element(delta,element,0)
                 # only keep the smallest delta's (in absolute value)
@@ -343,18 +407,23 @@ class Painter(Widget):
         # whether newpos is acceptable
         accept_newpos=True
         for other in self.unselected:
-            for obstacle in other.squares:
+            for obstacle in other.elements:
                 # move would make element overlap with obstacle
-                if obstacle.check_interaction(element.pos+delta):
+                element.pos+=delta
+                if obstacle.check_interaction(element):
+                    element.pos-=delta
                     accept_newpos=False
                     # check if particle already touches obstacle
-                    if obstacle.check_touch(element.pos):
+                    if obstacle.check_touch(element):
                         # move along obstacle while remaining stuck
-                        newdelta=obstacle.move_along(delta,element.pos)
+                        newdelta=obstacle.move_along(delta,element)
                     else:
-                        newdelta=obstacle.move_on_line_to_stick(element.pos,delta)
+                        newdelta=obstacle.move_on_line_to_stick(element,delta)
                     if not self.check_interaction_unselected_element(element,newdelta):
                         return newdelta
+                else:
+                    # reset offset
+                    element.pos-=delta
         if accept_newpos:
             return delta
         else:
@@ -395,7 +464,9 @@ class Painter(Widget):
         for particle in self.particles:
             if type(particle)==Cross:
                 ff.write("{:d};".format(CROSS_INDEX))
-            ff.write("{:05.2f},{:05.2f};{:3.1f},{:3.1f},{:3.1f}\n".format(particle.squares[0].pos.x,particle.squares[0].pos.y,particle.color[0],particle.color[1],particle.color[2]))
+            elif type(particle)==Disk:
+                ff.write("{:d};".format(DISK_INDEX))
+            ff.write("{:05.2f},{:05.2f};{:3.1f},{:3.1f},{:3.1f}\n".format(particle.elements[0].pos.x,particle.elements[0].pos.y,particle.color[0],particle.color[1],particle.color[2]))
         ff.close()
 
     # read configuration from file
@@ -472,6 +543,8 @@ class Painter(Widget):
                 continue
             if particle_type==CROSS_INDEX:
                 candidate=Cross(pos.x,pos.y,color=color)
+            elif particle_type==DISK_INDEX:
+                candidate=Disk(pos.x,pos.y,color=color)
             else:
                 print("warning: ignoring line "+str(i)+" in file '"+file+"': unrecognized particle type: '"+entries[0]+"'",file=sys.stderr)
                 continue
@@ -508,7 +581,7 @@ class Painter(Widget):
         for particle in self.particles:
             if type(particle)==Cross:
                 ff.write("\cross{"+colors.closest_color(particle.color,colors.xcolor_names)+"}")
-            ff.write("{{({:05.2f},{:05.2f})}};\n".format(particle.squares[0].pos.x-self.particles[0].squares[0].pos.x,particle.squares[0].pos.y-self.particles[0].squares[0].pos.y))
+            ff.write("{{({:05.2f},{:05.2f})}};\n".format(particle.elements[0].pos.x-self.particles[0].elements[0].pos.x,particle.elements[0].pos.y-self.particles[0].elements[0].pos.y))
 
         ff.write("\\end{tikzpicture}\n")
         ff.write("\\end{document}\n")
@@ -518,11 +591,12 @@ class Painter(Widget):
 
     # set zoom level
     def set_zoom(self,level):
-        Square_element.size=level*50
+        self.base_size=level*50
         self.draw()
 
 
 # global variables (used like precompiler variables)
 CROSS_INDEX=1
+DISK_INDEX=2
 
 

src/point.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# two-dimensional point structure
+
 import math
 
 # point in two dimensions
@@ -61,3 +63,7 @@ class Point:
 # L infinity norm
 def l_infinity(x):
     return max(abs(x.x),abs(x.y))
+
+# L 2 norm
+def l_2(x):
+    return math.sqrt(x.x*x.x+x.y*x.y)

src/polyomino.py

@@ -12,18 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import math
-import sys
-from kivy.graphics import Color,Line,Rectangle
-
-from point import Point,l_infinity
-from tools import isint_nonzero,sgn,in_interval
+# a polyomino is a collection of elements, defined in elements.py
+from kivy.graphics import Color,Line
+from point import l_infinity
+from element import Element_square,Element_circle
 
 # parent class of all polyominos
 class Polyomino():
     def __init__(self,**kwargs):
-        # square elements that maje up the polyomino 
-        self.squares=kwargs.get("squares",[])
+        # elements that make up the polyomino 
+        self.elements=kwargs.get("elements",[])
 
         self.color=kwargs.get("color",(0,0,1))
         self.selected=False
@@ -42,212 +40,83 @@ class Polyomino():
             # darken selected
             Color(r/2,g/2,b/2,alpha)
 
-        for square in self.squares:
-            Rectangle(pos=(painter.pos_tocoord_x(square.pos.x-0.5),painter.pos_tocoord_y(square.pos.y-0.5)),size=(square.size,square.size))
+        for element in self.elements:
+            element.draw(painter)
 
         # draw boundary
         self.stroke(painter)
 
     # draw boundary (override for connected polyominos)
     def stroke(self,painter):
-        # convert to graphical coordinates
-        coordx=painter.pos_tocoord_x(square.pos.x)
-        coordy=painter.pos_tocoord_y(square.pos.y)
-
         # white
         Color(1,1,1)
-        for square in self.squares:
-            Line(points=(
-            *(coordx-0.5*square.size,coordy-0.5*square.size),
-            *(coordx-0.5*square.size,coordy+0.5*square.size),
-            *(coordx+0.5*square.size,coordy+0.5*square.size),
-            *(coordx+0.5*square.size,coordy-0.5*square.size),
-            *(coordx-0.5*square.size,coordy-0.5*square.size)
-            ))
+        for element in self.elements:
+            element.stroke(painter)
 
     # move by delta
     def move(self,delta):
-        for square in self.squares:
-            square.pos+=delta
+        for element in self.elements:
+            element.pos+=delta
 
     # whether x is in the support of the polyomino
     def in_support(self,x):
-        for square in self.squares:
-            if l_infinity(square.pos-x)<=1/2:
+        for element in self.elements:
+            if element.in_support(x):
                 return True
         return False
 
     # check whether self interacts with candidate if candidate were moved by offset
     def check_interaction(self,candidate,offset):
-        for square1 in self.squares:
-            for square2 in candidate.squares:
-                if square1.check_interaction(square2.pos+offset):
+        for element1 in self.elements:
+            for element2 in candidate.elements:
+                # add offset
+                element2.pos+=offset
+                if element1.check_interaction(element2):
+                    # reset offset
+                    element2.pos-=offset
                     return True
+                # reset offset
+                element2.pos-=offset
         return False
 
 # square
 class Square(Polyomino):
     def __init__(self,x,y,**kwargs):
-        super(Square,self).__init__(**kwargs,squares=[Square_element(x,y)])
+        super(Square,self).__init__(**kwargs,elements=[Element_square(x,y,size=kwargs.get("size",1.0))])
 
 # cross
 class Cross(Polyomino):
     def __init__(self,x,y,**kwargs):
-        super(Cross,self).__init__(**kwargs,squares=[\
-        Square_element(x,y),\
-        Square_element(x+1,y),\
-        Square_element(x-1,y),\
-        Square_element(x,y+1),\
-        Square_element(x,y-1)\
+        super(Cross,self).__init__(**kwargs,elements=[\
+        Element_square(x,y,1,aspect=3),\
+        Element_square(x+1,y,1),\
+        Element_square(x-1,y,1)\
         ])
 
-    # redefine stroke to avoid lines between touching squares
+    # redefine stroke to avoid lines between touching elements
     def stroke(self,painter):
         # convert to graphical coordinates
-        coordx=painter.pos_tocoord_x(self.squares[0].pos.x)
-        coordy=painter.pos_tocoord_y(self.squares[0].pos.y)
+        coordx=painter.pos_tocoord_x(self.elements[0].pos.x)
+        coordy=painter.pos_tocoord_y(self.elements[0].pos.y)
 
         Color(1,1,1)
         Line(points=(
-        *(coordx-0.5*Square_element.size,coordy-0.5*Square_element.size),
-        *(coordx-0.5*Square_element.size,coordy-1.5*Square_element.size),
-        *(coordx+0.5*Square_element.size,coordy-1.5*Square_element.size),
-        *(coordx+0.5*Square_element.size,coordy-0.5*Square_element.size),
-        *(coordx+1.5*Square_element.size,coordy-0.5*Square_element.size),
-        *(coordx+1.5*Square_element.size,coordy+0.5*Square_element.size),
-        *(coordx+0.5*Square_element.size,coordy+0.5*Square_element.size),
-        *(coordx+0.5*Square_element.size,coordy+1.5*Square_element.size),
-        *(coordx-0.5*Square_element.size,coordy+1.5*Square_element.size),
-        *(coordx-0.5*Square_element.size,coordy+0.5*Square_element.size),
-        *(coordx-1.5*Square_element.size,coordy+0.5*Square_element.size),
-        *(coordx-1.5*Square_element.size,coordy-0.5*Square_element.size),
-        *(coordx-0.5*Square_element.size,coordy-0.5*Square_element.size),
+        *(coordx-0.5*painter.base_size,coordy-0.5*painter.base_size),
+        *(coordx-0.5*painter.base_size,coordy-1.5*painter.base_size),
+        *(coordx+0.5*painter.base_size,coordy-1.5*painter.base_size),
+        *(coordx+0.5*painter.base_size,coordy-0.5*painter.base_size),
+        *(coordx+1.5*painter.base_size,coordy-0.5*painter.base_size),
+        *(coordx+1.5*painter.base_size,coordy+0.5*painter.base_size),
+        *(coordx+0.5*painter.base_size,coordy+0.5*painter.base_size),
+        *(coordx+0.5*painter.base_size,coordy+1.5*painter.base_size),
+        *(coordx-0.5*painter.base_size,coordy+1.5*painter.base_size),
+        *(coordx-0.5*painter.base_size,coordy+0.5*painter.base_size),
+        *(coordx-1.5*painter.base_size,coordy+0.5*painter.base_size),
+        *(coordx-1.5*painter.base_size,coordy-0.5*painter.base_size),
+        *(coordx-0.5*painter.base_size,coordy-0.5*painter.base_size),
         ))
 
-
-
-# square building block of polyominos
-class Square_element():
-    # size
-    size=50
-
+# disk
+class Disk(Polyomino):
     def __init__(self,x,y,**kwargs):
-        self.pos=Point(x,y)
-
-    # set position
-    def setpos(self,x,y):
-        self.pos.x=x
-        self.pos.y=y
-
-
-    # check whether a square at pos interacts with square
-    def check_interaction(self,pos):
-        return l_infinity(pos-self.pos)<1
-
-    # check whether a square at position pos is touching self
-    def check_touch(self,pos):
-        # allow for error
-        if in_interval(l_infinity(pos-self.pos),1-1e-11,1+1e-11):
-                return True
-        return False
-
-    # find position along a line that comes in contact with the line going through pos in direction v
-    def move_on_line_to_stick(self,pos,v):
-        # compute intersections with four lines making up square
-        if v.x!=0:
-            if v.y!=0:
-                intersections=[\
-                Point(self.pos.x+1,pos.y+v.y/v.x*(self.pos.x+1-pos.x)),\
-                Point(self.pos.x-1,pos.y+v.y/v.x*(self.pos.x-1-pos.x)),\
-                Point(pos.x+v.x/v.y*(self.pos.y+1-pos.y),self.pos.y+1),\
-                Point(pos.x+v.x/v.y*(self.pos.y-1-pos.y),self.pos.y-1)\
-                ]
-            else:
-                intersections=[\
-                Point(self.pos.x+1,pos.y+v.y/v.x*(self.pos.x+1-pos.x)),\
-                Point(self.pos.x-1,pos.y+v.y/v.x*(self.pos.x-1-pos.x))
-                ]
-        else:
-            if v.y!=0:
-                intersections=[\
-                Point(pos.x+v.x/v.y*(self.pos.y+1-pos.y),self.pos.y+1),\
-                Point(pos.x+v.x/v.y*(self.pos.y-1-pos.y),self.pos.y-1)\
-                ]
-            else:
-                print("error: move_on_line_to_stick called with v=0, please file a bug report with the developer",file=sys.stderr)
-                exit(-1)
-
-        # compute closest one, on square
-        closest=None
-        dist=math.inf
-        for i in range(0,len(intersections)):
-            # check that it is on square
-            if abs(intersections[i].x-self.pos.x)<=1+1e-11 and abs(intersections[i].y-self.pos.y)<=1+1e-11:
-                if (intersections[i]-pos)**2<dist:
-                    closest=intersections[i]
-                    dist=(intersections[i]-pos)**2
-
-        if closest==None:
-            print("error: cannot move particle at (",pos.x,",",pos.y,") to the boundary of (",self.pos.x,",",self.pos.y,") in direction (",v.x,",",v.y,")",file=sys.stderr)
-            exit(-1)
-
-        # return difference to pos
-        return closest-pos
-
-    # move along edge of square
-    def move_along(self,delta,pos):
-        rel=pos-self.pos
-        # check if the particle is stuck in the x direction
-        if isint_nonzero(rel.x):
-            # check y direction
-            if isint_nonzero(rel.y):
-                # in corner
-                if sgn(delta.y)==-sgn(rel.y):
-                    # stuck in x direction
-                    return self.move_stuck_x(delta,pos)
-                elif sgn(delta.x)==-sgn(rel.x):
-                    # stuck in y direction
-                    return self.move_stuck_y(delta,pos)
-                # stuck in both directions
-                return pos
-            else:
-                # stuck in x direction
-                return self.move_stuck_x(delta,pos)
-        elif isint_nonzero(rel.y):
-            # stuck in y direction
-            return self.move_stuck_y(delta,pos)
-        # this should never happen
-        else:
-            print("error: stuck particle has non-integer relative position: (",rel.x,",",rel.y,")",file=sys.stderr)
-            exit(-1)
-    # move when stuck in the x direction
-    def move_stuck_x(self,delta,pos):
-        # only move in y direction
-        candidate=Point(0,delta.y)
-        # do not move past corners
-        rel=pos.y-self.pos.y
-        if delta.y>0:
-            if rel<math.ceil(rel)-1e-11 and delta.y+rel>math.ceil(rel)+1e-11 and math.ceil(rel)!=0:
-                # stick to corner
-                candidate.y=math.ceil(rel)+self.pos.y-pos.y
-        else:
-            if rel>math.floor(rel)+1e-11 and delta.y+rel<math.floor(rel)-1e-11 and math.floor(rel)!=0:
-                # stick to corner
-                candidate.y=math.floor(rel)+self.pos.y-pos.y
-        return candidate
-    # move when stuck in the y direction
-    def move_stuck_y(self,delta,pos):
-        # onlx move in x direction
-        candidate=Point(delta.x,0)
-        # do not move past corners
-        rel=pos.x-self.pos.x
-        if delta.x>0:
-            if rel<math.ceil(rel)-1e-11 and delta.x+rel>math.ceil(rel)+1e-11 and math.ceil(rel)!=0:
-                # stick to corner
-                candidate.x=math.ceil(rel)+self.pos.x-pos.x
-        else:
-            if rel>math.floor(rel)+1e-11 and delta.x+rel<math.floor(rel)-1e-11 and math.floor(rel)!=0:
-                # stick to corner
-                candidate.x=math.floor(rel)+self.pos.x-pos.x
-        return candidate
-
+        super(Disk,self).__init__(**kwargs,elements=[Element_circle(x,y,size=kwargs.get("size",1.0))])

src/status_bar.py

@@ -1,3 +1,17 @@
+# Copyright 2021-2023 Ian Jauslin
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 from kivy.uix.label import Label
 from kivy.graphics import Color,Rectangle
 from kivy.utils import escape_markup
@@ -45,9 +59,9 @@ class Status_bar(Label):
             spaces=int(self.width/self.char_width)-len(self.raw_text)-13
             if spaces>0:
                 if self.app.painter.reference==None:
-                    self.raw_text+=" "*spaces+"({:05.2f},{:05.2f})\n".format(self.app.painter.selected[0].squares[0].pos.x,self.app.painter.selected[0].squares[0].pos.y)
+                    self.raw_text+=" "*spaces+"({:05.2f},{:05.2f})\n".format(self.app.painter.selected[0].elements[0].pos.x,self.app.painter.selected[0].elements[0].pos.y)
                 else:
-                    self.raw_text+=" "*spaces+"({:05.2f},{:05.2f})\n".format(self.app.painter.selected[0].squares[0].pos.x-self.app.painter.reference.squares[0].pos.x,self.app.painter.selected[0].squares[0].pos.y-self.app.painter.reference.squares[0].pos.y)
+                    self.raw_text+=" "*spaces+"({:05.2f},{:05.2f})\n".format(self.app.painter.selected[0].elements[0].pos.x-self.app.painter.reference.elements[0].pos.x,self.app.painter.selected[0].elements[0].pos.y-self.app.painter.reference.elements[0].pos.y)
 
         # do not wrap
         self.text=self.raw_text[:min(len(self.raw_text),int(self.width/self.char_width))]

src/tools.py

@@ -1,3 +1,19 @@
+# Copyright 2021-2023 Ian Jauslin
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import math
+
 # sign function
 def sgn(x):
     if x>=0:
@@ -20,3 +36,10 @@ def remove_fromlist(a,x):
         a[a.index(x)]=a[len(a)-1]
         a=a[:len(a)-1]
     return a
+
+# snap to a grid: ceiling
+def ceil_grid(x,size):
+    return math.ceil(x/size)*size
+# snap to a grid: floor
+def floor_grid(x,size):
+    return math.floor(x/size)*size