Module: Sevgi::Geometry::Operation

Extended by:

Operation

Included in:

Operation

Defined in:

lib/sevgi/geometry/operation.rb,
lib/sevgi/geometry/operation/align.rb,
lib/sevgi/geometry/operation/sweep.rb

Overview

Dispatches geometry operations to operation handler modules.

Constant Summary

OperationError =

Raised when an operation starts but cannot complete.

Class.new(Error)

OperationInapplicableError =

Raised when an operation does not apply to the target element.

Class.new(Error)

Class Method Summary

• .align(element, other, alignment = :center) ⇒ Sevgi::Geometry::Element

  Returns an element translated to align with another element.

• .alignment(element, other, alignment = :center) ⇒ Sevgi::Geometry::Point

  Returns the offset needed to align one element with another.

• .sweep(element, initial:, angle:, step:, limit: Sweep::LIMIT) {|lines| ... } ⇒ Array<Sevgi::Geometry::Line>

  Sweeps parallel lines across a lined element in both directions.

• .sweep!(element, initial:, angle:, step:, limit: Sweep::LIMIT) {|lines| ... } ⇒ Array<Sevgi::Geometry::Line>

  Sweeps parallel lines across a lined element and requires at least one result.

• .unisweep(element, equation, step, limit: Sweep::LIMIT) ⇒ Array<Sevgi::Geometry::Line>

  Sweeps parallel lines in one signed direction from an equation.

Class Method Details

.align(element, other, alignment = :center) ⇒ Sevgi::Geometry::Element

Returns an element translated to align with another element.

Parameters:

• element (Sevgi::Geometry::Element) —

  element to move

• other (Sevgi::Geometry::Element) —

  reference element

• alignment (Symbol) (defaults to: :center) —

  one of :center, :left, :right, :top, or :bottom

Returns:

• (Sevgi::Geometry::Element) —

  translated element

Raises:

• (Sevgi::Geometry::Operation::OperationInapplicableError) —

  when an argument is not a geometry element

• (Sevgi::ArgumentError) —

  when alignment is unknown

# File 'lib/sevgi/geometry/operation.rb', line 80

def register(handler, *operations) = operations.each { |operation| def_operation(operation, handler) }

.alignment(element, other, alignment = :center) ⇒ Sevgi::Geometry::Point

Returns the offset needed to align one element with another.

Parameters:

• element (Sevgi::Geometry::Element) —

  element to move

• other (Sevgi::Geometry::Element) —

  reference element

• alignment (Symbol) (defaults to: :center) —

  one of :center, :left, :right, :top, or :bottom

Returns:

• (Sevgi::Geometry::Point) —

  translation offset

Raises:

• (Sevgi::Geometry::Operation::OperationInapplicableError) —

  when an argument is not a geometry element

• (Sevgi::ArgumentError) —

  when alignment is unknown

# File 'lib/sevgi/geometry/operation.rb', line 80

def register(handler, *operations) = operations.each { |operation| def_operation(operation, handler) }

.sweep(element, initial:, angle:, step:, limit: Sweep::LIMIT) {|lines| ... } ⇒ Array<Sevgi::Geometry::Line>

Sweeps parallel lines across a lined element in both directions.

Parameters:

• element (Sevgi::Geometry::Element::Lined) —

  element to intersect

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

  point on the initial sweep line

• angle (Numeric) —

  clockwise sweep line angle in degrees

• step (Numeric) —

  signed distance between sweep lines

• limit (Integer) (defaults to: Sweep::LIMIT) —

  maximum iterations per direction

Yields:

• (lines) —

  optional hook receiving the generated lines

Yield Parameters:

• lines (Array<Sevgi::Geometry::Line>) —

  generated sweep lines

Yield Returns:

• (void)

Returns:

• (Array<Sevgi::Geometry::Line>) —

  generated sweep lines

Raises:

• (Sevgi::Geometry::Operation::OperationInapplicableError) —

  when element is not sweepable

• (Sevgi::Geometry::Error) —

  when initial cannot be coerced

• (Sevgi::Geometry::Operation::OperationError) —

  when iteration reaches the limit

# File 'lib/sevgi/geometry/operation.rb', line 80

def register(handler, *operations) = operations.each { |operation| def_operation(operation, handler) }

.sweep!(element, initial:, angle:, step:, limit: Sweep::LIMIT) {|lines| ... } ⇒ Array<Sevgi::Geometry::Line>

Sweeps parallel lines across a lined element and requires at least one result.

Parameters:

• element (Sevgi::Geometry::Element::Lined) —

  element to intersect

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

  point on the initial sweep line

• angle (Numeric) —

  clockwise sweep line angle in degrees

• step (Numeric) —

  signed distance between sweep lines

• limit (Integer) (defaults to: Sweep::LIMIT) —

  maximum iterations per direction

Yields:

• (lines) —

  optional hook receiving the generated lines

Yield Parameters:

• lines (Array<Sevgi::Geometry::Line>) —

  generated sweep lines

Yield Returns:

• (void)

Returns:

• (Array<Sevgi::Geometry::Line>) —

  generated sweep lines

Raises:

• (Sevgi::Geometry::Operation::OperationInapplicableError) —

  when element is not sweepable

• (Sevgi::Geometry::Error) —

  when initial cannot be coerced

• (Sevgi::Geometry::Operation::OperationError) —

  when no lines are found or iteration reaches the limit

# File 'lib/sevgi/geometry/operation.rb', line 80

def register(handler, *operations) = operations.each { |operation| def_operation(operation, handler) }

.unisweep(element, equation, step, limit: Sweep::LIMIT) ⇒ Array<Sevgi::Geometry::Line>

Sweeps parallel lines in one signed direction from an equation.

Parameters:

• element (Sevgi::Geometry::Element::Lined) —

  element to intersect

• equation (Sevgi::Geometry::Equation) —

  initial sweep equation

• step (Numeric) —

  signed distance between sweep lines

• limit (Integer) (defaults to: Sweep::LIMIT) —

  maximum iterations

Returns:

• (Array<Sevgi::Geometry::Line>) —

  generated sweep lines

Raises:

• (Sevgi::Geometry::Operation::OperationInapplicableError) —

  when element is not sweepable

• (Sevgi::Geometry::Operation::OperationError) —

  when iteration reaches the limit

# File 'lib/sevgi/geometry/operation.rb', line 80

def register(handler, *operations) = operations.each { |operation| def_operation(operation, handler) }