Class GirihPenroseRhombus

Classdesc

This is a general tile superclass. All other tile classes extends this one.

Rule:

the outer and the inner sub polygons must be inside the main polygon's bounds.

Requires

Bounds

Requires

Polyon

Requires

Vertex

Requires

XYCoords

Hierarchy (view full)

GirihTile
- GirihPenroseRhombus

Constructors

constructor

new GirihPenroseRhombus(position, edgeLength?, addCenterPolygon?): GirihPenroseRhombus
Parameters
- position: Vertex
- Optional edgeLength: number
- Optional addCenterPolygon: boolean
Returns GirihPenroseRhombus
Name
GirihPenroseRhombus
Overrides GirihTile.constructor
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihPenroseRhombus.ts:38

Properties

baseBounds

baseBounds: Bounds

The initial bounds (of the un-rotated tile). These are required to calculate the correct texture mapping.

Name

baseBounds

Member

Memberof

GirihTile

Instance

`Readonly` className

className: string = "Polygon"

Required to generate proper CSS classes and other class related IDs.

`Readonly` edgeLength

edgeLength: number

The edge length of this tile (all edges of a Girih tile have same length).

Name

edgeLength

Member

Memberof

GirihTile

Instance

innerTilePolygons

innerTilePolygons: Polygon[]

The inner tile polygons.

Name

innerTilePolygons

Member

Memberof

GirihTile

Instance

isDestroyed

isDestroyed: boolean

Member

isDestroyed

Memberof

Polygon

Instance

isOpen

isOpen: boolean

Member

Memberof

Polygon

Instance

outerTilePolygons

outerTilePolygons: Polygon[]

The outer tile polygons.

Name

outerTilePolygons

Member

Memberof

GirihTile

Instance

position

position: Vertex

The center of this tile.

Name

position

Member

Memberof

GirihTile

Instance

rotation

rotation: number

The rotation of this tile. This is stored to make cloning easier.

Name

rotation.

Member

Memberof

GirihTile

Instance

symmetry

symmetry: number

The symmetry (=order) of this tile. This is the number of steps used for a full rotation (in this Girih case: 10). Future Girih implementations might have other symmetries.

Name

symmetry

Member

Memberof

GirihTile

Instance

`Readonly` textureSource

textureSource: Bounds

A rectangle on the shipped texture image (girihtexture-500px.png) marking the texture position. The bounds are relative, so each component must be in [0..1]. The texture is a square.

Name

textureSource

Member

Memberof

GirihTile

Instance

tileType

tileType: TileType

An identifier for the tile type.

Name

tileType

Member

Memberof

GirihTile

Instance

`Readonly` uid

uid: string

The UID of this drawable object.

Member

Memberof

Polygon

Instance

uniqueSymmetries

uniqueSymmetries: number

The unique symmetries. This must be an nth part of the global symmetry. Rotating this tile `uniqueSymmetries' times results in the same visual tile (flipped around a symmetry axis).

Name

uniqueSymmetries

Member

Memberof

GirihTile

Instance

vertices

vertices: Vertex[]

Member

Memberof

Polygon

Instance

`Static` `Readonly` DEFAULT_EDGE_LENGTH

DEFAULT_EDGE_LENGTH: number = 58

The default edge length.

Name

DEFAULT_EDGE_LENGTH

Member

Memberof

GirihTile

Static

`Static` epsilon

epsilon: number = 0.001

An epsilon to use for detecting adjacent edges. 0.001 seems to be a good value. Adjust if needed.

Name

epsilon

Member

Memberof

GirihTile

Static

`Static` utils

utils: {
area(vertices): number;
signedArea(vertices): number;
} = ...

Type declaration

area:function
- area(vertices): number
- Calculate the area of the given polygon (unsigned).
  
  Note that this does not work for self-intersecting polygons.
  Parameters
  - vertices: XYCoords[]
  Returns number
  Name
  area
  - Defined in plotboilerplate/src/ts/Polygon.ts:653
signedArea:function
- signedArea(vertices): number
- Calulate the signed polyon area by interpreting the polygon as a matrix and calculating its determinant.
  Parameters
  - vertices: XYCoords[]
  Returns number
  Name
  signedArea
  - Defined in plotboilerplate/src/ts/Polygon.ts:677

Methods

`Private` _buildInnerPolygons

_buildInnerPolygons(_edgeLength, addCenterPolygon): void
Parameters
- _edgeLength: number
- addCenterPolygon: boolean
Returns void
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihPenroseRhombus.ts:95

`Private` _buildOuterPolygons

_buildOuterPolygons(_edgeLength, centerPolygonExists): void
Parameters
- _edgeLength: number
- centerPolygonExists: boolean
Returns void
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihPenroseRhombus.ts:133

addVertex

addVertex(vert): void
Add a vertex to the end of the vertices array.
Parameters
- vert: Vertex
  The vertex to add.
Returns void
Method
addVertex

Instance
Memberof
Polygon
Inherited from GirihTile.addVertex
- Defined in plotboilerplate/src/ts/Polygon.ts:119

addVertexAt

addVertexAt(vert, index): void
Add a vertex at a particular position of the vertices array.
Parameters
- vert: Vertex
  The vertex to add.
- index: number
  The position to add the vertex at. Will be handled modulo.
Returns void
Method
addVertexAt

Instance
Memberof
Polygon
Inherited from GirihTile.addVertexAt
- Defined in plotboilerplate/src/ts/Polygon.ts:132

area

area(): number
Calculate the area of the given polygon (unsigned).

Note that this does not work for self-intersecting polygons.

Returns number
Method
area

Instance
Memberof
Polygon
Inherited from GirihTile.area
- Defined in plotboilerplate/src/ts/Polygon.ts:244

clone

clone(): GirihTile
Returns GirihTile
Overrides GirihTile.clone
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihPenroseRhombus.ts:91

closestLineIntersection

closestLineIntersection(line, inVectorBoundsOnly?): Vertex
Get the closest line-polygon-intersection point (closest the line point A).

See demo 47-closest-vector-projection-on-polygon for how it works.
Parameters
- line: VertTuple<any>
  The line to find intersections with.
- inVectorBoundsOnly: boolean = false
  If set to true only intersecion points on the passed vector are considered (located strictly between start and end vertex).
Returns Vertex
- An array of all intersections within the polygon bounds.
Inherited from GirihTile.closestLineIntersection
- Defined in plotboilerplate/src/ts/Polygon.ts:369

containsPolygon

containsPolygon(polygon): boolean
Check if the passed polygon is completly contained inside this polygon.

This means:
- all polygon's vertices must be inside this polygon.
- the polygon has no edge intersections with this polygon.
Parameters
- polygon: Polygon
  The polygon to check if contained.
Returns boolean
Inherited from GirihTile.containsPolygon
- Defined in plotboilerplate/src/ts/Polygon.ts:215

containsVert

containsVert(vert): boolean
Check if the given vertex is inside this polygon.

Ray-casting algorithm found at
https://stackoverflow.com/questions/22521982/check-if-point-inside-a-polygon
Parameters
- vert: XYCoords
  The vertex to check. The new x-component.
Returns boolean
True if the passed vertex is inside this polygon. The polygon is considered closed.

Method
containsVert

Instance
Memberof
Polygon
Inherited from GirihTile.containsVert
- Defined in plotboilerplate/src/ts/Polygon.ts:189

destroy

destroy(): void
This function should invalidate any installed listeners and invalidate this object. After calling this function the object might not hold valid data any more and should not be used.

Returns void
Inherited from GirihTile.destroy
- Defined in plotboilerplate/src/ts/Polygon.ts:637

findAdjacentTilePosition

findAdjacentTilePosition(edgeIndex, tile): IAdjacency
Find the adjacent tile (given by the template tile) Note that the tile itself will be modified (rotated and moved to the correct position).
Parameters
- edgeIndex: number
  The edge number of the you you want to find adjacency for.
- tile: Polygon
  The polygon (or tile) you want to find adjacency for at the specified edge.
Returns IAdjacency
Adjacency information or null if the passed tile does not match.

Name
findAdjacentTilePosition

Memberof
GirihTile

Instance
Inherited from GirihTile.findAdjacentTilePosition
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihTile.ts:263

getBounds

getBounds(): Bounds
Get the bounding box (bounds) of this polygon.

Returns Bounds
The rectangular bounds of this polygon.

Method
getBounds

Instance
Memberof
Polygon
Inherited from GirihTile.getBounds
- Defined in plotboilerplate/src/ts/Polygon.ts:473

getCenterPolygonIndex

getCenterPolygonIndex(): number
If you want the center polygon not to be drawn the canvas handler needs to know the respective polygon index (inside the this.innerTilePolygons array).

Returns number
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihPenroseRhombus.ts:196

getEvenDistributionPolygon

getEvenDistributionPolygon(pointCount): Polygon
Convert this polygon into a new polygon with n evenly distributed vertices.
Parameters
- pointCount: number
  Must not be negative.
Returns Polygon
Inherited from GirihTile.getEvenDistributionPolygon
- Defined in plotboilerplate/src/ts/Polygon.ts:421

getInnerTilePolygonAt

getInnerTilePolygonAt(index): Polygon
Get the inner tile polygon at the given index. This function applies MOD to the index.
Parameters
- index: number
Returns Polygon
The sub polygon (inner tile) at the given index.

Name
getInnerTilePolygonAt

Instance
Memberof
GirihTile
Inherited from GirihTile.getInnerTilePolygonAt
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihTile.ts:343

getInterpolationPolygon

getInterpolationPolygon(interpolationCount): Polygon
Construct a new polygon from this polygon with more vertices on each edge. The interpolation count determines the number of additional vertices on each edge. An interpolation count of 0 will return a polygon that equals the source polygon.
Parameters
- interpolationCount: number
Returns Polygon
A polygon with interpolationCount more vertices (as as factor).
Inherited from GirihTile.getInterpolationPolygon
- Defined in plotboilerplate/src/ts/Polygon.ts:399

getOuterTilePolygonAt

getOuterTilePolygonAt(index): Polygon
Get the outer tile polygon at the given index. This function applies MOD to the index.
Parameters
- index: number
Returns Polygon
The sub polygon (outer tile) at the given index.

Name
getOuterTilePolygonAt

Instance
Memberof
GirihTile
Inherited from GirihTile.getOuterTilePolygonAt
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihTile.ts:359

getVertexAt

getVertexAt(index): Vertex
Get the polygon vertex at the given position (index).

The index may exceed the total vertex count, and will be wrapped around then (modulo).

For k >= 0:
- getVertexAt( vertices.length ) == getVertexAt( 0 )
- getVertexAt( vertices.length + k ) == getVertexAt( k )
- getVertexAt( -k ) == getVertexAt( vertices.length -k )
Parameters
- index: number
  The index of the desired vertex.
Returns Vertex
At the given index.

Metho
getVertexAt

Instance
Memberof
Polygon
Inherited from GirihTile.getVertexAt
- Defined in plotboilerplate/src/ts/Polygon.ts:153

isClockwise

isClockwise(): boolean
Get the winding order of this polgon: clockwise or counterclockwise.

Returns boolean
Method
isClockwise

Instance
Memberof
Polygon
Inherited from GirihTile.isClockwise
- Defined in plotboilerplate/src/ts/Polygon.ts:269

lineIntersections

lineIntersections(line, inVectorBoundsOnly?): Vertex[]
Get all line intersections with this polygon.

See demo 47-closest-vector-projection-on-polygon for how it works.
Parameters
- line: VertTuple<any>
  The line to find intersections with.
- inVectorBoundsOnly: boolean = false
  If set to true only intersecion points on the passed vector are returned (located strictly between start and end vertex).
Returns Vertex[]
- An array of all intersections within the polygon bounds.
Inherited from GirihTile.lineIntersections
- Defined in plotboilerplate/src/ts/Polygon.ts:340

locateEdgeAtPoint

locateEdgeAtPoint(point, tolerance): number
This function locates the closest tile edge (polygon edge) to the passed point.

Currently the edge distance to a point is measured by the euclidian distance from the edge's middle point.

Idea: move this function to Polygon?
Parameters
- point: XYCoords
  The point to detect the closest edge for.
- tolerance: number
  The tolerance (=max distance) the detected edge must be inside.
Returns number
the edge index (index of the starting vertex, so [index,index+1] is the edge ) or -1 if not found.

Name
locateEdgeAtPoint

Instance
Memberof
GirihTile
Inherited from GirihTile.locateEdgeAtPoint
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihTile.ts:408

move

move(amount): Polygon
Move this tile around (together will all inner polygons). As this function overrides Polygon.move(...), the returned instance (this) must be of type Polygon.
Parameters
- amount: XYCoords
Returns Polygon
this

Name
move

Instance
Memberof
GirihTile
Inherited from GirihTile.move
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihTile.ts:244

perimeter

perimeter(): number
Get the perimeter of this polygon. The perimeter is the absolute length of the outline.

If this polygon is open then the last segment (connecting the first and the last vertex) will be skipped.

Returns number
Method
perimeter

Instance
Memberof
Polygon
Inherited from GirihTile.perimeter
- Defined in plotboilerplate/src/ts/Polygon.ts:285

rotate

rotate(angle, center?): GirihTile
Rotate this tile Note: this function behaves a bitdifferent than the genuine Polygon.rotate function! Polygon has the default center of rotation at (0,0). The GirihTile rotates around its center (position) by default.
Parameters
- angle: number
  The angle to use for rotation.
- Optional center: Vertex
  The center of rotation (default is this.position).
Returns GirihTile
this

Name
rotate

Instance
Memberof
GirihTile
Inherited from GirihTile.rotate
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihTile.ts:378

scale

scale(factor, center): Polygon
Scale the polygon relative to the given center.
Parameters
- factor: number
  The scale factor.
- center: Vertex
  The center of scaling.
Returns Polygon
this, for chaining.

Method
scale

Instance
Memberof
Polygon
Inherited from GirihTile.scale
- Defined in plotboilerplate/src/ts/Polygon.ts:306

signedArea

signedArea(): number
Calulate the signed polyon area by interpreting the polygon as a matrix and calculating its determinant.

Returns number
Method
signedArea

Instance
Memberof
Polygon
Inherited from GirihTile.signedArea
- Defined in plotboilerplate/src/ts/Polygon.ts:257

toCubicBezierData

toCubicBezierData(threshold): Vertex[]
Convert this polygon to a sequence of cubic Bézier curves.

The first vertex in the returned array is the start point.
The following sequence are triplets of (first-control-point, secnond-control-point, end-point):
```
startPoint, controlPoint0_0, controlPoint1_1, pathPoint1, controlPoint1_0, controlPoint1_1, ..., endPoint
```
Parameters
- threshold: number
  An optional threshold (default=1.0) how strong the curve segments should over-/under-drive. Should be between 0.0 and 1.0 for best results but other values are allowed.
Returns Vertex[]
An array of 2d vertices that shape the cubic Bézier curve.

Method
toCubicBezierData

Instance
Memberof
Polygon
Inherited from GirihTile.toCubicBezierData
- Defined in plotboilerplate/src/ts/Polygon.ts:553

toCubicBezierPath

toCubicBezierPath(threshold): BezierPath
Convert this polygon to a cubic bezier path instance.
Parameters
- threshold: number
  The threshold, usually from 0.0 to 1.0.
Returns BezierPath
- A bezier path instance.
Method
toCubicBezierPath

Instance
Memberof
Polygon
Inherited from GirihTile.toCubicBezierPath
- Defined in plotboilerplate/src/ts/Polygon.ts:622

toCubicBezierSVGString

toCubicBezierSVGString(threshold): string
Convert this polygon to a cubic bezier curve, represented as an SVG data string.
Parameters
- threshold: number
Returns string
The 'd' part for an SVG 'path' element.

Method
toCubicBezierSVGString

Instance
Memberof
Polygon
Inherited from GirihTile.toCubicBezierSVGString
- Defined in plotboilerplate/src/ts/Polygon.ts:590

toQuadraticBezierData

toQuadraticBezierData(): Vertex[]
Convert this polygon to a sequence of quadratic Bézier curves.

The first vertex in the returned array is the start point.
The following sequence are pairs of control-point-and-end-point:
```
startPoint, controlPoint0, pathPoint1, controlPoint1, pathPoint2, controlPoint2, ..., endPoint
```
Returns Vertex[]
An array of 2d vertices that shape the quadratic Bézier curve.

Method
toQuadraticBezierData

Instance
Memberof
Polygon
Inherited from GirihTile.toQuadraticBezierData
- Defined in plotboilerplate/src/ts/Polygon.ts:501

toQuadraticBezierSVGString

toQuadraticBezierSVGString(): string
Convert this polygon to a quadratic bezier curve, represented as an SVG data string.

Returns string
The 'd' part for an SVG 'path' element.

Method
toQuadraticBezierSVGString

Instance
Memberof
Polygon
Inherited from GirihTile.toQuadraticBezierSVGString
- Defined in plotboilerplate/src/ts/Polygon.ts:528

transformTilePositionToAdjacency

transformTilePositionToAdjacency<P>(baseEdgeIndex, neighbourTile): P
Apply adjacent tile position to neighbourTile.
Type Parameters
- P extends Polygon
Parameters
- baseEdgeIndex: number
  The edge number of the you you want to apply adjacent position for.
- neighbourTile: P
  The polygon (or tile) you want to find adjacency for at the specified edge.
Returns P
the passed tile itself if adjacency was found, null otherwise.

Name
transformTilePositionToAdjacencies

Memberof
GirihTile

Instance
Inherited from GirihTile.transformTilePositionToAdjacency
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihTile.ts:322

transformTileToAdjacencies

transformTileToAdjacencies(baseEdgeIndex, neighbourTile): GirihTile[]
Find all possible adjacent tile positions (and rotations) for neighbourTile.
Parameters
- baseEdgeIndex: number
  The edge number of the you you want to find adjacencies for.
- neighbourTile: GirihTile
  The polygon (or tile) you want to find adjacencies for at the specified edge.
Returns GirihTile[]
Adjacency information or null if the passed tile does not match.

Name
transformTileToAdjacencies

Memberof
GirihTile

Instance
Inherited from GirihTile.transformTileToAdjacencies
- Defined in plotboilerplate/src/ts/utils/datastructures/GirihTile.ts:295

Class GirihPenroseRhombus

Classdesc

Requires

Requires

Requires

Requires

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GirihPenroseRhombus

Name

Properties

baseBounds

Name

Member

Memberof

Instance

Readonly className

Readonly edgeLength

Name

Member

Memberof

Instance

innerTilePolygons

Name

Member

Memberof

Instance

isDestroyed

Member

Memberof

Instance

isOpen

Member

Memberof

Instance

outerTilePolygons

Name

Member

Memberof

Instance

position

Name

Member

Memberof

Instance

rotation

Name

Member

Memberof

Instance

symmetry

Name

Member

Memberof

Instance

Readonly textureSource

Name

Member

Memberof

Instance

tileType

Name

Member

Memberof

Instance

Readonly uid

Member

Memberof

Instance

uniqueSymmetries

Name

Member

Memberof

Instance

`Readonly` className

`Readonly` edgeLength

`Readonly` textureSource

`Readonly` uid

`Static` `Readonly` DEFAULT_EDGE_LENGTH

`Static` epsilon

`Static` utils

`Private` _buildInnerPolygons

`Private` _buildOuterPolygons