EasyGeometry::D2::Ray

A Ray is a semi-line in the space with a source point and a direction. Segment inherit from Linear Entity.

#contains?(entity)

Description

Is other GeometryEntity contained in this Ray?

Returns:

• true if entity is in this Ray.

• false otherwise.

Signature

Parameters:
    entity - GeometryEntity(Point, Line etc.) 
            or Array of Numeric(coordinates)
    
Returns:
    boolean (true or false)
    
Errors:

Example

r1 = EasyGeometry::D2::Ray.new([0, 0], [1, 1])

r1.contains?([0, 0])  # true
r1.contains?([1, 0])  # false
r1.contains?(r1)      # true

#distance(point)

Description

Finds the shortest distance between the ray and a point.

Signature

Parameters:
    point - EasyGeometry::D2::Point or Array of Numeric(coordinates)
    
Returns:
    Numeric
    
Errors:
    raise TypeError if point is not Point or valid Array

Example

r1 = EasyGeometry::D2::Ray.new([0, 0], [1, 1])

r1.distance([0, 0])  # 0
r1.distance([-1, 1]) # Math.sqrt(2)

#==(other)

Description

Returns True if self and otherare the same mathematical entities.

Signature

Parameters:
    other - GeometryEntity(Point, Line etc.)
    
Returns:
    boolean (true or false)
    
Errors:

Example

r1 = EasyGeometry::D2::Ray.new([0, 0], [1, 1])
r2 = EasyGeometry::D2::Ray.new([0, 0], [1, 0])

r1 == r2  # false
r1 == r1  # true

#source

Description

The point from which the ray emanates.

Signature

Parameters:
    
Returns:
    EasyGeometry::D2::Point
    
Errors:

Example

r1 = EasyGeometry::D2::Ray.new([0, 0], [1, 1])

r1.source   # Point(0, 0)

#xdirection

Description

The x direction of the ray.

Returns:

• Positive infinity if the ray points in the positive x direction

• Negative infinity if the ray points in the negative x direction

• 0 if the ray is vertical

Signature

Parameters:
    
Returns:
    Numeric or BigDecimal('Infinity') or -BigDecimal('Infinity')
    
Errors:

Example

r1 = EasyGeometry::D2::Ray.new([0, 0], [1, 1])

r1.xdirection   # BigDecimal('Infinity')

#ydirection

Description

The y direction of the ray.

Returns:

• Positive infinity if the ray points in the positive y direction

• Negative infinity if the ray points in the negative y direction

• 0 if the ray is horizontal

Signature

Parameters:
    
Returns:
    Numeric or BigDecimal('Infinity') or -BigDecimal('Infinity')
    
Errors:

Example

r1 = EasyGeometry::D2::Ray.new([0, 0], [1, 1])

r1.ydirection   # BigDecimal('Infinity')