Rac. Ray

# | source: src/drawable/Ray.js, line 34

Unbounded ray from a Point in direction of an Angle.

instance.Ray

Instances of Rac contain a convenience rac.Ray function to create Ray objects from primitive values. This function also contains ready-made convenience objects, like rac.Ray.xAxis, listed under instance.Ray.

Example
let rac = new Rac()
let point = rac.Point(55, 77)
let angle = rac.Angle(1/4)
// new instance with constructor
let ray = new Rac.Ray(rac, point, angle)
// or convenience function
let otherRay = rac.Ray(55, 77, 1/4)
See also:

Constructor

new Ray(rac, start, angle)

# | source: src/drawable/Ray.js, line 34

Creates a new Ray instance.

Parameters:
Name Type Description
rac Rac

Instance to use for drawing and creating other objects
start Rac.Point

A Point where the ray starts
angle Rac.Angle

An Angle the ray is directed to

Members

angle :Rac.Angle

# | source: src/drawable/Ray.js, line 65

The angle towards which the ray extends.

rac :Rac

# | source: src/drawable/Ray.js, line 53

Instance of Rac used for drawing and passed along to any created object.

start :Rac.Point

# | source: src/drawable/Ray.js, line 59

The start point of the ray.

Methods

angleToPoint(point) → {Rac.Angle}

# | source: src/drawable/Ray.js, line 308

Returns the angle from this.start to point.

When this.start and point are considered equal, returns this.angle.

See also:
Parameters:
Name Type Description
point Rac.Point

A Point to measure the angle to

arc(radius, endAngleopt, clockwiseopt) → {Rac.Arc}

# | source: src/drawable/Ray.js, line 566

Returns a new Arc with center at this.start, start at this.angle and the given arc properties.

Parameters:
Name Type Attributes Default Description
radius Number

The radius of the new Arc
endAngle Rac.Angle | Number <optional>
 null

The end Angle of the new Arc; when null or ommited, this.angle is used instead
clockwise Boolean <optional>
 true

The orientation of the new Arc

arcToAngleDistance(radius, angleDistance, clockwiseopt) → {Rac.Arc}

# | source: src/drawable/Ray.js, line 588

Returns a new Arc with center at this.start, start at this.angle, and end at the given angleDistance from this.start in the clockwise orientation.

Parameters:
Name Type Attributes Default Description
radius Number

The radius of the new Arc
angleDistance Rac.Angle | Number

The angle distance from this.start to the new Arc end
clockwise Boolean <optional>
 true

The orientation of the new Arc

distanceToProjectedPoint(point) → {Number}

# | source: src/drawable/Ray.js, line 442

Returns the distance from this.start to the projection of point onto the ray.

The resulting distance is positive when the projected point is towards the direction of the ray, and negative when it is behind.

Parameters:
Name Type Description
point Rac.Point

A Point to project and measure the distance to

equals(otherRay) → {Boolean}

# | source: src/drawable/Ray.js, line 99

Returns true when start and angle in both rays are equal; otherwise returns false.

When otherRay is any class other that Rac.Ray, returns false.

See also:
Parameters:
Name Type Description
otherRay Rac.Ray

A Ray to compare

inverse() → {Rac.Ray}

# | source: src/drawable/Ray.js, line 233

Returns a new Ray pointing towards angle.inverse().

perpendicular(clockwiseopt) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 248

Returns a new Ray pointing towards the perpendicular angle of angle in the clockwise orientation.

See also:
Parameters:
Name Type Attributes Default Description
clockwise Boolean <optional>
 true

The orientation of the perpendicular

pointAtCanvasEdge() → (nullable) {Rac.Point}

# | source: src/p5Drawer/Ray.functions.js, line 20

Returns a new Point located where the ray touches the canvas edge.

When the ray is outside the canvas and pointing away, returns null since no point in the canvas is possible.

Added to Rac.Ray.prototype when Rac.P5Drawer is setup as rac.drawer.

pointAtDistance(distance) → {Rac.Point}

# | source: src/drawable/Ray.js, line 378

Returns a new Point in the ray at the given distance from this.start. When distance is negative, the new Point is calculated in the inverse direction of angle.

Parameters:
Name Type Description
distance Number

The distance from this.start

pointAtIntersection(otherRay) → {Rac.Point}

# | source: src/drawable/Ray.js, line 394

Returns a new Point at the intersection of this and otherRay.

When the rays are parallel, returns null since no intersection is possible.

Both rays are considered unbounded lines.

Parameters:
Name Type Description
otherRay Rac.Ray

A Ray to calculate the intersection with

pointAtX(x) → {Rac.Point}

# | source: src/drawable/Ray.js, line 323

Returns a new Point located in the ray where the x coordinate is x. When the ray is vertical, returns null since no single point with x coordinate at x is possible.

The ray is considered a unbounded line.

Parameters:
Name Type Description
x Number

The x coordinate to calculate a point in the ray

pointAtY(y) → {Rac.Point}

# | source: src/drawable/Ray.js, line 351

Returns a new Point located in the ray where the y coordinate is y. When the ray is horizontal, returns null since no single point with y coordinate at y is possible.

The ray is considered an unbounded line.

Parameters:
Name Type Description
y Number

The y coordinate to calculate a point in the ray

pointOrientation(point) → {Boolean}

# | source: src/drawable/Ray.js, line 476

Returns true when the angle to the given point is located clockwise of the ray or false when located counter-clockwise.

  • When this.start and point are considered equal or point lands on the ray, it is considered clockwise. When point lands on the inverse of the ray, it is considered counter-clockwise.
See also:
Parameters:
Name Type Description
point Rac.Point

A Point to measure the orientation to

pointProjection(point) → {Rac.Point}

# | source: src/drawable/Ray.js, line 424

Returns a new Point at the projection of point onto the ray. The projected point is the closest possible point to point.

The ray is considered an unbounded line.

Parameters:
Name Type Description
point Rac.Point

A Point to project onto the ray

rayAtCanvasEdge() → (nullable) {Rac.Ray}

# | source: src/p5Drawer/Ray.functions.js, line 42

Returns a new Ray that starts at the point where the this touches the canvas edge and pointed towards the inside of the canvas.

When the ray is outside the canvas and pointing away, returns null since no point in the canvas is possible.

Added to Rac.Ray.prototype when Rac.P5Drawer is setup as rac.drawer.

rayToPoint(point) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 499

Returns a new Ray from this.start to point.

When this.start and point are considered equal, the new Ray will use this.angle.

See also:
Parameters:
Name Type Description
point Rac.Point

A Point to point the Ray towards

segment(length) → {Rac.Segment}

# | source: src/drawable/Ray.js, line 510

Returns a new Segment using this and the given length.

Parameters:
Name Type Description
length Number

The length of the new Segment

segmentToIntersection(otherRay) → {Rac.Segment}

# | source: src/drawable/Ray.js, line 547

Returns a new Segment starting at this.start and ending at the intersection of this and otherRay.

When the rays are parallel, returns null since no intersection is possible.

When this.start and the intersection point are considered equal, the new Segment will use this.angle.

Both rays are considered unbounded lines.

Parameters:
Name Type Description
otherRay Rac.Ray

A Ray to calculate the intersection with

segmentToPoint(point) → {Rac.Segment}

# | source: src/drawable/Ray.js, line 526

Returns a new Segment from this.start to point.

When this.start and point are considered equal, the new Segment will use this.angle.

See also:
Parameters:
Name Type Description
point Rac.Point

A Point to point the Segment towards

slope() → (nullable) {Number}

# | source: src/drawable/Ray.js, line 113

Returns the slope of the ray, or null if the ray is vertical.

In the line formula y = mx + b the slope is m.

text(string, formatopt) → {Rac.Text}

# | source: src/drawable/Ray.js, line 671

Returns a new Text located at start and oriented towards angle with the given string and format.

When format is provided, the angle for the resulting Text will still be set to angle.

Parameters:
Name Type Attributes Default Description
string String

The string of the new Text
format Rac.Text.Format <optional>
 rac.Text.Format.topLeft

The format of the new Text

toString(digitsopt) → {String}

# | source: src/drawable/Ray.js, line 80

Returns a string representation intended for human consumption.

Parameters:
Name Type Attributes Default Description
digits Number <optional>
 null

The number of digits to print after the decimal point, when ommited all digits are printed
Example
rac.Ray(55, 77, 0.2).toString()
// returns: 'Ray((55,77) a:0.2)'

translatePerpendicular(distance, clockwiseopt) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 292

Returns a new Ray with start moved by the given distance toward the angle.perpendicular(). All other properties are copied from this.

Parameters:
Name Type Attributes Default Description
distance Number

The distance to move start by
clockwise Boolean <optional>
 true

The orientation of the perpendicular

translateToAngle(angle, distance) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 278

Returns a new Ray with start moved towards angle by the given distance. All other properties are copied from this.

Parameters:
Name Type Description
angle Rac.Angle | Number

An Angle to move start towards
distance Number

The distance to move start by

translateToDistance(distance) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 264

Returns a new Ray with start moved along the ray by the given distance. All other properties are copied from this.

When distance is negative, start is moved in the inverse direction of angle.

Parameters:
Name Type Description
distance Number

The distance to move start by

withAngle(newAngle) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 192

Returns a new Ray with angle set to newAngle.

All other properties are copied from this.

Parameters:
Name Type Description
newAngle Rac.Angle | Number

The angle for the new Ray

withAngleAdd(increment) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 206

Returns a new Ray with increment added to this.angle.

All other properties are copied from this.

Parameters:
Name Type Description
increment Rac.Angle | Number

The angle to add

withAngleShift(angle, clockwiseopt) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 222

Returns a new Ray with angle set to this.angle.shift(angle, clockwise).

All other properties are copied from this.

Parameters:
Name Type Attributes Default Description
angle Rac.Angle | Number

The angle to be shifted by
clockwise Boolean <optional>
 true

The orientation of the shift

withStart(newStart) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 153

Returns a new Ray with start set to newStart.

All other properties are copied from this.

Parameters:
Name Type Description
newStart Rac.Point

The start for the new Ray

withX(newX) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 166

Returns a new Ray with start.x set to newX.

All other properties are copied from this.

Parameters:
Name Type Description
newX Number

The x coordinate for the new Ray

withY(newY) → {Rac.Ray}

# | source: src/drawable/Ray.js, line 179

Returns a new Ray with start.y set to newY.

All other properties are copied from this.

Parameters:
Name Type Description
newY Number

The y coordinate for the new Ray

yIntercept() → (nullable) {Number}

# | source: src/drawable/Ray.js, line 134

Returns the y-intercept: the point at which the ray, extended in both directions, intercepts with the y-axis; or null if the ray is vertical.

In the line formula y = mx + b the y-intercept is b.