Class: Sevgi::Geometry::Line

Inherits:

LineBase

• Object
• Sevgi::Geometry::Line

Extended by:

Forwardable

Defined in:

lib/sevgi/geometry/elements/line.rb,
lib/sevgi/geometry/equation.rb

Overview

Open lined element with one segment.

Class Method Summary

• .[](length, angle, position: Origin) ⇒ Sevgi::Geometry::Line

  Builds a line from length and angle.

• .from_length_angle(length, angle, position: Origin) ⇒ Sevgi::Geometry::Line

  Builds a line from length and angle.

• .from_points(starting, ending) ⇒ Sevgi::Geometry::Line

  Builds a line from two endpoints.

Instance Method Summary

• #draw!(node) ⇒ Object

  Draws the line into a graphics node.

• #equation ⇒ Sevgi::Geometry::Equation::Linear

  Returns the linear equation containing this line.

• #over?(point) ⇒ Boolean

  Reports whether a point lies on the finite line segment.

• #shift(distance) ⇒ Sevgi::Geometry::Line

  Returns a parallel line shifted by a signed perpendicular offset.

Class Method Details

.[](length, angle, position: Origin) ⇒ Sevgi::Geometry::Line

Builds a line from length and angle.

Parameters:

• length (Numeric) —

  line length

• angle (Numeric) —

  clockwise angle in degrees

• position (Sevgi::Geometry::Point, Array<Numeric>) (defaults to: Origin) —

  starting point

Returns:

• (Sevgi::Geometry::Line)

Raises:

• (Sevgi::Geometry::Error) —

  when position cannot be coerced

# File 'lib/sevgi/geometry/elements/line.rb', line 21

def self.[](...) = from_length_angle(...)

.from_length_angle(length, angle, position: Origin) ⇒ Sevgi::Geometry::Line

Builds a line from length and angle.

Parameters:

• length (Numeric) —

  line length

• angle (Numeric) —

  clockwise angle in degrees

• position (Sevgi::Geometry::Point, Array<Numeric>) (defaults to: Origin) —

  starting point

Returns:

• (Sevgi::Geometry::Line)

Raises:

• (Sevgi::Geometry::Error) —

  when position cannot be coerced

# File 'lib/sevgi/geometry/elements/line.rb', line 29

def self.from_length_angle(length, angle, position: Origin) = new_by_segments(Segment[length, angle], position:)

.from_points(starting, ending) ⇒ Sevgi::Geometry::Line

Builds a line from two endpoints.

Parameters:

• starting (Sevgi::Geometry::Point, Array<Numeric>) —

  starting point

• ending (Sevgi::Geometry::Point, Array<Numeric>) —

  ending point

Returns:

• (Sevgi::Geometry::Line)

Raises:

• (Sevgi::Geometry::Error) —

  when either point cannot be coerced

# File 'lib/sevgi/geometry/elements/line.rb', line 37

def self.from_points(...) = new_by_points(...)

Instance Method Details

#draw!(node) ⇒ Object

Draws the line into a graphics node.

Parameters:

• node (Object) —

  graphics node receiving the drawing command

Returns:

• (Object) —

  graphics node command result

# File 'lib/sevgi/geometry/elements/line.rb', line 51

def draw!(node, **) = node.LineTo(x1: position.x, y1: position.y, x2: ending.x, y2: ending.y, **)

#equation ⇒ Sevgi::Geometry::Equation::Linear

Returns the linear equation containing this line.

Returns:

• (Sevgi::Geometry::Equation::Linear)

# File 'lib/sevgi/geometry/equation.rb', line 105

def equation = position.equation(angle)

#over?(point) ⇒ Boolean

Reports whether a point lies on the finite line segment.

Parameters:

• point (Sevgi::Geometry::Point, Array<Numeric>) —

  point to test

Returns:

• (Boolean)

Raises:

• (Sevgi::Geometry::Error) —

  when point cannot be coerced

# File 'lib/sevgi/geometry/elements/line.rb', line 57

def over?(point)
  point = Tuple[Point, point]

  within_range?(point) && equation.on?(point)
end

#shift(distance) ⇒ Sevgi::Geometry::Line

Returns a parallel line shifted by a signed perpendicular offset.

Parameters:

• distance (Numeric) —

  signed perpendicular offset

Returns:

• (Sevgi::Geometry::Line)

# File 'lib/sevgi/geometry/elements/line.rb', line 66

def shift(distance) = translate(distance * F.sin(angle), -distance * F.cos(angle))