Class Girih

constructor

• new Girih(edgeLength): Girih

• Create a new empty Girih pattern.

  Parameters

  • edgeLength: number

  Returns Girih

  Memberof

  Girih

Readonly TILE_TEMPLATES

Readonly edgeLength

Readonly tiles

addTile

• addTile(tile): void

• Add a new tile to this Girih pattern.

  Parameters

  • tile: GirihTile

    The tile to add (instance must not already be part of this pattern).

  Returns void

  Name

  addTile

  Memberof

  Girih

  Instance

findPossibleAdjacentTiles

• findPossibleAdjacentTiles(tileIndex, edgeIndex): GirihTile[]

• Find all possible adjadent tiles and their locations (type, rotation and offset). The function will return an array of all possible tiles matching at the given tile and edge.

  Parameters

  • tileIndex: number

    The index of the tile to rotate.
  • edgeIndex: number

    The index of the tile's edge.

  Returns GirihTile[]

  • An array of possible adjecent tiles (already positioned and rotated).

  Name

  findPossibleAdjacentTiles

  Memberof

  Girih

  Instance

locateConatiningTile

• locateConatiningTile(position): number

• Find that tile (index) which contains the given position. First match will be returned.

  Parameters

  • position: Vertex

  Returns number

  The index of the containing tile or -1 if none was found.

  Name

  locateContainingTile

  Memberof

  Girih

  Instance

moveTile

• moveTile(tileIndex, moveXAmount, moveYAmount): void

• Move that tile the mouse is hovering over. The move amounts are abstract numbers, 1 indicating one unit along each axis.

  Parameters

  • tileIndex: number

    The index of the tile to rotate.
  • moveXAmount: number

    The amount to move along the x axis (in pixels).
  • moveYAmount: number

    The amount to move along the y axis (in pixels).

  Returns void

  Name

  moveTile

  Memberof

  Girih

  Instance

removeTileAt

• removeTileAt(index): void

• Remove the tile at given array position. The index must be inside valid bounds.

  Parameters

  • index: number

    The index in the tiles Array.

  Returns void

  Name

  removeTile

  Memberof

  Girih

  Instance

replaceTiles

• replaceTiles(tiles): void

• Parameters

  • tiles: GirihTile[]

  Returns void

turnTile

• turnTile(tileIndex, turnCount): void

• Turn the tile the mouse is hovering over. The turnCount is ab abstract number: -1 for one turn left, +1 for one turn right. The turning angle is defined by the tile with the lowest turn symmetry: the Decagon, so angle is 36°.

  Parameters

  • tileIndex: number

    The index of the tile to rotate.
  • turnCount: number

    A discrete number indicating the number of turn steps.

  Returns void

  Name

  turnTile

  Memberof

  Girih

  Instance