Module

Gesso.Geometry

Package: purescript-gesso
Repository: smilack/purescript-gesso

#fromMouseEvent Source

fromMouseEvent :: MouseEvent -> Point

Extract x and y coordinates from a MouseEvent using the pageX and pageY properties

Re-exports from Gesso.Geometry.Dimensions

#Size Source

type Size :: Type -> Row Type -> Row Typetype Size a r = (height :: a, width :: a | r)

A row representing anything that can have a width and height.

#Rectangular Source

type Rectangular :: Type -> Row Type -> Row Typetype Rectangular a r = (Position a) + (Size a) + r

A row representing anything that can have x, y, width, and height properties.

#Position Source

type Position :: Type -> Row Type -> Row Typetype Position a r = (x :: a, y :: a | r)

A row representing anything that can have x and y values.

#sizeless Source

sizeless :: Area

An Area with no width or height

#null Source

null :: Rect

A Rect with no width or height, located at the origin.

Re-exports from Gesso.Geometry.Internal

#Scalers Source

type Scalers = { canvas :: Scaler, drawing :: Scaler, scale :: Number }

Data and functions for converting between the coordinate systems of the canvas element on the page and the view box of the application/drawing.

scale is the amount that the view box has been scaled up or down to fit within the canvas element.

canvas and drawing contain the dimensions of the named space and functions for converting coordinates to itself.

Re-exports from Gesso.Geometry.Scaler

#Scaler Source

type Scaler = Record (Rectangular Number) + (rect :: Rect, scaling :: { all :: forall rl r. RowToList r rl => Scalable rl r Number => Record r -> Builder (Record ()) (Record r) | ScalingFunctions })

Data and functions for working with a coordinate system:

The x, y, width, and height fields are the origin and size of the system. The rect field contains all of them as well - sometimes it's easier to access them indiviually, and sometimes it's easier to access them as a complete Rect.

scaling contains functions to scale x, y, length, and entire records, but they're more convenient to use with the to and from functions rather than being called directly:

-- this:
{ x: 1.0, y: 2.0 } `to` canvas

-- not:
canvas.scaling.all { x: 1.0, y: 2.0 }

#yTo Source

yTo :: Number -> Scaler -> Number

Convert a single y value to the coordinate system of a Scaler:

y' = y `yTo` canvas

#yFrom Source

yFrom :: Scaler -> Number -> Number

yTo with arguments flipped:

y' = canvas `yFrom` y

#xTo Source

xTo :: Number -> Scaler -> Number

Convert a single x value to the coordinate system of a Scaler:

x' = x `xTo` canvas

#xFrom Source

xFrom :: Scaler -> Number -> Number

xTo with arguments flipped:

x' = canvas `xFrom` x

#to Source

to :: forall rl r. RowToList r rl => Scalable rl r Number => Record r -> Scaler -> Record r

Convert fields in an arbitrary record to the coordinate system of a Scaler. If any of these fields is found and has type Number, it will be converted:

x fields: x, x1, x2
y fields: y, y1, y2
length fields: width, w, height, h, radius, r, length, len, l

line' = { x1: 0.0, y1: 0.0, x2: 1.0, y2: 1.0 } `to` canvas
circle' = { x: 0.0, y: 0.0, r: 1.0 } `to` canvas

#lengthTo Source

lengthTo :: Number -> Scaler -> Number

Convert a single length value to the coordinate system of a Scaler:

l' = l `lengthTo` canvas

#lengthFrom Source

lengthFrom :: Scaler -> Number -> Number

lengthTo with arguments flipped:

l' = canvas `lengthFrom` l

#from Source

from :: forall rl r. RowToList r rl => Scalable rl r Number => Scaler -> Record r -> Record r

to with arguments flipped:

line' = canvas `from` { x1: 0.0, y1: 0.0, x2: 1.0, y2: 1.0 }
circle' = canvas `from` { x: 0.0, y: 0.0, r: 1.0 }

#(|~>) Source

Operator alias for Gesso.Geometry.Scaler.yTo (non-associative / precedence 2)

Convert a single y value to the coordinate system of a Scaler:

y' = y |~> canvas

#(<~|) Source

Operator alias for Gesso.Geometry.Scaler.yFrom (non-associative / precedence 2)

yTo with arguments flipped:

y' = canvas <~| y

#(<~/) Source

Operator alias for Gesso.Geometry.Scaler.lengthFrom (non-associative / precedence 2)

lengthTo with arguments flipped:

l' = canvas <~/ l

#(<~-) Source

Operator alias for Gesso.Geometry.Scaler.xFrom (non-associative / precedence 2)