Module: Cartesia

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/angle.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.
lib/cartesia/arc.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.
lib/cartesia/bezier.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.
lib/cartesia/catenary.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.
lib/cartesia/chainwrap.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.
lib/cartesia/circle.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.
lib/cartesia/hexcoordinatesystem.rb	Ruby	Kenneth F. Guerin	Copyright © 2022-2024, Kenneth F. Guerin, all rights reserved.
lib/cartesia/hexgeometry.rb	Ruby	Kenneth F. Guerin	Copyright © 2022-2024, Kenneth F. Guerin, all rights reserved.
lib/cartesia/line.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.
lib/cartesia/point.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.
lib/cartesia/polygon.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved. Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.
lib/cartesia/singletons.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Singleton Registry

Singleton Details

angle!(angle) → Angle

Check and/or convert an angle to a Cartesia::Angle

Parameters:

• angle [Numeric or Angle] — the incoming angle arg

Returns:

• [Angle] — a Cartesia::Angle object

---

cp2pt(cp) → Point

Construct a Point from a 2-element array of coordinates.

Parameters:

• cp [Array<Numeric>] — the coordinate pair

Returns:

• [Point] — the Cartesia::Point object

---

cpv2pts(cps) → Array<Point>

Construct an array of Points from an array of coordinates.

Parameters:

• cps [Array<Numeric>] — the numeric coordinates

Returns:

• [Array<Point>] — the array of Cartesia::Points

---

d2angle(d) → Angle

Construct an Angle instance from a degree angle measurement.

Parameters:

• d [Numeric] — the angle in degrees

Returns:

• [Angle] — a Cartesia::Angle instance

---

is_valid_coordinate_pair?(ary) → Boolean

Checks to see if an array is a valid coordinate pair

Parameters:

• ary [Array<Numeric>] — the coordinate pair array

Returns:

• [Boolean] — true if the array is composed of 2 numeric elements

---

new_arc_from_circle(circle, bearing_slice) → Arc

Construct an Arc from a Circle and a bearing slice.

Parameters:

• circle [Circle] — the circle of which the resulting arc is a segment
• bearing_slice [Array<Numeric>] — a 2-element array of angles defining the slice of the circle

Returns:

• [Arc] — the Cartesia::Arc instance

---

new_line_segment(reference, endpt) → Line

Constructs a line segment from two coordinate pairs

Parameters:

• reference [Array<Numeric>] — the reference point of the line segment
• endpt [Array<Numeric>] — the end point of the line segment

Returns:

• [Line] — the new line segment

---

new_rect(point, width, height) → Polygon

Construct a rectangular Polygon from a Point and the width and height dimensions

Parameters:

• point [Point] — the upper left point of the rectangle
• width [Numeric] — the width of the rectangle
• height [Numeric] — the height of the rectangle

Returns:

• [Polygon] —

---

new_square(point, size) → Polygon

Construct a square Polygon from a Point and the size dimensions

Parameters:

• point [Point] — the upper left point of the rectangle
• size [Numeric] — the width of the rectangle

Returns:

• [Polygon] —

---

point!(pt) → Point

Check and/or convert a point to a Cartesia::Point

Parameters:

• pt [Array<Numeric> or Point or Symbol] — the incoming point arg

Returns:

• [Point] — a Cartesia::Point object

---

points!(pt) → Array<Point>

Check and/or convert an array of points or numeric coordinates to an arrya of Cartesia::Points

Parameters:

• pt [Array<Numeric> or Array<Point> or Array<Array<Numeric>>] — the incoming point array arg

Returns:

• [Array<Point>] — theh array of Cartesia::Points

---

r2angle(r) → Angle

Construct an Angle instance from a radian angle measurement.

Parameters:

• r [Numeric] — the angle in radians

Returns:

• [Angle] — a Cartesia::Angle instance

---

s2angle(s) → Angle

Construct an Angle instance from a secton angle measurement.

Parameters:

• s [Numeric] — the angle in sectons

Returns:

• [Angle] — a Cartesia::Angle instance

---

Class: Cartesia::Angle

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/angle.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(m, uom)

Parameters:

• m [Numeric or Cartesia::Angle] — the initial value of the angle
• uom [Symbol] — the unit of measurement for the value <default: :radians>

---

Method Details

+ → Angle

Create a new Angle instance with an angle measurement of the current Angle's measurement added by specified units

Returns:

• [Angle] — a new Angle instance

---

- → Angle

Create a new Angle instance with an angle measurement of the current Angle's measurement subtracted by specified units

Returns:

• [Angle] — a new Angle instance

---

< → Boolean

Compare two angles for less then

Returns:

• [Boolean] — true if the angles are equal

---

<= → Boolean

Compare two angles for less than or equal

Returns:

• [Boolean] — true if the angles are equal

---

== → Boolean

Compare two angles for equality

Returns:

• [Boolean] — true if the angles are equal

---

> → Boolean

Compare two angles for greater than

Returns:

• [Boolean] — true if the angles are equal

---

>= → Boolean

Compare two angles for greater than or equal

Returns:

• [Boolean] — true if the angles are equal

---

add(m, uom) → Angle

Create a new Angle instance with an angle measurement of the current Angle's measurement added by specified units

Parameters:

• m [Numeric or Cartesia::Angle] — the initial value of the angle
• uom [Symbol] — the unit of measurement for the value <default: :radians>

Returns:

• [Angle] — a new Angle instance

---

add!(m, uom) → Angle

Add an angle measurement to an existing Angle

Parameters:

• m [Numeric or Cartesia::Angle] — the initial value of the angle
• uom [Symbol] — the unit of measurement for the value <default: :radians>

Returns:

• [Angle] — the current Angle instance

---

clamp! → Angle

Ensure that an angle measurement is between 0 and RAD360

Returns:

• [Angle] — the current Angle instance

---

degrees → Numeric

Unit conversion method

Returns:

• [Numeric] — the measure of the angle in degrees

---

delta → Angle

Returns:

• [Angle] — a new Angle instance

---

delta! → Angle

Returns:

• [Angle] — the current Angle instance

---

difference → Angle

Calculate the difference between two angles

Returns:

• [Angle] — the difference between two angles

---

reflect_around_pi → Angle

Returns:

• [Angle] — a new Angle instance

---

reflect_around_pi! → Angle

Ensure that ...

Returns:

• [Angle] — the current Angle instance

---

reflect_toward_zero → Angle

Returns:

• [Angle] — a new Angle instance

---

reflect_toward_zero! → Angle

Returns:

• [Angle] — the current Angle instance

---

sectons → Numeric

Unit conversion method

Returns:

• [Numeric] — the measure of the angle in sectons

---

set(m, uom)

Sets the value for the angle

Parameters:

• m [Numeric or Cartesia::Angle] — the initial value of the angle
• uom [Symbol] — the unit of measurement for the value <default: :radians>

---

to_s → String

String conversion method

Returns:

• [String] — the measure of the angle in radians as a String

---

u2r(m, uom) → Numeric   <private>

Unit conversion method used to extract radian measurements from a variety of sources.

Parameters:

• m [Numeric or Cartesia::Angle] — the measure of the angle to convert / extract
• uom [Symbol] — the unit of measurement for the value (ignored if m is a Cartesia::Angle) <default: :radians>

Returns:

• [Numeric] — the angle measurement in radians

---

Class: Cartesia::Arc ← Cartesia::Circle

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/arc.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(center, radius, bearing_slice)

Parameters:

• center [Point] — the center point of the circle
• radius [Numeric] — the radius of the circle
• bearing_slice [Array<Angle>] — a 2-element array of angles defining the bearings of the arc slice

---

Method Details

intersection_from_line(line) → Array<Point>

Calculate the intersection of the arc with a specified line

Parameters:

• line [Line] — the line to compare against

Returns:

• [Array<Point>] — the points which intersect, or :outside

---

to_s → String

String conversion method

Returns:

• [String] — the string representation of the arc

---

Class: Cartesia::Bezier

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/bezier.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(pts)

Parameters:

• pts [Array<Point> or Array<Numeric>] — an array of points defining the Bezier curve

---

Method Details

e_points(intervals)

Parameters:

• intervals [Integer] — the number of intervals between the start and end of the bezier curve

---

is_valid? → Boolean

Returns:

• [Boolean] — true if the bezier curve is of a known type (cubic or quadratic)

---

length → Integer

This function returns the length of the bezier curve

Returns:

• [Integer] — the length of the bezier curve in units

---

t_points(intervals)

Parameters:

• intervals [Integer] — the number of intervals between the start and end of the bezier curve

---

Class: Cartesia::Catenary

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/catenary.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(methods)

Parameters:

• methods [Hash] — the data defining the catenary curve (variants exist)

---

Method Details

calc_a_give_dxphi(dx, phi) → Number   <private>

Parameters:

• dx [Number] — the dx value of the curve
• phi [Number] — the phi value of the curve

Returns:

• [Number] — the calculated a value

---

calc_a_give_dydx(dy, dx) → Number   <private>

Parameters:

• dy [Number] — the dy value of the curve
• dx [Number] — the dx value of the curve

Returns:

• [Number] — the calculated a value

---

calc_a_give_dyphi(dy, phi) → Number   <private>

Parameters:

• dy [Number] — the dy value of the curve
• phi [Number] — the phi value of the curve

Returns:

• [Number] — the calculated a value

---

ct_first(point, distance_from) → Point

Parameters:

• point [Point] — the initial reference piont <default: nil>
• distance_from [Number] — the distance from the point <default: nil>

Returns:

• [Point] — the first tracking point

---

ct_next(distance_from) → Point

Parameters:

• distance_from [Number] — the distance from the current tracked point

Returns:

• [Point] — the next tracking point

---

ct_track_point(op, pt, distance, precision) → Point   <private>

Parameters:

• op [Symbol] — the tracking operation, values are { :first, :next }
• pt [Point] — the reference point
• distance [Number] — the distance from the reference point
• precision [Number] — the dx value of the curve <default: 3>

Returns:

• [Point] — the next tracked point

---

dy_at_dx(dx) → Number

Parameters:

• dx [Number] — the dx value

Returns:

• [Number] — the dy value

---

dy_at_dx(dy) → Number

Parameters:

• dy [Number] — the dy value

Returns:

• [Number] — the dx value

---

finish_curve_tracking

This method takes the curve out of a tracking state.

---

phi_at_dx(dx) → Number

Parameters:

• dx [Number] — the dx value

Returns:

• [Number] — the phi value

---

phi_at_dy(dy) → Number

Parameters:

• dy [Number] — the dy value

Returns:

• [Number] — the phi value

---

s_at_dx(dx) → Number

Parameters:

• dx [Number] — the dx value

Returns:

• [Number] — the s value

---

s_at_dy(dy) → Number

Parameters:

• dy [Number] — the dy value

Returns:

• [Number] — the s value

---

start_curve_tracking(anchor, dx, style, direction) → Boolean

Parameters:

• anchor [Point] — the anchor point of the catenary curve
• dx [Number] — the distance from the anchor point
• style [Symbol] — the style of curve tracking, values are { :px, :nx, :invpx, :invnx }
• direction [Symbol] — the direction of the track, values are { :a2e, :e2a }

Returns:

• [Boolean] — the tracking state of the catenary curve

---

to_s → String

String conversion method

Returns:

• [String] — the string representation of the catenary curve

---

tracking? → Boolean

Returns:

• [Boolean] — the tracking state of the catenary curve

---

Class: Cartesia::ChainWrap

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/chainwrap.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Constructor Details

new(bogies, style, link_thinkness, link_length, links_per_tooth, offset, catgrav_hints)

Parameters:

• bogies [Array<Hash>] — the list of bogies to wrap the chain around
• style [] —
• link_thinkness [Number] — the thickness of the chain
• link_length [Number] — the length of each link of the chain
• links_per_tooth [Number] — the number of links per bogie tooth <default: 1>
• offset [Point] — an offset point <default: nil>
• catgrav_hints [Hash] — catenary curve information for chains/treads that are not taut <default: nil>

---

Class: Cartesia::Circle

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/circle.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(center, radius)

Parameters:

• center [Point] — the center point of the circle
• radius [Numeric] — the radius of the circle

---

Method Details

!=(circle) → Boolean

Inequality method

Parameters:

• circle [Circle] — the circle to compare against

Returns:

• [Boolean] — true if the circles are not identical

---

==(circle) → Boolean

Equality method

Parameters:

• circle [Circle] — the circle to compare against

Returns:

• [Boolean] — true if the circles are identical

---

bounding_box → Polygon

Return the bounding box enclosing the circle

Returns:

• [Polygon] — the bounding box (square) enclosing the circle

---

closest_intersection_point_from_point(point) → Point

Calculate the closest intersection point on a circle from a given point

Parameters:

• point [Point] — the point to compare against

Returns:

• [Point] — the point on the circle closest to the given point

---

distance_from_point(point) → Numeric

Calculate the closest distance between a given point and the circle

Parameters:

• point [Point] — the point to compare against

Returns:

• [Numeric] — the closest distance between the point and any point on the circle

---

get_chord_angle_by_length(length) → Angle

Get the chord angle defined by the length of the chord

Parameters:

• length [Numeric] — the length of the chord

Returns:

• [Angle] — the angle defining the chord

---

get_chord_length_by_angle(angle) → Numeric

Get the length of a specific chord on the Circle

Parameters:

• angle [Angle] — the angle defining the chord

Returns:

• [Numeric] — the length of the specified chord

---

get_chord_length_by_nsegs(nsegs) → Numeric

Get the length of a specific chord on the Circle

Parameters:

• nsegs [?Numeric] — the number of equidistance segments defining the chord

Returns:

• [Numeric] — the length of the specified chord

---

get_chord_points_by_len(length, direction, first_angle)

Get a set of chord points on a circle

Parameters:

• length [Numeric] — the length of each chord
• direction [Symbol] — the direction of travel around the circle { :cw, :ccw }
• first_angle [Angle] — the angle on the circle to start at

---

get_chord_points_by_n(npts) → Array<Point>

Get a number of equidistant points around a circle beginning at a specified angle

Parameters:

• npts [Integer] — the number of points around the circle to get

Returns:

• [Array<Point>] — an array of Points around the Circle

---

get_point(angle) → Point

Get a point on the circle at a given angle from the center

Parameters:

• angle [Angle] — the angle from center where the point is located

Returns:

• [Point] — the point on the circle

---

get_tangent_line_between_circles(circle, connection) → Line

Calculate the tangent lines which can connect two circles

Parameters:

• circle [Circle] — the circle to connect with
• connection [Symbol] — the type of connection { :cwcw, :ccwccw, :cwccw, :ccwcw }

Returns:

• [Line] — one of the tangent lines between the circles, or nil if there is no connection

---

get_tangent_vectors(bearing) → Hash<Line>

Get tangent vectors at a specific point on a circle

Parameters:

• bearing [Angle] — the bearing from center defining the point's location

Returns:

• [Hash<Line>] — the two tangent vectors emanating from the point

---

intersection_with_circle(circle) → Hash

Calculate the intersection point(s) with a given circle

Parameters:

• circle [Circle] — the circle to compare against

Returns:

• [Hash] — the point(s) and bearing(s) which intersect, or one of { :infinite, :outside }

---

intersection_with_line(line) → Array<Point>

Calculate the intersection point(s) with a given line

Parameters:

• line [Line] — the line to compare against

Returns:

• [Array<Point>] — the point(s) which intersect, or the symbol :outside

---

is_point_inside?(point) → Boolean

Is a given point inside the circle

Parameters:

• point [Point] — the point to compare against

Returns:

• [Boolean] — true if the point is inside or on the circle

---

to_s → String

String conversion method

Returns:

• [String] — the string representation of the circle

---

Class: Cartesia::HexCoordinateSystem

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/hexcoordinatesystem.rb	Ruby	Kenneth F. Guerin	Copyright © 2022-2024, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(cpoint, size, granularity, orientation)

Parameters:

• cpoint [Point] — the center point of the hexagon in the outside coordinate system
• size [Numeric] — the edge-to-edge size of the hexagon
• granularity [Numeric] — the number of coordinates along the e-axis from the center point to each edge
• orientation [Symbol] — whether the hexagon is wide or tall <default: :wide>

---

Method Details

coord_delta(e, v, contrain) → Array<Numeric>   <private>

Calculate the delta point at the specified hex-based coordinate

Parameters:

• e [Integer] — the e-coordinate value
• v [Integer] — the v-coordinate value
• contrain [Integer] — check coordinate value constraints <default: false>

Returns:

• [Array<Numeric>] — the x-delta / y-delta pair

---

each

Iterate across all points in the hex coordinate system, along the edge-axis first

---

each_point_along_edge_axis(e)

Iterate along the specified edge-axis

Parameters:

• e [Numeric] — the e-coordinate to iterate along

---

is_constrained?(e, v) → Boolean   <private>

Check the constraint of the e,v (edge,vertex) coordinate pair

Parameters:

• e [Integer] — the e-coordinate value
• v [Integer] — the v-coordinate value

Returns:

• [Boolean] — whether the e,v coordinate pair is constrained to the hex area

---

is_edge_point?(pt) → Boolean

Is the given point on the outside edge of the hexagon

Parameters:

• pt [Point] — the point to check

Returns:

• [Boolean] — true if the given point is on the outside edge of the hexagon

---

nv_at_e(e) → Integer

Calculate the number of coordinates along the v-axis at a specified e-coordinate

Parameters:

• e [Integer] — the e-coordinate value

Returns:

• [Integer] — the number of v-coordinates along the v-axis at e

---

point_at(pt, constrain) → Point

Calculate the point within a hex under on a specified HCS point

Parameters:

• pt [Point] — the HCS coordinate point within the hex coordinate system
• constrain [Boolean] — whether the coordinate should be constrained to the hex area <default: true>

Returns:

• [Point] — the calculated point at some offset from the hexagon's center point

---

rotated_point(pt, segments) → Point

Calculate a new HCS point from a specified HCS point rotated N 60-degree segments clockwise around the center

Parameters:

• pt [Point] — the original HCS coordinate
• segments [Integer] — the number of 60-degree segments to rotate the point clockwise

Returns:

• [Point] — the rotated HCS coordinate

---

Class: Cartesia::HexGeometry

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/hexgeometry.rb	Ruby	Kenneth F. Guerin	Copyright © 2022-2024, Kenneth F. Guerin, all rights reserved.

Overview

Class Method Registry

Class Method Details

ee2vv(size) → Numeric

Calculate the hexagon's vertex-to-vertex size from its edge-to-edge size

Parameters:

• size [Numeric] — the hexagon's edge-to-edge size

Returns:

• [Numeric] — the vertex-to-vertex size of the hexagon

---

get_vertex_offsets(size) → Array<Numeric>

Return a list of the 3 hex vertex offset values from the center point. The first offset value is the e-axis offset to the flat edge. The second offset value is the v-axis offset to the vertex aligned with the center point. The third offset value is the v-axis offset to the other vertices.

Parameters:

• size [Numeric] — the hexagon's edge-to-edge size

Returns:

• [Array<Numeric>] — the hexagon's vertex offsets

---

vv2ee(size) → Numeric

Calculate the hexagon's edge-to-edge size from its vertex-to-vertex size

Parameters:

• size [Numeric] — the hexagon's edge-to-edge size

Returns:

• [Numeric] — the vertex-to-vertex size of the hexagon

---

Class: Cartesia::Hexagon

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/polygon.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved. Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(cpoint, size, orientation)

Parameters:

• cpoint [Numeric] — the center point of the hexagon
• size [Numeric] — the (flat) edge-to-edge size of the hexagon
• orientation [] — the orientation of the hexagon

---

Method Details

height → Numeric

Returns:

• [Numeric] — the height of the hexagon

---

width → Numeric

Returns:

• [Numeric] — the width of the hexagon

---

Class: Cartesia::Line

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/line.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(options)

Parameters:

• options [Hash] — the initial parameters of the line

---

Method Details

closest_intersection_point_from_point(point, force_infinite) → Point

Calculate the closest intersection point on a line to a given point.

Parameters:

• point [Point] — the point to intersect with
• force_infinite [Boolean] — ignore vector/segment line length limits

Returns:

• [Point] — a point on a line closest to the given point

---

distance_from_point(point) → Numeric

Calculate the closest distance between a line to a given point.

Parameters:

• point [Point] — the point to intersect with

Returns:

• [Numeric] — the closest distance to the given point

---

intersection_point(line) → Point] the intersection point, or nil if no intersection can occur, or [Line

Calculate the intersection point between two lines.

Parameters:

• line [Line] — the line to intersect with

Returns:

• [Point] the intersection point, or nil if no intersection can occur, or [Line] — self if the lines coincide

---

length → Number

Return the length of the line segment.

Returns:

• [Number] — the length of the line segment

---

point_at_dx(dx) → Point] the intersection point, or nil if no intersection can occur, or [Line

Calculate the intersection point on a line where the point is some horizontal distance from the reference point.

Parameters:

• dx [Numeric] — the horizontal delta distance

Returns:

• [Point] the intersection point, or nil if no intersection can occur, or [Line] — self if the lines coincide

---

point_at_dy(dy) → Point] the intersection point, or nil if no intersection can occur, or [Line

Calculate the intersection point on a line where the point is some vertical distance from the reference point.

Parameters:

• dy [Numeric] — the vertical delta distance

Returns:

• [Point] the intersection point, or nil if no intersection can occur, or [Line] — self if the lines coincide

---

point_at_x(x) → Point] the intersection point, or nil if no intersection can occur, or [Line

Calculate the intersection point on a line where the point is at some specific horizontal location.

Parameters:

• x [Numeric] — the x-coordinate

Returns:

• [Point] the intersection point, or nil if no intersection can occur, or [Line] — self if the lines coincide

---

point_at_y(y) → Point] the intersection point, or nil if no intersection can occur, or [Line

Calculate the intersection point on a line where the point is at some specific vertical location.

Parameters:

• y [Numeric] — the y-coordinate

Returns:

• [Point] the intersection point, or nil if no intersection can occur, or [Line] — self if the lines coincide

---

split → Array<Line>

Create an array of two vectors from an infinite line.

Returns:

• [Array<Line>] — the two new vectors

---

to_ary → Array<Numeric>

Array conversion method.

Returns:

• [Array<Numeric>] — an array representation of the Line

---

to_s → String

String conversion method.

Returns:

• [String] — a string representation of the Line

---

Class: Cartesia::Point

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/point.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(x, y)

The class initializer.

Parameters:

• x [Numeric] — the x coordinate of the point
• y [Numeric] — the y coordinate of the point

---

Method Details

!=(point) → Boolean

Inequality comparison method.

Parameters:

• point [Point] — the point to compare against

Returns:

• [Boolean] — true if the points are not at the same location

---

==(point) → Boolean

Equality comparison method.

Parameters:

• point [Point] — the point to compare against

Returns:

• [Boolean] — true if the points are at the same location

---

bearing_from(point) → Angle

Calculate the bearing from another point to this point.

Parameters:

• point [Point] — the point to measure against

Returns:

• [Angle] — the bearing from another point to this point

---

bearing_to(point) → Angle

Calculate the bearing from this point to another point.

Parameters:

• point [Point] — the point to measure against

Returns:

• [Angle] — the bearing from this point to another point

---

distance_from(point) → Numeric

Calculate the distance between two points.

Parameters:

• point [Point] — the point to measure against

Returns:

• [Numeric] — the distance between two points

---

dxy_to(point) → Array<Numeric>

Calculate the xy distance between two points.

Parameters:

• point [Point] — the point to measure against

Returns:

• [Array<Numeric>] — the dx and dy distances between two points

---

move_to!(distance, bearing) → Point

Move this point to a new location based on distance and bearing.

Parameters:

• distance [Numeric] — the distance to move the point
• bearing [Angle] — the bearing to move the point

Returns:

• [Point] — the current Point instance

---

new_point_from(distance, bearing) → Point

Create a new point based on this point moved to a new location based on distance and bearing.

Parameters:

• distance [Numeric] — the distance to move the point
• bearing [Angle] — the bearing to move the point

Returns:

• [Point] — the created Point instance

---

new_point_rotated_from(point, angle) → Point

Create a new point rotated around an origin point by a bearing delta.

Parameters:

• point [Point] — the point to move the current point around
• angle [Angle] — the delta bearing to rotate the point

Returns:

• [Point] — the created Point instance

---

new_point_using_dxy(dx, dy) → Point

Create a new point based on this point moved to a new location based on dx & dy distances.

Parameters:

• dx [Numeric] — the distance to move the point along the x-axis
• dy [Numeric] — the distance to move the point along the y-axis

Returns:

• [Point] — the created Point instance

---

rotate_around!(point, angle) → Point

Rotate the point around an origin point by a bearing delta.

Parameters:

• point [Point] — the point to move the current point around
• angle [Angle] — the delta bearing to rotate the point

Returns:

• [Point] — the current Point instance

---

set(x, y) → Point

Sets the Point location.

Parameters:

• x [Numeric] — the x coordinate of the new location
• y [Numeric] — the y coordinate of the new location

Returns:

• [Point] — the current Point instance

---

to_ary → Array<Numeric>

Array conversion method.

Returns:

• [Array<Numeric>] — an array representation of the Point

---

to_s → String

String conversion method.

Returns:

• [String] — a string representation of the Point

---

Class: Cartesia::Polygon

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/cartesia/polygon.rb	Ruby	Kenneth F. Guerin	Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved. Copyright © 2020-2022, Kenneth F. Guerin, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new(points)

Parameters:

• points [Array<Point>] — the points of the polygon

---

Method Details

append_point(point) → Polygon

Append a single point to the polygon.

Parameters:

• point [Point] — the new point of the polygon

Returns:

• [Polygon] — the current Polygon instance

---

append_points(points) → Polygon

Append a set of points to the polygon.

Parameters:

• points [Array<Point>] — the new points of the polygon

Returns:

• [Polygon] — the current Polygon instance

---

closest_intersection_point_from_point(point) → Point

Calculate the closest intersection point between a given point and the polygon.

Parameters:

• point [Point] — the point to check against

Returns:

• [Point] — the point on the polygon closest to the given point

---

delete_point_at(index) → Polygon

Delete a single point within the polygon.

Parameters:

• index [Integer] — the insertion point within the polygon point list

Returns:

• [Polygon] — the current Polygon instance

---

distance_from_point(point) → Numeric

Calculate the closest distance between a given point and the polygon.

Parameters:

• point [Point] — the point to check against

Returns:

• [Numeric] — the closest distance between the polygon and the given point

---

gen_line_segments → Array<Line>   <private>

Generate the line segments of a polygon from the given points.

Returns:

• [Array<Line>] — the array of line segments

---

insert_point(point, index) → Polygon

Insert a single point within the polygon.

Parameters:

• point [Point] — the new point of the polygon
• index [Integer] — the insertion point within the polygon point list

Returns:

• [Polygon] — the current Polygon instance

---

insert_points(points, index) → Polygon

Insert a set of points within the polygon.

Parameters:

• points [Array<Point>] — the new points of the polygon
• index [Integer] — the insertion point within the polygon point list

Returns:

• [Polygon] — the current Polygon instance

---

is_point_inside?(point) → Boolean

Calculates whether a given point is within the area enclosed by a polygon.

Parameters:

• point [Point] — the point to check

Returns:

• [Boolean] — true if the point is within the polygon area

---

pt_distance_info(point) → Array   <private>

Calculate closest point and distance information between a point and the polygon.

Parameters:

• point [Point] — the point to check

Returns:

• [Array] — a mixed type 2-element array containing the intersection point and the distance to it

---

to_s → String

String conversion method.

Returns:

• [String] — the string representation of the polygon

---

Class: Cartesia

File Manifest

File Manifest

File	Language	Author(s)	Copyright
ext/cartesia/singletons.c	CRuby	Kenneth F. Guerin	Copyright © 2020-2022 Kenneth F. Guerin, All rights reserved.

Overview

Singleton Registry

Singleton Details

clamp_angle(radians) → Numeric

Parameters:

• radians [Numeric] — the angle measurement in radians

Returns:

• [Numeric] — the clamped angle measurement in radians

---

clamp_angle_to_pi(radians) → Numeric

Parameters:

• radians [Numeric] — the angle measurement in radians

Returns:

• [Numeric] — the clamped angle measurement in radians

---

d2r(d) → Numeric

Parameters:

• d [Numeric] — the angle measurement in degrees

Returns:

• [Numeric] — the angle measurement in radians

---

d2s(d) → Numeric

Parameters:

• d [Numeric] — the angle measurement in degrees

Returns:

• [Numeric] — the angle measurement in sectons

---

distance_from(pt1, pt2) → Array<Numeric>

Parameters:

• pt1 [Array<Numeric>] — the first point, defined as a 2-dimensional array of coordinate points (x,y)
• pt2 [Array<Numeric>] — the second point, defined as a 2-dimensional array of coordinate points (x,y)

Returns:

• [Array<Numeric>] — the distance between the two points

---

dxybearing(dx, dy) → Numeric

Parameters:

• dx [Numeric] — the x-coordinate distance between two points
• dy [Numeric] — the y-coordinate distance between two points

Returns:

• [Numeric] — the angle from one point to the next measured in radians

---

dxydab(dx, dy) → Array<Numeric>

Parameters:

• dx [Numeric] — the x-coordinate distance between two points
• dy [Numeric] — the y-coordinate distance between two points

Returns:

• [Array<Numeric>] — the 2-dimensional array containing the distance and bearing between the two points

---

dxydistance(dx, dy) → Numeric

Parameters:

• dx [Numeric] — the x-coordinate distance between two points
• dy [Numeric] — the y-coordinate distance between two points

Returns:

• [Numeric] — the distance between the two points

---

r2d(r) → Numeric

Parameters:

• r [Numeric] — the angle measurement in radians

Returns:

• [Numeric] — the angle measurement in degrees

---

r2s(r) → Numeric

Parameters:

• r [Numeric] — the angle measurement in radians

Returns:

• [Numeric] — the angle measurement in sectons

---

s2d(s) → Numeric

Parameters:

• s [Numeric] — the angle measurement in sectons

Returns:

• [Numeric] — the angle measurement in degrees

---

s2r(s) → Numeric

Parameters:

• s [Numeric] — the angle measurement in sectons

Returns:

• [Numeric] — the angle measurement in radians

---

Namespace: Cartesia

File Manifest

File Manifest

File	Language	Author(s)	Copyright
angle.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
arc.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
bezier.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
cartesia.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
catenary.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
chainwrap.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
circle.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
hexCoordinateSystem.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2025, Brick Mill Games, LLC, all rights reserved.
hexGeometry.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
hexMapInfo.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
line.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
point.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.
polygon.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constant Registry

Function Registry

Constant Details

Cartesia.CCW   <read-only>

Cartesia.CCWCCW   <read-only>

Cartesia.CCWCW   <read-only>

Cartesia.CUBIC   <read-only>

Cartesia.CW   <read-only>

Cartesia.CWCCW   <read-only>

Cartesia.CWCW   <read-only>

Cartesia.DEGREES   <read-only>

Cartesia.INFINITE   <read-only>

Cartesia.INSIDE   <read-only>

Cartesia.LINE_INFINITE   <read-only>

Cartesia.LINE_SEGMENT   <read-only>

Cartesia.LINE_VECTOR   <read-only>

Cartesia.OUTSIDE   <read-only>

Cartesia.QUADRATIC   <read-only>

Cartesia.RAD0   <read-only>

Cartesia.RAD180   <read-only>

Cartesia.RAD270   <read-only>

Cartesia.RAD360   <read-only>

Cartesia.RAD45   <read-only>

Cartesia.RAD90   <read-only>

Cartesia.RADIANS   <read-only>

Cartesia.SEC0   <read-only>

Cartesia.SEC180   <read-only>

Cartesia.SEC270   <read-only>

Cartesia.SEC360   <read-only>

Cartesia.SEC45   <read-only>

Cartesia.SEC90   <read-only>

Cartesia.SECTONS   <read-only>

Cartesia.TALL   <read-only>

Cartesia.WIDE   <read-only>

Function Details

Cartesia.bearingFrom(ax, ay, bx, by) → Number

This function computes the distance & bearing (angle) between two points given their x,y coordinates.

Parameters:

• ax [Number] — the x-coordinate of the first point
• ay [Number] — the y-coordinate of the first point
• bx [Number] — the x-coordinate of the second point
• by [Number] — the y-coordinate of the second point

Returns:

• [Number] — the bearing between the two points in radians

---

Cartesia.bezierCurveLength(bezier) → Number

This function returns the length of the bezier curve.

Parameters:

• bezier [Object or Array<Number>] — the bezier curve representation

Returns:

• [Number] — the bezier curve length

---

Cartesia.bezierGetEPoints(intervals, bezier, callback) → Array<Number>

This function returns a list of evenly-spaced points along a bezier curve or calls a procedure for each point calculated. The callback's parameters are (nth,value) where nth is the index of the point and the value is the coordinate pair of the point.

Parameters:

• intervals [Integer] — the number of points to return
• bezier [Object or Array<Number>] — the bezier curve representation
• callback [Function] — a function to call as each point is calculated <default: null>

Returns:

• [Array<Number>] — the coordinates of each point as a coordinate list, if no callback was specified

---

Cartesia.bezierGetTPoints(intervals, bezier, callback) → Array<Number>

This function returns a list of timed points along a bezier curve or calls a procedure for each point calculated. The callback's parameters are (nth,value) where nth is the index of the point and the value is the coordinate pair of the point.

Parameters:

• intervals [Integer] — the number of points to return
• bezier [Object or Array<Number>] — the bezier curve representation
• callback [Function] — a function to call as each point is calculated <default: null>

Returns:

• [Array<Number>] — the coordinates of each point as a coordinate list, if no callback was specified

---

Cartesia.bezierHullLength(bezier) → Number

This function returns the hull length of the bezier curve.

Parameters:

• bezier [Object or Array<Number>] — the bezier curve representation

Returns:

• [Number] — the hull length of the bezier curve

---

Cartesia.chordAngle(radius, length) → Number

This function calculates the angle of a chord of a given length of a circle of a given radius.

Parameters:

• radius [Number] — the radius of the circle
• length [Number] — the length of the chord

Returns:

• [Number] — the angle of the chord in radians

---

Cartesia.chordLength(radius, angle) → Number

This function calculates the chord length of a circle of a given radius and angle between two points on the circle.

Parameters:

• radius [Number] — the radius of the circle
• angle [Number] — the angle, in radians, between two points on the circle

Returns:

• [Number] — the length of the chord

---

Cartesia.clampAngle(radians) → Number

This function ensures a radian angle measurement will be between 0° and 360°.

Parameters:

• radians [Number] — the angle measurement in radians

Returns:

• [Number] — the angle measurement in radians clamped between 0 and 2π

---

Cartesia.clampAngleToPI(radians) → Number

This function ensures a radian angle measurement will be between -180° and 180°.

Parameters:

• radians [Number] — the angle measurement in radians

Returns:

• [Number] — the angle measurement in radians clamped between -π and π

---

Cartesia.cp2pt(cp) → Cartesia.Point

This function creates a Cartesia.Point object from a coordinate pair.

Parameters:

• cp [Array<Number>] — the 2-element coordinate pair

Returns:

• [Cartesia.Point] — the Cartesia.Point object

---

Cartesia.cpv2pts(cpv) → Array<Cartesia.Point> or Null

This function creates an array of Cartesia.Point objects from an array of coordinates.

Parameters:

• cpv [Array<Number>] — the even-sized array of coordinates

Returns:

• [Array<Cartesia.Point> or Null] — the array of Cartesia.Point objects

---

Cartesia.d2angle(d) → Cartesia.Angle

This function creates a Cartesia.Angle object with a size in degrees.

Parameters:

• d [Number] — the size of the angle in degrees

Returns:

• [Cartesia.Angle] — the Cartesia.Angle object

---

Cartesia.d2r(r) → Number

This function converts degrees to radians.

Parameters:

• r [Number] — the angle measurement in degrees

Returns:

• [Number] — the angle measurement in radians

---

Cartesia.d2s(r) → Number

This function converts degrees to sectons.

Parameters:

• r [Number] — the angle measurement in degrees

Returns:

• [Number] — the angle measurement in sectons

---

Cartesia.dabFrom(ax, ay, bx, by) → Array<Number>

This function computes the bearing (angle) between two points given their x,y coordinates.

Parameters:

• ax [Number] — the x-coordinate of the first point
• ay [Number] — the y-coordinate of the first point
• bx [Number] — the x-coordinate of the second point
• by [Number] — the y-coordinate of the second point

Returns:

• [Array<Number>] — the distance & bearing between the two points, the latter in radians

---

Cartesia.distanceFrom(ax, ay, bx, by) → Number

This function computes the distance between two points given their x,y coordinates.

Parameters:

• ax [Number] — the x-coordinate of the first point
• ay [Number] — the y-coordinate of the first point
• bx [Number] — the x-coordinate of the second point
• by [Number] — the y-coordinate of the second point

Returns:

• [Number] — the direct distance between two points

---

Cartesia.dxyBearing(dx, dy) → Number

This function computes the bearing (angle) between two points given their dx and dy distances.

Parameters:

• dx [Number] — the x-axis distance between two points
• dy [Number] — the y-axis distance between two points

Returns:

• [Number] — the bearing between the two points in radians

---

Cartesia.dxyDAB(dx, dy) → Array<Number>

This function computes the distance & bearing (angle) between two points given their dx and dy distances.

Parameters:

• dx [Number] — the x-axis distance between two points
• dy [Number] — the y-axis distance between two points

Returns:

• [Array<Number>] — the distance & bearing between the two points, the latter in radians

---

Cartesia.dxyDistance(dx, dy) → Number

This function computes the distance between two points given their dx and dy distances.

Parameters:

• dx [Number] — the x-axis distance between two points
• dy [Number] — the y-axis distance between two points

Returns:

• [Number] — the direct distance between two points

---

Cartesia.ensureAngle(angle) → Cartesia.Angle ⇏ ArgumentError

This function is used throughout Cartesia to normalize angle representations to Cartesia.Angle object(s).

Parameters:

• angle [Cartesia.Angle or Number] — the angle argument as a Cartesia.Angle object or a measurement in radians

Returns:

• [Cartesia.Angle] — the Cartesia.Angle object to work on

Throws:

• [ArgumentError] — if the angle representation is invalid.

---

Cartesia.ensurePoint(point) → Cartesia.Point ⇏ ArgumentError

This function is used throughout Cartesia to normalize point representations to Cartesia.Point object(s).

Parameters:

• point [Variadic] — a point representation (see Cartesia.Point documentation)

Returns:

• [Cartesia.Point] — the Cartesia.Point object to work on

Throws:

• [ArgumentError] — if the point representation is invalid.

---

Cartesia.ensurePoints(pt) → Array<Cartesia.Point> ⇏ ArgumentError

This function is used throughout Cartesia to normalize multiple point representations to Cartesia.Point object(s).

Parameters:

• pt [Array<Cartesia.Point> or Array<Number>] — the points argument as an array of Cartesia.Points or as an even-length array of coordinates

Returns:

• [Array<Cartesia.Point>] — the Cartesia.Point objects to work on

Throws:

• [ArgumentError] — if the points representation is invalid.

---

Cartesia.findCircleArcOrigin(r, x1, y1, x2, y2, large_arc_flag, sweep_flag) → Array<Number>

This function calculates the origin of a circle given an arc described using endpoints, the circle's radius, whether it's a large arc and its sweep direction.

Parameters:

• r [Number] — the radius of the circle
• x1 [Number] — the x-coordinate of the first end point
• y1 [Number] — the y-coordinate of the first end point
• x2 [Number] — the x-coordinate of the second end point
• y2 [Number] — the y-coordinate of the second end point
• large_arc_flag [Boolean] — true, if the arc goes "the long way around" between the two end points
• sweep_flag [Boolean] — true, if the arc direction is counter-clockwise

Returns:

• [Array<Number>] — the x,y coordinates of the circle's origin

---

Cartesia.getOrbitPoints(radius, n, cx, cy, first_angle)

This function calculates equidistant points along a circular path at a given radius and number of points

Parameters:

• radius [Number] — the radius of the circle
• n [Number] — the number of equidistant points to calculate
• cx [Number] — the x-coordinate of the center or origin point
• cy [Number] — the y-coordinate of the center or origin point
• first_angle [Number] — the starting angle

---

Cartesia.getPointCoords(point) → Array<Number> ⇏ ArgumentError

This function is used to get x,y coordinates regardless of point representation.

Parameters:

• point [Variadic] — a point representation (see Cartesia.Point documentation)

Returns:

• [Array<Number>] — an array containing the x,y coordinates

Throws:

• [ArgumentError] — if the point representation is invalid or unrecognized

---

Cartesia.getRadialPoints(radius, angles, cx, cy) ⇏ ArgumentError

This function calculates points along a circlar path at a given radius and at given angles

Parameters:

• radius [Number] — the radius of the circle
• angles [Array<Number>] — the angles from the origin point where the points are to be calculated
• cx [Number] — the x-coordinate of the center or origin point
• cy [Number] — the y-coordinate of the center or origin point

Throws:

• [ArgumentError] — if the angles representation is invalid or unrecognized

---

Cartesia.getRadians(angle) → Number ⇏ ArgumentError

This function gets a radian measurement from a variety of angle representations.

Parameters:

• angle [Variadic] — the angle representation (see Cartesia.Angle documentation)

Returns:

• [Number] — the radian measurement of the angle

Throws:

• [ArgumentError] — if the angle representation is invalid or unrecognized

---

Cartesia.getSpokePoints(radius, n, width, cx, cy, first_angle)

This function calculates points along a circular path at a given radius and number of spokes and width of each spoke

Parameters:

• radius [Number] — the radius of the circle
• n [Number] — the number of equidistant points to calculate to pin the center of each spoke
• width [Number] — the width of each spoke
• cx [Number] — the x-coordinate of the center or origin point
• cy [Number] — the y-coordinate of the center or origin point
• first_angle [Number] — the starting angle

---

Cartesia.newLineSegment(reference, endpt) → Cartesia.Line

This function creates a new Cartesia.Line object which is a line segment composed of two points.

Parameters:

• reference [Cartesia.Point] — the starting point of the line segment
• endpt [Cartesia.Point] — the end point of the line segment

Returns:

• [Cartesia.Line] — the Cartesia.Line object

---

Cartesia.newRect(point, width, height) → Cartesia.Polygon

This function creates a new Cartesia.Polygon object which is a rectangle of a given size.

Parameters:

• point [Cartesia.Point] — the location of the rectangle
• width [Number] — the width of the rectangle
• height [Number] — the height of the rectangle

Returns:

• [Cartesia.Polygon] — the Cartesia.Polygon object

---

Cartesia.newSquare(point, size) → Cartesia.Polygon

This function creates a new Cartesia.Polygon object which is a square of a given size.

Parameters:

• point [Cartesia.Point] — the location of the square
• size [Number] — the size of the square

Returns:

• [Cartesia.Polygon] — the Cartesia.Polygon object

---

Cartesia.pointBetween(ax, ay, bx, by, ratio) → Array<Number>

This function computes the location of a point which is a proportional distance between the two given points.

Parameters:

• ax [Number] — the x-coordinate of the first point
• ay [Number] — the y-coordinate of the first point
• bx [Number] — the x-coordinate of the second point
• by [Number] — the y-coordinate of the second point
• ratio [Number] — the percentage, as a value from 0.0 to 1.0, from the first point along a line to the second point <default: 0.5>

Returns:

• [Array<Number>] — the x,y coordinates of the point in between

---

Cartesia.pointFrom(x, y, d, b) → Array<Number>

This function computes the point which is a distance and bearing from the given point, given its x,y coordinates.

Parameters:

• x [Number] — the x-coordinate of the point
• y [Number] — the y-coordinate of the point
• d [Number] — the distance the second point will be from the given point
• b [Number] — the bearing, in radians, the second point will be from the given point

Returns:

• [Array<Number>] — the x,y coordinates of the second point

---

Cartesia.r2angle(r) → Cartesia.Angle

This function is used throughout Cartesia to normalize angle representations to Cartesia.Angle object(s).

Parameters:

• r [Number] — the size of the angle in radians

Returns:

• [Cartesia.Angle] — the Cartesia.Angle object

---

Cartesia.r2d(r) → Number

This function converts radians to degrees.

Parameters:

• r [Number] — the angle measurement in radians

Returns:

• [Number] — the angle measurement in degrees

---

Cartesia.r2s(r) → Number

This function converts radians to sectons.

Parameters:

• r [Number] — the angle measurement in radians

Returns:

• [Number] — the angle measurement in sectons

---

Cartesia.rotatedPointFrom(ax, ay, bx, by, db) → Array<Number>

This function computes the location of a point which is a distance and bearing from the first point and based on a second point moving radially by a given angle.

Parameters:

• ax [Number] — the x-coordinate of the first point
• ay [Number] — the y-coordinate of the first point
• bx [Number] — the x-coordinate of the second point
• by [Number] — the y-coordinate of the second point
• db [Number] — the delta angular measurement, in radians

Returns:

• [Array<Number>] — the x,y coordinates of the third point

---

Cartesia.s2angle(s) → Cartesia.Angle

This function creates a Cartesia.Angle object with a size in sectons.

Parameters:

• s [Number] — the size of the angle in sectons

Returns:

• [Cartesia.Angle] — the Cartesia.Angle object

---

Cartesia.s2d(s) → Number

This function converts sectons to degrees.

Parameters:

• s [Number] — the angle measurement in sectons

Returns:

• [Number] — the angle measurement in degrees

---

Cartesia.s2r(s) → Number

This function converts sectons to radians.

Parameters:

• s [Number] — the angle measurement in sectons

Returns:

• [Number] — the angle measurement in radians

---

Cartesia.u2r(m, uom) → Number ⇏ ArgumentError

This function converts a given angular measurement into radians.

Parameters:

• m [Number] — the number of units
• uom [Symbol] — one of { Cartesia.RADIANS,Cartesia.DEGREES,Cartesia,SECTONS } <default: Cartesia.RADIANS>

Returns:

• [Number] — the angular measurement in radians

Throws:

• [ArgumentError] — if the unit of measurement is unrecognized

---

Cartesia.xy2pt(x, y) → Cartesia.Point

This function creates a Cartesia.Point object from x,y coordinates.

Parameters:

• x [Number] — the x-coordinate of the point
• y [Number] — the y-coordinate of the point

Returns:

• [Cartesia.Point] — the Cartesia.Point object

---

Class: Cartesia.Angle

File Manifest

File Manifest

File	Language	Author(s)	Copyright
angle.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Property Registry

Method Registry

Constructor Details

new Cartesia.Angle(angle)

Parameters:

• angle [Variadic] — the initial value of the angle <default: 0.0>

---

Property Details

degrees

sections

Method Details

add(angle) → Cartesia.Angle

This method creates a new Cartesia.Angle by adding another angle to this angle.

Parameters:

• angle [Variadic] — the initial value of the angle <default: 0.0>

Returns:

• [Cartesia.Angle] — a new Cartesia.Angle object

---

add$(angle) → Cartesia.Angle

This method adds an angle to this one.

Parameters:

• angle [Variadic] — the initial value of the angle <default: 0.0>

Returns:

• [Cartesia.Angle] — itself

---

clone() → Cartesia.Angle

This function returns a new Cartesia.Angle with the same values.

Returns:

• [Cartesia.Angle] — the new Cartesia.Angle object

---

delta() → Cartesia.Angle

This method creates a new Cartesia.Angle which contains an angle which is represented as a difference measurement.

Returns:

• [Cartesia.Angle] — the new Cartesia.Angle object

---

delta$() → Cartesia.Angle

This method ensures that the angle is represented as a difference measurement.

Returns:

• [Cartesia.Angle] — itself

---

difference(angle) → Number

This method calculates the difference between this angle and another one, in radians.

Parameters:

• angle [Variadic] — the initial value of the angle <default: 0.0>

Returns:

• [Number] — the difference between the two angles

---

reflectAroundPI() → Cartesia.Angle

This method creates a new Cartesia.Angle which contains an angle which is a reflection between 0° and 180°.

Returns:

• [Cartesia.Angle] — the new Cartesia.Angle object

---

reflectAroundPI$() → Cartesia.Angle

This method ensures that the angle is reflection between 0° and 180°.

Returns:

• [Cartesia.Angle] — itself

---

reflectTowardZero() → Cartesia.Angle

This method creates a new Cartesia.Angle which contains an angle which is a reflection between 270° and 90° toward 0°.

Returns:

• [Cartesia.Angle] — the new Cartesia.Angle object

---

reflectTowardZero$() → Cartesia.Angle

This method ensures that the angle is reflected between 270° and 90° toward 0°.

Returns:

• [Cartesia.Angle] — itself

---

set(angle) → Cartesia.Angle

This method sets the angle's value.

Parameters:

• angle [Variadic] — the value of the angle to set <default: 0.0>

Returns:

• [Cartesia.Angle] — itself

---

toString() → String

This method returns a string representation of the angle.

Returns:

• [String] — the string representation

---

valueOf() → Number

This method returns the numerical value of the angle, in radians.

Returns:

• [Number] — the value of the angle, in radians

---

Class: Cartesia.Arc ← Cartesia.Circle

File Manifest

File Manifest

File	Language	Author(s)	Copyright
arc.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new Cartesia.Arc(center, radius, bearing_slice) ⇏ ArgumentError

Parameters:

• center [Number] — the center point location of the arc
• radius [Number] — the radius of the circle of which the arc is a subset
• bearing_slice [Array<Cartesia.Angle>] — the two angles that mark the end points of the arc

Throws:

• [ArgumentError] — if the bearing angle is invalid or unrecognized

---

Method Details

intersectionWithArc(arc) → Array<Cartesia.Point> or Symbol

This method determines the the intersection points between the arc and a given arc.

Parameters:

• arc [Cartesia.Circle] — the arc this arc will intersect with

Returns:

• [Array<Cartesia.Point> or Symbol] — the array of points where the arc intersects with this arc or a symbol denoting whether the arc is outside of this arc

---

intersectionWithCircle(circle) → Array<Cartesia.Point> or Symbol

This method determines the the intersection points between this arc and a given circle.

Parameters:

• circle [Cartesia.Circle] — the circle this arc will intersect with

Returns:

• [Array<Cartesia.Point> or Symbol] — the array of points where the circle intersects with this arc or a symbol denoting whether the circle is outside of this arc

---

intersectionWithLine(line) → Array<Cartesia.Point> or Symbol ⇏ ArgumentError

This method determines the points on an arc which intersect with the given line.

Parameters:

• line [Cartesia.Line] — the line this arc will intersect with

Returns:

• [Array<Cartesia.Point> or Symbol] — the array of points where the line intersects with this arc or a symbol denoting whether the line is outside of this arc

Throws:

• [ArgumentError] — if the line is invalid

---

toString() → String

This method returns a string representation of the arc.

Returns:

• [String] — the string representation

---

Class: Cartesia.Bezier

File Manifest

File Manifest

File	Language	Author(s)	Copyright
bezier.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Property Registry

Method Registry

Constructor Details

new Cartesia.Bezier(points) ⇏ ArgumentError

Parameters:

• points [Array<Cartesia.Point>] — the 3 points of a quadratic or the 4 points of a cubic bezier curve

Throws:

• [ArgumentError] — if the points are invalid or unrecognizable

---

Property Details

length

Method Details

ePoints(intervals, callback) → Array<Cartesia.Point>

This method either returns a list of equidistant-points or calls a procedure for each equidistant-point.

Parameters:

• intervals [Integer] — the number of equidistant points along the curve to collect, visit
• callback [Function] — the callback function to call for each equidistant point <default: null>

Returns:

• [Array<Cartesia.Point>] — if the equidistant points are being collected

---

isValid() → Boolean

This method determines if the bezier contains valid information

Returns:

• [Boolean] — true, if the type is Cartesia.QUADRATIC or Cartesia.CUBIC

---

tPoints(intervals, callback) → Array<Cartesia.Point>

This method either returns a list of time-points or calls a procedure for each time-point.

Parameters:

• intervals [Integer] — the number of time points along the curve to collect, visit
• callback [Function] — the callback function to call for each time point <default: null>

Returns:

• [Array<Cartesia.Point>] — if the time points are being collected

---

Class: Cartesia.Catenary

File Manifest

File Manifest

File	Language	Author(s)	Copyright
catenary.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Property Registry

Method Registry

Constructor Details

new Cartesia.Catenary(definition)

This constructor will define a catenary curve based on a factor a, where y = a at x = 0, if a chain will drop to its lowest point at x = 0. The equation y = a cosh(x/a) defines the curve. The factor 'a', can be explictly given or it can be derived from dx, dy and/or phi values. Only two of the three values of dx, dy or phi need be supplied to calculate 'a'.

Parameters:

• definition [Object] — the parameters of the catenary curve
• a [Cartesia.Point] — the anchor point
• dx [Number] — the x-axis distance between the anchor point and the lowest point of the curve
• dy [Number] — the y-axis distance between the anchor point and the lowest point of the curve
• phi [Number] — the angle of descent from the anchor point

---

Property Details

isTracking

Method Details

$calcAGivenDXPhi(dx, phi) → Number   <private>

This private method calculates 'a' based on the given dx and phi parameters.

Parameters:

• dx [Number] — the x-axis distance between the curve's anchor point and its end point
• phi [Number] — the curve's angle of departure from the anchor point

Returns:

• [Number] — the curve's a factor

---

$calcAGivenDyPhi(dy, phi) → Number   <private>

This private method calculates 'a' based on the given dy and phi parameters.

Parameters:

• dy [Number] — the y-axis distance between the curve's anchor point and its end point
• phi [Number] — the curve's angle of departure from the anchor point

Returns:

• [Number] — the curve's a factor

---

$calcAGivenDydx(dy, dx, prec) → Number   <private>

This private method calculates 'a' based on the given dx and dy parameters.

Parameters:

• dy [Number] — the y-axis distance between the curve's anchor point and its end point
• dx [Number] — the x-axis distance between the curve's anchor point and its end point
• prec [Number] — the calculation precision <default: 10>

Returns:

• [Number] — the curve's a factor

---

$ctTrackPoint(is_first, pt, distance, precision) → Cartesia.Point   <private>

This private method calculates the curve tracking points based on the procedure's current state

Parameters:

• is_first [Boolean] — true, if we are calculating the first point
• pt [Cartesia.Point] — the point we are calculating from
• distance [Number] — the distance away from the given point we are calculating for
• precision [Number] — the level of precision we are limiting the calculations to <default: Cartesia.CatenaryPrecision>

Returns:

• [Cartesia.Point] — the next point on the curve

---

ctFirst(point, distance_from) → Cartesia.Point ⇏ Error

This method gets the first point in the curve tracking operation.

Parameters:

• point [Cartesia.Point] — a starting point not part of the curve <default: null>
• distance_from [Number] — a distance from the specified point <default: null>

Returns:

• [Cartesia.Point] — the first point in the curve

Throws:

• [Error] — if the operation has not been started

---

ctNext(distance_from) → Cartesia.Point ⇏ Error

This method gets the next point in the curve tracking operation.

Parameters:

• distance_from [Number] — a distance from the current point <default: null>

Returns:

• [Cartesia.Point] — the next point in the curve

Throws:

• [Error] — if the operation has not been started

---

dxAtDY(dy) → Number

This method returns the dx value at a point dy from the anchor point.

Parameters:

• dy [Number] — the dy value

Returns:

• [Number] — the dx value

---

dyAtDX(dx) → Number

This method returns the dy value at a point dx from the anchor point.

Parameters:

• dx [Number] — the dx value

Returns:

• [Number] — the dy value

---

finishCurveTracking()

This method ends the current curve tracking operation.

---

phiAtDX(dx) → Number

This method returns the phi value at a point dx from the anchor point.

Parameters:

• dx [Number] — the dx value

Returns:

• [Number] — the phi value

---

phiAtDY(dy) → Number

This method returns the phi value at a point dy from the anchor point.

Parameters:

• dy [Number] — the dy value

Returns:

• [Number] — the phi value

---

sAtDX(dx) → Number

This method returns the s value at a point dx from the anchor point.

Parameters:

• dx [Number] — the dx value

Returns:

• [Number] — the s value

---

sAtDY(dy) → Number

This method returns the s value at a point dy from the anchor point.

Parameters:

• dy [Number] — the dy value

Returns:

• [Number] — the s value

---

startCurveTracking(anchor, dx, style, direction)

This method starts an iterative curve tracking operation between an anchor point and the end point.

Parameters:

• anchor [Cartesia.Point] — the anchor point of the curve
• dx [Number] — the dx distance
• style [Symbol] — the tracking methodology: { Cartesia.ByPX, Cartesia.ByNX, Cartesia.ByInvPX, Cartesia.ByInvNX }
• direction [Symbol] — the direction of the tracking: { Cartesia.A2E, Cartesia.E2A }

---

toString() → String

This method returns a string representation of the catenary curve object.

Returns:

• [String] — the string representation

---

Class: Cartesia.ChainWrap

File Manifest

File Manifest

File	Language	Author(s)	Copyright
chainwrap.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Property Registry

Method Registry

Constructor Details

new Cartesia.ChainWrap(bogies, style, link_properties, offset, catgrav_hints) ⇏ ArgumentError ⇏ Error

Parameters:

• bogies [Array<Object>] — the bogies of the tank tread
• type [Symbol] — the type of bogie: { Cartesia.DRIVE_BOGIE, Cartesia.ROAD_BOGIE, Cartesia.TOP_BOGIE, Cartesia.REAR_BOGIE, Cartesia.TENSION_BOGIE }
• cx [Number] — the x-coordinate of the center of the bogie
• cy [Number] — the y-coordinate of the center of the bogie
• r [Number] — the radius of the center of the bogie
• style [Symbol] — the style of chain wrapping: { Cartesia.TAUT, Cartesia.CATGRAV }
• link_properties [Object] — the properties of each link in the chain, tank tread
• thickness [Number] — the thickness of the link
• length [Number] — the length of the link <default: null>
• offset [Array<Number>] — <default: [ 0,0 ]>
• catgrav_hints [Object] — , if using Cartesia.CATGRAV style <default: null>

Throws:

• [ArgumentError] — if the style, link_properties or catgrav_hints are invalid or unrecognizable
• [Error] — if the link length is not given and cannot be calculated

---

Property Details

pathinfo

Method Details

$calcLinkLength(links_per_tooth) → Number   <private>

This private method determines the size of the link based on the size of the drive bogie and the number of links/tooth.

Parameters:

• links_per_tooth [Integer] — the number of links per tooth <default: 1>

Returns:

• [Number] — the link length

---

$makeCircleFromBogie(bogie) → Cartesia.Circle   <private>

This private method make a circle for a particular bogie based on the bogie's size and location and the overall offset and chain link size.

Parameters:

• bogie [Object] — the specified bogie

Returns:

• [Cartesia.Circle] — a circle describing the bogie

---

harvest(dbo) → Array<Cartesia.Point>

This method collects all of the points of the wrapped chain path around the bogies.

Parameters:

• dbo [Integer] — <default: 50>

Returns:

• [Array<Cartesia.Point>] — the collections of points making up the wrapped chain path

---

Class: Cartesia.Circle

File Manifest

File Manifest

File	Language	Author(s)	Copyright
circle.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new Cartesia.Circle(center, radius)

Parameters:

• center [Cartesia.Point] — the location of the center point of the circle
• radius [Number] — the radius of the circle

---

Method Details

boundingBox() → Cartesia.Polygon

This method returns the bounding box of the circle.

Returns:

• [Cartesia.Polygon] — the square which makes up the circle's bounding box

---

clone() → Cartesia.Circle

This method creates a new circle identical to this one.

Returns:

• [Cartesia.Circle] — the new circle

---

closestIntersectionPointFromPoint(point) → Cartesia.Point

This method determines the point on the circle which is closest to the specified point.

Parameters:

• point [Variadic] — the specified point

Returns:

• [Cartesia.Point] — the point on the circle closest to the specified point

---

distanceFromPoint(point) → Number

This method determines the distance from the point on the circle which is closest to the specified point.

Parameters:

• point [Variadic] — the specified point

Returns:

• [Number] — the distance between the point on the circle closest to the specified point

---

getChordAngleByLength(length) → Cartesia.Angle

This method returns the angle of the circle's chord as defined by its length.

Parameters:

• length [Number] — the chord length

Returns:

• [Cartesia.Angle] — the angle of the chord

---

getChordLengthByAngle(angle) → Number

This method returns the length of the circle's chord based on the angle separating the points from the center point.

Parameters:

• angle [Cartesia.Angle] — the angle separating the points and determining the chord's length

Returns:

• [Number] — the length of the chord

---

getChordLengthByNSegs(nsegs) → Number

This method returns the length of the circle's chord based a number of equidistant chords running around the circle.

Parameters:

• nsegs [Integer] — the number of segments used to define the size of each equidistant chord

Returns:

• [Number] — the length of the chord

---

getChordPointsByLength(length, direction, first_angle) → Array<Cartesia.Point>

This method returns the points on the circle which are a given chord length

Parameters:

• length [Number] — the chord length
• direction [Symbol] — the direction around the circle to travel <default: Cartesia.CW>
• first_angle [Variadic] — the angle from center where the first point will be located <default: 0.0>

Returns:

• [Array<Cartesia.Point>] — the calculated chord points around the circle

---

getChordPointsByN(npts, first_angle) → Array<Cartesia.Point> ⇏ ArgumentError

This method returns N points on a circle where they are equidistant from each other.

Parameters:

• npts [Integer] — the number of points to get
• first_angle [Cartesia.Angle] — the first angle where the first point will be <default: 0.0>

Returns:

• [Array<Cartesia.Point>] — the chord points on the circle

Throws:

• [ArgumentError] — if the specified angle is invalid or unrecognized

---

getPoint(angle) → Cartesia.Point

This method returns the point at the specified angle from the circle's center.

Parameters:

• angle [Cartesia.Angle] — the angle from the circle's center point

Returns:

• [Cartesia.Point] — the point on the circle at the specified angle from the center point

---

getTangentLineBetweenCircles(circle, connection) → Array<Cartesia.Line>

This method calculates the tangent lines between two circles based on rotation directions around the circles.

Parameters:

• circle [Cartesia.Circle] — the second circle the tangent lines will connect with
• connection [Symbol] — the rotation directions around the two circles

Returns:

• [Array<Cartesia.Line>] — the two tangential lines connecting the two circles

---

getTangentVectors(bearing) → Array<Cartesia.Line>

This method returns the two tangential lines at a point on the circle bearing at an angle from the center point.

Parameters:

• bearing [Cartesia.Angle] — the bearing from center

Returns:

• [Array<Cartesia.Line>] — the two tangential lines emanating from the chosen point

---

intersectionWithCircle(circle) → Array<Cartesia.Point> or Symbol ⇏ ArgumentError

This method determines the intersection points between a circle and another circle.

Parameters:

• circle [Cartesia.Circle] — the circle the circle will intersect with

Returns:

• [Array<Cartesia.Point> or Symbol] — the array of points where the line intersects with the circle or a symbol denoting whether the circle is inside or outside or on top of the circle

Throws:

• [ArgumentError] — if the circle is invalid

---

intersectionWithLine(line) → Array<Cartesia.Point> or Symbol ⇏ ArgumentError

This method determines the intersection points between a circle and a line.

Parameters:

• line [Cartesia.Line] — the line the circle will intersect with

Returns:

• [Array<Cartesia.Point> or Symbol] — the array of points where the line intersects with the circle or a symbol denoting whether the line is inside or outside of the circle

Throws:

• [ArgumentError] — if the line is invalid

---

isPointInside(point) → Boolean

This method is used to determine if a given point is inside the circle.

Parameters:

• point [Variadic] — the specified point

Returns:

• [Boolean] — true, if the point is inside the circle

---

toString() → String

This method returns a string representation of the circle.

Returns:

• [String] — the string representation

---

Class: Cartesia.HexCoordinateSystem

File Manifest

File Manifest

File	Language	Author(s)	Copyright
hexCoordinateSystem.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2025, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new Cartesia.HexCoordinateSystem(cpoint, size, granularity, orientation) ⇏ ArgumentError

Parameters:

• cpoint [Cartesia.Point] — the location of the center of the hexagon on the mapped surface
• size [Number] — the edge-to-edge size of the hexagon
• granularity [Number] — the spacing between points within the hexagon
• orientation [Cartesia.WIDE or Cartesia.TALL] — the orientation of the hexagon <default: Cartesia.WIDE>

Throws:

• [ArgumentError] — if the orientation is invalid or unrecognized

---

Method Details

$coordDelta(e, v, constrain) → Array<Number>   <private>

This private method converts the HCS coordinates to outside coordinates.

Parameters:

• e [Integer] — the coordinate point along the e-axis
• v [Integer] — the coordinate point along the v-axis
• constrain [Boolean] — whether the given point should be constrained within the hexagon

Returns:

• [Array<Number>] — the mapped coordinate from the HCS coordinate system to the outside coordinate system

---

$isConstrained(e, v) → Boolean   <private>

This private method determines if the given point, in e,v notation, is within the hexagon given the user space coordinate limits.

Parameters:

• e [Integer] — the coordinate point along the e-axis
• v [Integer] — the coordinate point along the v-axis

Returns:

• [Boolean] — true if the given point is within the hexagon

---

coordsAt(point, constrain) → Cartesia.Point

This method converts the hex coordinate point to the user space point.

Parameters:

• point [Variadic] — the point in the hex coordinate system
• constrain [Boolean] — true, if conversions outside of the hexagon are not allowed <default: true>

Returns:

• [Cartesia.Point] — the user space point

---

eachPoint(callback)

This method calls the supplied callback function for each point in the hexagon.

Parameters:

• callback [Function] — the callback function

---

eachPointAlongEdgeAxis(e, callback) ⇏ RangeError

This method calls a callback function for each point along a given edge-oriented axis.

Parameters:

• e [Integer] — the edge-oriented axis index with 0 running through the hex's center point
• callback [Function] — the function to call for each point

Throws:

• [RangeError] — if the e index is outside of the bounds of the granularity of the coordinate system

---

isConstrainedPoint(point) → Boolean

This method determines if a given point is constrained to the hex area.

Parameters:

• point [Variadic] — the point to check

Returns:

• [Boolean] — true if the point is within the hex area

---

isEdgePoint(point) → Boolean

This method determines if the given point is along the edge of the hexagon's coordinate system.

Parameters:

• point [Variadic] — the point of the coordinate system

Returns:

• [Boolean] — true, if the point is along any of the six edges

---

nvAtE(e) → Integer ⇏ RangeError

This method returns the number of coordinate points along a specified edge-axis row.

Parameters:

• e [Integer] — the edge-oriented axis index with 0 running through the hex's center point

Returns:

• [Integer] — the number of coordinate points along that axis

Throws:

• [RangeError] — if the e index is outside of the bounds of the granularity of the coordinate system

---

pointAt(point, constrain) → Cartesia.Point

This method converts the hex coordinate point to the user space point.

Parameters:

• point [Variadic] — the point in the hex coordinate system
• constrain [Boolean] — true, if conversions outside of the hexagon are not allowed <default: true>

Returns:

• [Cartesia.Point] — the user space point

---

rectangleCoordsAround(point, width, height, constrain) → Array<Array<Number>>

This convenience function will return the corner user space coordinates of a rectangle round a given center point.

Parameters:

• point [Variadic] — the center point of the rectangle
• width [Integer] — the integer width of the rectangle in user space units
• height [Integer] — the integer height of the rectangle in user space units
• constrain [Boolean] — true, if the rectangle's corners are not allowed outside the hexagon <default: true>

Returns:

• [Array<Array<Number>>] — the 4 coordinates of the rectangle, starting top-left and proceeding clockwise

---

rectanglePointsAround(point, width, height, constrain) → Array<Point>

This convenience function will return the corner user space coordinates of a rectangle round a given center point.

Parameters:

• point [Variadic] — the center point of the rectangle
• width [Integer] — the integer width of the rectangle in user space units
• height [Integer] — the integer height of the rectangle in user space units
• constrain [Boolean] — true, if the rectangle's corners are not allowed outside the hexagon <default: true>

Returns:

• [Array<Point>] — the 4 corner points of the rectangle, starting top-left and proceeding clockwise

---

rotatedCoord(point, segments) → Array<Number>

This method returns a point matching its location in one of the other five partitions of the hexagon.

Parameters:

• point [Variadic] — a point in the hex coordinate system
• segments [Integer] — the number of segments to rotate round in a clockwise direction

Returns:

• [Array<Number>] — the associated coord in the hex segment

---

rotatedPoint(point, segments) → Cartesia.Point

This method returns a point matching its location in one of the other five partitions of the hexagon.

Parameters:

• point [Variadic] — a point in the hex coordinate system
• segments [Integer] — the number of segments to rotate round in a clockwise direction

Returns:

• [Cartesia.Point] — the associated point in the hex segment

---

Class: Cartesia.HexCoordinateSystem.Path

File Manifest

File Manifest

File	Language	Author(s)	Copyright
hexCoordinateSystem.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2025, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new Cartesia.HexCoordinateSystem.Path(hcs, descriptor, constrained)

Parameters:

• hcs [Cartesia.HexCoordinateSystem] — the hex coordinate system to associate with the path
• descriptor [String] — the path string descriptor <default: null>
• constrained [Boolean] — if true, ensures the path is constrained to the hex area <default: true>

---

Method Details

$parse(descriptor) → Hash ⇏ RuntimeError   <private>

This method parses a proposed path descriptor and stores processing information for later use.

Parameters:

• descriptor [String] — the proposed path descriptor

Returns:

• [Hash] — tokenized path information, or null on failure

Throws:

• [RuntimeError] — on a parsing error

---

isConstrained() → Boolean

Returns:

• [Boolean] — true, if the current descriptor is valid

---

isValid() → Boolean

Returns:

• [Boolean] — true, if the current descriptor is valid

---

lastCoord() → Array<Number>

This method returns the last HCS coordinate in the path.

Returns:

• [Array<Number>] — the last HCS coordinate in the path

---

lastPoint() → Point

This method returns the last HCS point in the path.

Returns:

• [Point] — the last HCS point in the path

---

mirror(axis, clone) → Cartesia.HexCoordinateSystem.Path

This method either clones the current path and mirrors it or mirrors the current path descriptor in place.

Parameters:

• axis [String] — the x,y or z axis to mirror around <default: 'x'>
• clone [Boolean] — will return a cloned, rotated descriptor, if true <default: false>

Returns:

• [Cartesia.HexCoordinateSystem.Path] — this, or a cloned, Cartesia.HexCoordinateSystem.Path instance

---

normalized() → String

This method returns a string as a normalized path descriptor

Returns:

• [String] — the normalized path descriptor

---

render() → String

This method converts this path to a path descriptor that can be rendered onto the underlying surface.

Returns:

• [String] — the rendered path descriptor

---

renderAsPolygons() → Array<Hash>

This method converts this path to an array of polygon point arrays, if possible, null if not.

Returns:

• [Array<Hash>] — an array polygon information, each consisting of an array of points and a Boolean field stating if it is closed

---

reverse(post_process, clone) → Cartesia.HexCoordinateSystem.Path

This method either clones the current path and reverses it or reverses the current path descriptor in place.

Parameters:

• post_process [Boolean] — if true, will process the reverse path to convert tokens to use command options <default: false>
• clone [Boolean] — will return a cloned, rotated descriptor, if true <default: false>

Returns:

• [Cartesia.HexCoordinateSystem.Path] — this, or a cloned, Cartesia.HexCoordinateSystem.Path instance

---

rotate(segments, clone) → Cartesia.HexCoordinateSystem.Path

This method either clones the current path and rotates it or rotates the current path descriptor in place.

Parameters:

• segments [Integer] — the number of 60-degree clockwise rotations to make
• clone [Boolean] — will return a cloned, rotated descriptor, if true <default: false>

Returns:

• [Cartesia.HexCoordinateSystem.Path] — this, or a cloned, Cartesia.HexCoordinateSystem.Path instance

---

setConstrain(setting)

Parameters:

• setting [Boolean] — sets the constrain paremeter, reparses the descriptor if changing to true

---

setDescriptor(descriptor) → Boolean

This method sets a new path descriptor.

Parameters:

• descriptor [String] — the proposed path descriptor

Returns:

• [Boolean] — true, if the current descriptor is valid

---

toString() → String

This method converts the Cartesia.HexCoordinateSystem.Path to a string representation.

Returns:

• [String] — the string representation of the path.

---

Namespace: Cartesia.HexGeometry

File Manifest

File Manifest

File	Language	Author(s)	Copyright
hexGeometry.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Function Registry

Function Details

ee2vv(size) → Number

This function calculates the vector-to-vector size given the edge-to-edge size of a hexagon.

Parameters:

• size [Number] — the edge-to-edge hexagon size

Returns:

• [Number] — the vector-to-vector size of the hexagon

---

getTallVertexOffsetPoints(size, cx, cy, size) → Hash

This function calculates the vertex offsets from the center of the hexagon given its edge-to-edge size.

Parameters:

• size [Number] — the hexagon size
• cx [Number] — the x-coordinate of the hexagon center <default: 0.0>
• cy [Number] — the y-coordinate of the hexagon center <default: 0.0>
• size [Boolean] — true if the given size is edge-to-edge <default: true>

Returns:

• [Hash] — a hash containing size and vertex offset information

---

getVertexOffsetInfo(size, is_edge_size) → Hash

This function calculates the vertex offsets from the center of the hexagon given its edge-to-edge size.

Parameters:

• size [Number] — the hexagon size
• is_edge_size [Boolean] — true if the given size is edge-to-edge <default: true>

Returns:

• [Hash] — a hash containing size and vertex offset information

---

getVertexOffsets(size, is_edge_size) → Array<Number>

This function calculates the vertex offset dimensions given an edge-to-edge size.

Parameters:

• size [Number] — the edge-to-edge hexagon size
• is_edge_size [Boolean] — true if the given size is edge-to-edge <default: true>

Returns:

• [Array<Number>] — a 3-element array containing offsets: offset to the edges, offset to the extreme vertices, offset to the edge vertices

---

getWideVertexOffsetPoints(size, cx, cy, size) → Hash

This function calculates the vertex offsets from the center of the hexagon given its edge-to-edge size.

Parameters:

• size [Number] — the hexagon size
• cx [Number] — the x-coordinate of the hexagon center <default: 0.0>
• cy [Number] — the y-coordinate of the hexagon center <default: 0.0>
• size [Boolean] — true if the given size is edge-to-edge <default: true>

Returns:

• [Hash] — a hash containing size and vertex offset information

---

vv2ee(size) → Number

This function calculates the edge-to-edge size given the vector-to-vector size of a hexagon.

Parameters:

• size [Number] — the vector-to-vector hexagon size

Returns:

• [Number] — the edge-to-edge size of the hexagon

---

Class: Cartesia.HexMapInfo

File Manifest

File Manifest

File	Language	Author(s)	Copyright
hexMapInfo.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new Cartesia.HexMapInfo(cols, rows, hborder, vborder) ⇏ ArgumentError

Parameters:

• cols [Number] — the number of hexagon columns in the map
• rows [Number] — the number of hexagon rows in the map
• hborder [Number] — the size of the horizontal borders (top & bottom)
• vborder [Number] — the size of the vertical borders (left & right)

Throws:

• [ArgumentError] — if the orientation is invalid or unrecognizable

---

Method Details

$directionToInteger(direction) → Integer   <private>

This private method converts a valid wide hex edge direction string to an integer.

Parameters:

• direction [String] — the direction string descriptions

Returns:

• [Integer] — an integer ranging from 0 to 5, if valid, where 0 is north and proceeding clockwise, -1 if direction is invalid

---

bboxAt(hexcol, hexrow) → Object

This method returns the bounding box of the specified hex tile

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile

Returns:

• [Object] — the bounding box of the hex tile

---

buildHexPathDescriptor(params) → Array<Hash>

This method returns an array of hex path segment information.

Parameters:

• params [Hash] — the hex path parameters

Returns:

• [Array<Hash>] — an array of hashes, each containing information required to create one segment of the hex path

---

calcHexPathBounds(params) → Hash

This method hexcol-based bounds information to aid in hex-in-region detection logic

Parameters:

• params [Hash] — the hex region parameters

Returns:

• [Hash] — a hash containing bounds values by hexcol

---

coordAt(hexcol, hexrow) → Object

This method returns the center point of the specified hex tile

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile

Returns:

• [Object] — the center point of the hex tile with an x property and a y property

---

draw(callback)

This method uses a callback function to draw the hex map for each hex.

Parameters:

• callback [Function] — the function to call initialization and hex drawing operations

---

formatHexPathDescriptor(desc, formatter, needs_bbox) → Hash ⇏ ArgumentError

This method converts a hex path descriptor to a different type of data set.

Parameters:

• desc [Array<Hash>] — the hex path descriptor
• formatter [Hash] — a hash containing keyed functions to handle conversion functions
• needs_bbox [Boolean] — true, if the caller wants bounding box information calculated and returned <default: false>

Returns:

• [Hash] — a hash containing the type of data returned as well as a path description in the format defined by the type

Throws:

• [ArgumentError] — if the descriptor is invalid, or the type is invalid

---

getAdjacentTiles(hexcol, hexrow) → Array<Hash or Null>] the coordinates of the six adjacent hex tiles, in order of [ col,row-1

This method returns an array of hex tile coordinates of the six adjacent hex tiles.

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile

Returns:

• [Array<Hash or Null>] the coordinates of the six adjacent hex tiles, in order of [ col,row-1 ] — and progressing clockwise

---

getAlignment(hexcol, hexrow, hexcol2, hexrow2) → Hash or Null

This method determines if two hexes are aligned with each other along the six hexrow directions

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile
• hexcol2 [Number] — the hex column of the second hex tile
• hexrow2 [Number] — the hex row of the second hex tile

Returns:

• [Hash or Null] — the direction and distance of the aligned hex from the first to the second hex, or Null if not aligned

---

getSpineAlignment(hexcol, hexrow, hexcol2, hexrow2, extended) → Hash or Null

This method determines if two hexes are aligned with each other along the two horizontal or six hex-spine directions

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile
• hexcol2 [Number] — the hex column of the second hex tile
• hexrow2 [Number] — the hex row of the second hex tile
• extended [Boolean] — if true, calculates alignment along the non-horizontal hex-spine directions

Returns:

• [Hash or Null] — the direction and distance of the aligned hex from the first to the second hex, or Null if not aligned

---

hcsFor(hexcol, hexrow, granularity) → Cartesia.HexCoordinateSystem

This method returns a hex coordinate system tied to a specific hex map tile.

Parameters:

• hexcol [Number] — the hex column of the map tile
• hexrow [Number] — the hex row of the map tile
• granularity [Integer] — the granularity of the coordinate system

Returns:

• [Cartesia.HexCoordinateSystem] — a CoordinateSystem tied to that specific hex map tile

---

hexesAway(hexcol, hexrow, to_hexcol, to_hexrow) → Number

This method returns the number of hexes away one hex tile is from another

Parameters:

• hexcol [Number] — the hex column of the origin hex tile
• hexrow [Number] — the hex row of the origin hex tile
• to_hexcol [Number] — the hex column of the distant hex tile
• to_hexrow [Number] — the hex row of the distant hex tile

Returns:

• [Number] — the number of hexes the distant hex tile is from the origin tile

---

hextantsAway(hexcol, hexrow, to_hexcol, to_hexrow) → Array<String>] the hextant locations of the distant hex tile from the origin: [ 'nw','w','sw','ne','e','se'

This method returns the hextants where one hex tile is from another

Parameters:

• hexcol [Number] — the hex column of the origin hex tile
• hexrow [Number] — the hex row of the origin hex tile
• to_hexcol [Number] — the hex column of the distant hex tile
• to_hexrow [Number] — the hex row of the distant hex tile

Returns:

• [Array<String>] the hextant locations of the distant hex tile from the origin: [ 'nw','w','sw','ne','e','se' ] —

---

isAdjacent(hexcol, hexrow, hexcol2, hexrow2) → Integer

This method determines if two hexes are adjacent to each other

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile
• hexcol2 [Number] — the hex column of the second hex tile
• hexrow2 [Number] — the hex row of the second hex tile

Returns:

• [Integer] — the direction of the adjacent from the first to the second hex, or -1 if not adjacent

---

makeCirclePath(params, needs_bbox) → Hash

This method returns a circular path description based on the incoming single-hex hex region parameters.

Parameters:

• params [Hash] — the hex region parameters
• needs_bbox [Boolean] — true, if the caller wants bounding box information calculated and returned <default: false>

Returns:

• [Hash] — a hash containing the center coordinate of the hex and the path descriptor relative to that point.

---

makeHexPath(params, needs_bbox) → Hash

This method returns a hex path description based on the incoming hex region parameters.

Parameters:

• params [Hash] — the hex region parameters
• needs_bbox [Boolean] — true, if the caller wants bounding box information calculated and returned <default: false>

Returns:

• [Hash] — a hash containing the center coordinate of the hex and the path descriptor relative to that point.

---

makeHexPathCoords(params, needs_bbox) → Hash

This method returns a hex path description based on the incoming hex region parameters.

Parameters:

• params [Hash] — the hex region parameters
• needs_bbox [Boolean] — true, if the caller wants bounding box information calculated and returned <default: false>

Returns:

• [Hash] — a hash containing the center coordinate of the hex and the path descriptor relative to that point.

---

makePathInHex(params, needs_bbox) → Hash

This method returns a circular path description based on the incoming single-hex hex region parameters.

Parameters:

• params [Hash] — the hex region parameters
• needs_bbox [Boolean] — true, if the caller wants bounding box information calculated and returned <default: false>

Returns:

• [Hash] — a hash containing the center coordinate of the hex and the path descriptor relative to that point.

---

mapdims() → Array<Number>

This method returns the map dimensions.

Returns:

• [Array<Number>] — the width and height of the map returned as a 2-element array

---

nearestHexTo(point) → Object

This method returns the nearest hex tile to a given point

Parameters:

• point [Variadic] — the specified point

Returns:

• [Object] — the nearest hex tile as a JS object with row, column and dir properties

---

traceHexPathDescriptor(params, debug) → Array<Hash>

This method returns an array of hex path segment information.

Parameters:

• params [Hash] — the hex path parameters
• debug [Number] — debug level <default: 0>

Returns:

• [Array<Hash>] — an array of hashes, each containing information required to create one segment of the hex path

---

visitNextTile(hexcol, hexrow, direction, unclipped) → Array<Hash> or Null

This method returns the next tile in a given direction.

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile
• direction [String or Number] — the direction to visit
• unclipped [Boolean] — allow off-map visiting of virtual tiles, if true <default: false>

Returns:

• [Array<Hash> or Null] — an array of hex tile coordinates, or null if a callback function was specified

---

visitTiles(hexcol, hexrow, n, direction, callback) → Array<Hash> or Null

This method returns an array of hex tile coordinates ranging n hexes out in a given direction and including the target tile.

Parameters:

• hexcol [Number] — the hex column of the hex tile
• hexrow [Number] — the hex row of the hex tile
• n [Number] — the number of tiles to visit, limited by the map edges
• direction [String or Number] — the direction to visit
• callback [Function or Null] — the callback function to call for each hex tile visited

Returns:

• [Array<Hash> or Null] — an array of hex tile coordinates, or null if a callback function was specified

---

Class: Cartesia.Hexagon ← Cartesia.Polygon

File Manifest

File Manifest

File	Language	Author(s)	Copyright
polygon.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Property Registry

Constructor Details

new Cartesia.Hexagon(cpoint, size, orientation)

This constructor creates a new hexagon.

Parameters:

• cpoint [Cartesia.Point] — the location of the center of the hexagon
• size [Number] — the edge-to-edge size of the hexagon
• orientation [Cartesia.WIDE or Cartesia.TALL] — the orientation of the hexagon <default: Cartesia.WIDE>

---

Property Details

height

width

Class: Cartesia.Line

File Manifest

File Manifest

File	Language	Author(s)	Copyright
line.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Property Registry

Method Registry

Constructor Details

new Cartesia.Line(options) ⇏ ArgumentError

This constructor will build a Cartesia.Line object based on input criteria.

Parameters:

• options [Object] — the line parameters, specifying options for the three types of lines
• from [Variadic] — the starting point in a line segment
• to [Variadic] — the end point in a line segment
• reference [Variadic] — the starting point in a line vector or a reference point in an infinite line
• bearing [Variadic] — the angle defining the slope of the line vector
• slope [Variadic] — the angle defining the slope of the line vector

Throws:

• [ArgumentError] — if the options inputs are invalid or unrecognizable

---

Property Details

length

Method Details

clone() ⇏ Error

This method will build a new Cartesia.Line object identical to the current line

Throws:

• [Error] — if the current line is invalid

---

closestIntersectionPointFromPoint(point, force_infinite) → Cartesia.Point

This method finds the point on a line closest to a given point.

Parameters:

• point [Variadic] — the point to calculate the distance from
• force_infinite [Boolean] — an option to treat the line as an infinite line, regardless of type

Returns:

• [Cartesia.Point] — the point on the line which is closest to the specified point

---

distanceFromPoint(point) → Number

This method finds distance of a given point to the line at its closest point.

Parameters:

• point [Variadic] — the point to calculate the distance from

Returns:

• [Number] — the distance to the given point

---

intersectionPoint(line) → Cartesia.Line or Cartesia.Point or Null ⇏ ArgumentError

This method finds a point where two lines intersect, if they do.

Parameters:

• line [Cartesia.Line] — the line to compare against

Returns:

• [Cartesia.Line or Cartesia.Point or Null] — the intersection point if a point is found, null if not, or itself if the lines are identical

Throws:

• [ArgumentError] — if the given argument is not a line

---

pointAtDX(dx) → Cartesia.Point or Null

This method finds the point on a line at a distance from the line's reference point in the x-direction.

Parameters:

• dx [Number] — the distance from the line's reference point in the y-direction

Returns:

• [Cartesia.Point or Null] — the point on the line, if able to be calculated

---

pointAtDY(dy) → Cartesia.Point or Null

This method finds the point on a line at a distance from the line's reference point in the y-direction.

Parameters:

• dy [Number] — the distance from the line's reference point in the y-direction

Returns:

• [Cartesia.Point or Null] — the point on the line, if able to be calculated

---

pointAtX(x) → Cartesia.Point or Null

This method finds the point on a line at a specific x-coordinate.

Parameters:

• x [Number] — the x-coordinate

Returns:

• [Cartesia.Point or Null] — the point on the line, if able to be calculated

---

pointAtY(y) → Cartesia.Point or Null

This method finds the point on a line at a specific y-coordinate.

Parameters:

• y [Number] — the x-coordinate

Returns:

• [Cartesia.Point or Null] — the point on the line, if able to be calculated

---

set(options) → Cartesia.Line ⇏ ArgumentError

This method will build a Cartesia.Line object based on input criteria.

Parameters:

• options [Object] — the line parameters, specifying options for the three types of lines
• from [Variadic] — the starting point in a line segment
• to [Variadic] — the end point in a line segment
• reference [Variadic] — the starting point in a line vector or a reference point in an infinite line
• bearing [Variadic] — the angle defining the slope of the line vector
• slope [Variadic] — the angle defining the slope of the line vector

Returns:

• [Cartesia.Line] — itself

Throws:

• [ArgumentError] — if the options inputs are invalid or unrecognizable

---

split() → Array<Cartesia.Line> ⇏ TypeError

This method splits an infinite line into two vectors at its reference point.

Returns:

• [Array<Cartesia.Line>] — the two line vectors split at the infinite line's reference point

Throws:

• [TypeError] — if the line is not an infinite line

---

toArray() → Array<Number>

This method converts a line to a N-element array of reference points and the line's end point, if a segment, or bearing, if not.

Returns:

• [Array<Number>] — the array of information

---

toString() → String

This method converts a line to a string representation.

Returns:

• [String] — a string representation of the line

---

Class: Cartesia.Point

File Manifest

File Manifest

File	Language	Author(s)	Copyright
point.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Property Registry

Method Registry

Constructor Details

new Cartesia.Point(point) ⇏ ArgumentError

Parameters:

• point [Variadic] — the initial value of the point <default: 0,0>

Throws:

• [ArgumentError] — if the point representation is invalid or unrecognized

---

Property Details

x

y

Method Details

bearingFrom(point) → Cartesia.Angle ⇏ ArgumentError

This method calculates the bearing of a specified point from this point.

Parameters:

• point [Variadic] — the point away from this point <default: 0,0>

Returns:

• [Cartesia.Angle] — the bearing of the specified point from this point

Throws:

• [ArgumentError] — if the point representation is invalid or unrecognized

---

bearingTo(point) → Cartesia.Angle ⇏ ArgumentError

This method calculates the bearing of this point from a specified point.

Parameters:

• point [Variadic] — the point away from this point <default: 0,0>

Returns:

• [Cartesia.Angle] — the bearing of this point from the specified point

Throws:

• [ArgumentError] — if the point representation is invalid or unrecognized

---

clone() → Cartesia.Point

This function returns a new Cartesia.Point with the same values.

Returns:

• [Cartesia.Point] — the new Cartesia.Point object

---

distanceFrom(point) → Number ⇏ ArgumentError

This method calculates the distance between this point and a specified point.

Parameters:

• point [Variadic] — the point away from this point <default: 0,0>

Returns:

• [Number] — the distance between the points

Throws:

• [ArgumentError] — if the point representation is invalid or unrecognized

---

dxyTo(point) → Array<Number> ⇏ ArgumentError

This method calculates the dx,dy distances from this point to a specified point.

Parameters:

• point [Variadic] — the point away from this point <default: 0,0>

Returns:

• [Array<Number>] — the 2-element array of dx,dy distances between the points

Throws:

• [ArgumentError] — if the point representation is invalid or unrecognized

---

moveTo$(distance, bearing) → Cartesia.Point ⇏ ArgumentError

This method move this point to a new location some distance and bearing from its current location.

Parameters:

• distance [Number] — the distance to move this point from its current location
• bearing [Cartesia.Angle or Number] — the directional bearing from this point to move itself

Returns:

• [Cartesia.Point] — itself

Throws:

• [ArgumentError] — if the point or angle representation is invalid or unrecognized

---

newPointFrom(distance, bearing) → Cartesia.Point

This method creates a new point some distance and bearing from this point.

Parameters:

• distance [Number] — the distance from its current location
• bearing [Cartesia.Angle or Number] — the directional bearing from this point

Returns:

• [Cartesia.Point] — the new Cartesia.Point

---

newPointRotatedFrom(angle, point) → Cartesia.Point ⇏ ArgumentError

This method creates a new point some radial distance around another point by a specified angle.

Parameters:

• angle [Cartesia.Angle or Number] — the angle argument as a Cartesia.Angle object or a measurement in radians
• point [Variadic] — the point away from this point <default: 0,0>

Returns:

• [Cartesia.Point] — ths new Cartesia.Point

Throws:

• [ArgumentError] — if the point or angle representation is invalid or unrecognized

---

newPointUsingDXY(dx, dy) → Cartesia.Point

This method creates a new point some dx,dy distance from this point.

Parameters:

• dx [Number] — the dx distance
• dy [Number] — the dy distance

Returns:

• [Cartesia.Point] — the new Cartesia.Point

---

rotateAround$(angle, point) → Cartesia.Point ⇏ ArgumentError

This method moves this point around another point by a specified angle.

Parameters:

• angle [Cartesia.Angle or Number] — the angle argument as a Cartesia.Angle object or a measurement in radians
• point [Variadic] — the point away from this point <default: 0,0>

Returns:

• [Cartesia.Point] — itself

Throws:

• [ArgumentError] — if the point or angle representation is invalid or unrecognized

---

set(point) → Cartesia.Point ⇏ ArgumentError

This method sets the point's value.

Parameters:

• point [Variadic] — the value of the point to set <default: 0,0>

Returns:

• [Cartesia.Point] — itself

Throws:

• [ArgumentError] — if the point representation is invalid or unrecognized

---

toArray() → Array<Number>

This method converts this point to a coordinate array.

Returns:

• [Array<Number>] — the coordinate array

---

toString() → String

This method converts the point to a string representation.

Returns:

• [String] — the string representation of the point.

---

Class: Cartesia.Polygon

File Manifest

File Manifest

File	Language	Author(s)	Copyright
polygon.js	Javascript	Kenneth F. Guerin	Copyright © 2018-2024, Brick Mill Games, LLC, all rights reserved.

Overview

Constructor Registry

Method Registry

Constructor Details

new Cartesia.Polygon(points) ⇏ ArgumentError

This constructor creates a new polygon based on the supplied points, in order of connection.

Parameters:

• points [Array<Cartesia.Point>] — the points which make up the polygon

Throws:

• [ArgumentError] — if the supplied points vector is invalid

---

Method Details

$ptDistanceInfo(point) → Variadic ⇏ ArgumentError   <private>

This private method calculates the point and distance between a given point and the polygon

Parameters:

• point [Cartesia.Point] — the point to compare against

Returns:

• [Variadic] — a 2-element array containing the point on the polygon which is closest and the distance between those points

Throws:

• [ArgumentError] — if the given point is invalid

---

appendPoint(point) → Cartesia.Polygon ⇏ ArgumentError

This method appends a point to the polygon's point list.

Parameters:

• point [Array<Cartesia.Point>] — the point to append to the polygon

Returns:

• [Cartesia.Polygon] — itself

Throws:

• [ArgumentError] — if the supplied points vector is invalid

---

appendPoints(points) → Cartesia.Polygon ⇏ ArgumentError

This method appends points to the polygon's point list.

Parameters:

• points [Array<Cartesia.Point>] — the points to append to the polygon

Returns:

• [Cartesia.Polygon] — itself

Throws:

• [ArgumentError] — if the supplied points vector is invalid

---

boundingBox() → Cartesia.Polygon

This method returns the bounding box of the polygon.

Returns:

• [Cartesia.Polygon] — the bounding box rectangle containing the polygon

---

closestIntersectionPointFromPoint(point) → Cartesia.Point

This method finds the point on the polygon closest to the specified point.

Parameters:

• point [Cartesia.Point] — the reference point to determining the closest point to

Returns:

• [Cartesia.Point] — the closest point of the polygon to the reference point

---

deletePointAt(index) → Cartesia.Polygon ⇏ ArgumentError

This method deletes a point from the polygon.

Parameters:

• index [Integer] — the zero-based index of the point of the polygon to delete

Returns:

• [Cartesia.Polygon] — itself

Throws:

• [ArgumentError] — if the index is invalid

---

distanceFromPoint(point) → Number

This method finds the closest distance between a given point and any point of the polygon.

Parameters:

• point [Cartesia.Point] — the reference point to determining the closest point to

Returns:

• [Number] — the closest distance to the point

---

insertPoint(point, index) → Cartesia.Polygon ⇏ ArgumentError

This method inserts a point into the polygon list at the specified location.

Parameters:

• point [Array<Cartesia.Point>] — the point to insert into the polygon
• index [Integer] — the zero-based index of the point of the polygon to delete

Returns:

• [Cartesia.Polygon] — itself

Throws:

• [ArgumentError] — if the supplied points vector is invalid

---

insertPoints(points, index) → Cartesia.Polygon ⇏ ArgumentError

This method inserts points to the polygon's point list at the specified location.

Parameters:

• points [Array<Cartesia.Point>] — the points to insert into the polygon
• index [Integer] — the zero-based index of the point of the polygon to delete

Returns:

• [Cartesia.Polygon] — itself

Throws:

• [ArgumentError] — if the supplied points vector is invalid

---

isPointInside(point) → Boolean ⇏ ArgumentError

This method determines if a given point is inside the polygon.

Parameters:

• point [Cartesia.Point] — the point we are checking for

Returns:

• [Boolean] — true, if the point is inside the polygon

Throws:

• [ArgumentError] — if the point is invalid

---

lineSegments() → Array<Cartesia.Line>

This method returns the array of line segments which will make up the polygon.

Returns:

• [Array<Cartesia.Line>] — the array of line segments

---

set(points) → Cartesia.Polygon ⇏ ArgumentError

This constructor creates a new polygon based on the supplied points, in order of connection.

Parameters:

• points [Array<Cartesia.Point>] — the points which make up the polygon

Returns:

• [Cartesia.Polygon] — itself

Throws:

• [ArgumentError] — if the supplied points vector is invalid

---

toString() → String

This method returns a string represention of the polygon.

Returns:

• [String] — the string representation

---

Class: Codoc

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.
lib/codoc/emitter.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.
lib/codoc/emitters/dokuwiki.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.
lib/codoc/emitters/html.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.
lib/codoc/emitters/reporter.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.
lib/codoc/fblock.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.
lib/codoc/gblock.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.
lib/codoc/languages/c.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.
lib/codoc/languages/cruby.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.
lib/codoc/languages/js.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.
lib/codoc/languages/ruby.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.
lib/codoc/lblock.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.
lib/codoc/logger.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.
lib/codoc/parser.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.
lib/codoc/tag.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.

Overview

Class Method Registry

Class Method Details

do(-arglist-)

This method is used to parse, report and generate documentation.

Parameters:

• -arglist- [Hash] — the processing parameters
• type [Symbol] — the type of codoc object to process
• item [Symbol] — the type of codoc object to process
• options [Hash] — the type of codoc object to process
• verbose [Boolean] — the verbosity of the operation <default: false>
• as [Symbol] — the type of documentation to generate if the parsing is successful
• folder [String] — the type of documentation to generate if the parsing is successful
• basename [String] — the type of documentation to generate if the parsing is successful

---

Class: Codoc::CParser

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/languages/c.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::CRubyParser

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/languages/cruby.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::DokuWikiEmitter

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/emitters/dokuwiki.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::Emitter

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/emitter.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.

Overview

Class Constant Registry

Class Constant Details

CMAP

---

Class: Codoc::FBlock

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/fblock.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::GBlock

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/gblock.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::HTMLEmitter

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/emitters/html.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::JSParser

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/languages/js.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::LBlock

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/lblock.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::Logger

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/logger.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::Parser

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/parser.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.

Overview

Class Constant Registry

Class Constant Details

CMAP

---

EXTMAP

---

HINT_TAGS

---

Class: Codoc::Reporter

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/emitters/reporter.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::RubyParser

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/languages/ruby.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2025, Kenneth F. Guerin, all rights reserved.

Overview

Class: Codoc::Tag

File Manifest

File Manifest

File	Language	Author(s)	Copyright
lib/codoc/tag.rb	Ruby	Kenneth F. Guerin	Copyright © 2021-2022, Kenneth F. Guerin, all rights reserved.

Overview