src/flexagon/trihexaflexagon.py

   1 #!/usr/bin/env python
   2 #
   3 # A generic model for a tri-hexaflexagon
   4 #
   5 # Copyright (C) 2018  Antonio Ospite <ao2@ao2.it>
   6 #
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 from math import cos, sin, pi
  21
  22
  23 class Triangle(object):
  24     def __init__(self, hexagon, index):
  25         self.hexagon = hexagon
  26         self.index = index
  27
  28     @staticmethod
  29     def calc_plan_coordinates(radius, i, j):
  30         apothem = radius * cos(pi / 3.)
  31         side = 2. * radius * sin(pi / 3.)
  32         width = side
  33         height = apothem * 3.
  34
  35         xoffset = (j + 1) * width / 2.
  36         yoffset = (i + (((i + j + 1) % 2) + 1) / 3.) * height
  37
  38         return xoffset, yoffset
  39
  40     def get_angle_in_plan(self):
  41         """The angle of a triangle in the hexaflexagon plan."""
  42         return - ((self.index) % 2) * pi / 3.
  43
  44     def get_angle_in_plan_relative_to_hexagon(self):
  45         """"Get the angle of the triangle in the plan relative to the rotation
  46         of the same triangle in the hexagon."""
  47         # The meaning of the formula regarding the index is the following:
  48         #   - rotate the indices by 1
  49         #   - group by 2 (because couples of triangles move together in the
  50         #     plan)
  51         #   - multiply the group by a rotation factor
  52         return pi + pi / 6 + (((self.index + 1) % 6) // 2) * pi * 2 / 3
  53
  54     def get_angle_in_hexagon(self):
  55         """Get the angle of the triangle in the hexagons.
  56
  57         NOTE: the angle is rotated by pi to have the first triangle with the
  58         base on the bottom."""
  59         return pi + pi / 6. + self.index * pi / 3.
  60
  61     def __str__(self):
  62         return "%d,%d" % (self.hexagon.index, self.index)
  63
  64
  65 class Hexagon(object):
  66     def __init__(self, index):
  67         self.index = index
  68         self.triangles = []
  69         for i in range(6):
  70             triangle = Triangle(self, i)
  71             self.triangles.append(triangle)
  72
  73     def __str__(self):
  74         output = ""
  75         for i in range(0, 6):
  76             output += str(self.triangles[i])
  77             output += "\t"
  78
  79         return output
  80
  81
  82 class TriHexaflexagon(object):
  83     def __init__(self):
  84         self.hexagons = []
  85         for i in range(0, 3):
  86             hexagon = Hexagon(i)
  87             self.hexagons.append(hexagon)
  88
  89         # A plan is described by a mapping of the triangles in the hexagons,
  90         # repositioned on a 2d grid.
  91         #
  92         # In the map below, the grid has two rows, each element of the grid is
  93         # a pair (h, t), where 'h' is the index of the hexagon, and 't' is the
  94         # index of the triangle in that hexagon.
  95         plan_map = [
  96             [(0, 5), (1, 4), (1, 3), (2, 2), (2, 1), (0, 2), (0, 1), (1, 0), (1, 5)],
  97             [(2, 4), (2, 3), (0, 4), (0, 3), (1, 2), (1, 1), (2, 0), (2, 5), (0, 0)]
  98         ]
  99
 100         # Preallocate a bi-dimensional array for an inverse mapping, this is
 101         # useful to retrieve the position in the plan given a triangle.
 102         self.plan_map_inv = [[-1 for t in h.triangles] for h in self.hexagons]
 103
 104         self.plan = []
 105         for i, plan_map_row in enumerate(plan_map):
 106             plan_row = []
 107             for j, mapping in enumerate(plan_map_row):
 108                 hexagon_index, triangle_index = mapping
 109                 hexagon = self.hexagons[hexagon_index]
 110                 triangle = hexagon.triangles[triangle_index]
 111                 plan_row.append(triangle)
 112
 113                 self.plan_map_inv[hexagon_index][triangle_index] = (i, j)
 114
 115             self.plan.append(plan_row)
 116
 117     def get_triangle_plan_position(self, triangle):
 118         return self.plan_map_inv[triangle.hexagon.index][triangle.index]
 119
 120     def __str__(self):
 121         output = ""
 122
 123         for row in self.plan:
 124             for triangle in row:
 125                 output += "%s\t" % str(triangle)
 126             output += "\n"
 127
 128         return output
 129
 130
 131 def test():
 132     trihexaflexagon = TriHexaflexagon()
 133     print(trihexaflexagon)
 134
 135
 136 if __name__ == "__main__":
 137     test()