vivid

v0.4.0

vivid v0.4.0 Vivid.Line

Represents a line segment between two Points in 2D space.

Summary

Types

t()

Functions

height(line)

Calculates the absolute Y (vertical) distance between the origin and termination points

horizontal?(line)

Returns true if a line is horizontal

init(list)
init(o, t)

Creates a Line

length(line)

Calculates straight-line distance between the two ends of the line segment using Pythagoras’ Theorem

on?(line, point)

Returns whether a point is on the line

origin(line)

Returns the origin (starting) point of the line segment

termination(line)

Returns the termination (ending) point of the line segment

vertical?(line)

Returns true if a line is vertical

width(line)

Calculates the absolute X (horizontal) distance between the origin and termination points

x_distance(line)

Calculates the X (horizontal) distance between the origin and termination points

x_intersect(line, x)

Find the point on the line where it intersects with the specified x axis

y_distance(line)

Calculates the Y (vertical) distance between the origin and termination points

y_intersect(line, y)

Find the point on the line where it intersects with the specified y axis

Types

t() 
t

Functions

height(line) 
height(Vivid.Line.t) :: number

Calculates the absolute Y (vertical) distance between the origin and termination points.

Example 

iex> Vivid.Line.init(Vivid.Point.init(1,1), Vivid.Point.init(4,14)) |> Vivid.Line.height
13
horizontal?(line) 
horizontal?(Vivid.Line.t) :: boolean

Returns true if a line is horizontal.

Example 

iex> use Vivid
...> Line.init(Point.init(10,10), Point.init(20,10))
...> |> Line.horizontal?
true

iex> use Vivid
...> Line.init(Point.init(10,10), Point.init(20,11))
...> |> Line.horizontal?
false
init(list) 
init([Vivid.Point.t]) :: Vivid.Line.t
init(o, t) 
init(Vivid.Point.t, Vivid.Point.t) :: Vivid.Line.t

Creates a Line.

Examples 

iex> Vivid.Line.init(Vivid.Point.init(1,1), Vivid.Point.init(4,4))
%Vivid.Line{origin: %Vivid.Point{x: 1, y: 1}, termination: %Vivid.Point{x: 4, y: 4}}
length(line) 
length(Vivid.Line.t) :: number

Calculates straight-line distance between the two ends of the line segment using Pythagoras’ Theorem

Example 

iex> Vivid.Line.init(Vivid.Point.init(1,1), Vivid.Point.init(4,5)) |> Vivid.Line.length
5.0
on?(line, point) 
on?(Vivid.Line.t, Vivid.Point.t) :: boolean

Returns whether a point is on the line.

Example

iex> use Vivid …> Line.init(Point.init(1,1), Point.init(3,1)) …> |> Line.on?(Point.init(2,1)) true

iex> use Vivid …> Line.init(Point.init(1,1), Point.init(3,1)) …> |> Line.on?(Point.init(2,2)) false

origin(line) 
origin(Vivid.Line.t) :: Vivid.Point.t

Returns the origin (starting) point of the line segment.

Example 

iex> Vivid.Line.init(Vivid.Point.init(1,1), Vivid.Point.init(4,4)) |> Vivid.Line.origin
%Vivid.Point{x: 1, y: 1}
termination(line) 
termination(Vivid.Line.t) :: Vivid.Point.t

Returns the termination (ending) point of the line segment.

Example 

iex> use Vivid
...> Line.init(Point.init(1,1), Point.init(4,4))
...> |> Line.termination
#Vivid.Point<{4, 4}>
vertical?(line) 
vertical?(Vivid.Line.t) :: boolean

Returns true if a line is vertical.

Example 

iex> use Vivid
...> Line.init(Point.init(10,10), Point.init(10,20))
...> |> Line.vertical?
true

iex> use Vivid
...> Line.init(Point.init(10,10), Point.init(11,20))
...> |> Line.vertical?
false
width(line) 
width(Vivid.Line.t) :: number

Calculates the absolute X (horizontal) distance between the origin and termination points.

Example 

iex> Vivid.Line.init(Vivid.Point.init(1,1), Vivid.Point.init(14,4)) |> Vivid.Line.width
13
x_distance(line) 
x_distance(Vivid.Line.t) :: number

Calculates the X (horizontal) distance between the origin and termination points.

Example 

iex> Vivid.Line.init(Vivid.Point.init(14,1), Vivid.Point.init(1,4)) |> Vivid.Line.x_distance
-13
x_intersect(line, x) 
x_intersect(Vivid.Line.t, integer) :: Vivid.Point.t | nil

Find the point on the line where it intersects with the specified x axis.

Example 

iex> use Vivid
...> Line.init(Point.init(25, 15), Point.init(5, 2))
...> |> Line.x_intersect(10)
#Vivid.Point<{10, 5.25}>
y_distance(line) 
y_distance(Vivid.Line.t) :: number

Calculates the Y (vertical) distance between the origin and termination points.

Example 

iex> Vivid.Line.init(Vivid.Point.init(1,14), Vivid.Point.init(4,1)) |> Vivid.Line.y_distance
-13
y_intersect(line, y) 
y_intersect(Vivid.Line.t, integer) :: Vivid.Point.t | nil

Find the point on the line where it intersects with the specified y axis.

Example 

iex> use Vivid
...> Line.init(Point.init(25, 15), Point.init(5, 2))
...> |> Line.y_intersect(10)
#Vivid.Point<{17.307692307692307, 10}>