org.apache.commons.geometry.euclidean.twod

Class Ray

java.lang.Object

org.apache.commons.geometry.euclidean.twod.LineSubset

org.apache.commons.geometry.euclidean.twod.LineConvexSubset

org.apache.commons.geometry.euclidean.twod.Ray

All Implemented Interfaces:

Embedding<Vector2D,Vector1D>, HyperplaneConvexSubset<Vector2D>, HyperplaneSubset<Vector2D>, Splittable<Vector2D,HyperplaneSubset<Vector2D>>, RegionEmbedding<Vector2D,Vector1D>, Sized

public final class Ray
extends LineConvexSubset

Class representing a ray in 2D Euclidean space. A ray is a portion of a line consisting of a single start point and extending to infinity along the direction of the line.

Instances of this class are guaranteed to be immutable.

See Also:

ReverseRay, Lines

Method Summary

Modifier and Type	Method and Description
Bounds2D	getBounds() Get a Bounds2D object defining an axis-aligned bounding box containing all vertices for this subset.
Vector2D	getCentroid()
Vector2D	getDirection() Get the direction of the ray.
Vector2D	getEndPoint() Get the end point for the subset.
double	getSize()
Vector2D	getStartPoint() Get the start point for the subset.
double	getSubspaceEnd() Get the 1D end location of the subset or Double.POSITIVE_INFINITY if no end location exists.
double	getSubspaceStart() Get the 1D start location of the subset or Double.NEGATIVE_INFINITY if no start location exists.
boolean	isFinite()
boolean	isFull()
boolean	isInfinite()
ReverseRay	reverse()
String	toString()
Ray	transform(Transform<Vector2D> transform)

Methods inherited from class org.apache.commons.geometry.euclidean.twod.LineConvexSubset

closest, getInterval, getSubspaceRegion, isEmpty, split, toConvex

Methods inherited from class org.apache.commons.geometry.euclidean.twod.LineSubset

classify, getHyperplane, getLine, getPrecision, intersection, intersection, toSpace, toSubspace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.commons.geometry.core.partitioning.HyperplaneSubset

classify, contains, getHyperplane

Methods inherited from interface org.apache.commons.geometry.core.Embedding

toSpace, toSubspace

Method Detail

isFull

public boolean isFull()

This method always returns false.

isInfinite

public boolean isInfinite()

This method always returns true.

isFinite

public boolean isFinite()

This method always returns false.

getSize

public double getSize()

This method always returns Double.POSITIVE_INFINITY.

getCentroid

public Vector2D getCentroid()

This method always returns null.

getStartPoint

public Vector2D getStartPoint()

Description copied from class: LineConvexSubset

Get the start point for the subset.

Specified by:

getStartPoint in class LineConvexSubset

Returns:

the start point for the subset, or null if no start point exists

getSubspaceStart

public double getSubspaceStart()

Get the 1D start location of the subset or Double.NEGATIVE_INFINITY if no start location exists.

Specified by:

getSubspaceStart in class LineConvexSubset

Returns:

the 1D start location of the subset or Double.NEGATIVE_INFINITY if no start location exists.

getEndPoint

public Vector2D getEndPoint()

Get the end point for the subset.

This method always returns null.

Specified by:

getEndPoint in class LineConvexSubset

Returns:

the end point for the subset, or null if no end point exists.

getSubspaceEnd

public double getSubspaceEnd()

Get the 1D end location of the subset or Double.POSITIVE_INFINITY if no end location exists.

This method always returns Double.POSITIVE_INFINITY.

Specified by:

getSubspaceEnd in class LineConvexSubset

Returns:

the 1D end location of the subset or Double.POSITIVE_INFINITY if no end location exists

getBounds

public Bounds2D getBounds()

Get a Bounds2D object defining an axis-aligned bounding box containing all vertices for this subset. Null is returned if the subset is infinite or does not contain any vertices.

This method always returns null.

Specified by:

getBounds in class LineSubset

Returns:

the bounding box for this instance or null if no valid bounds could be determined

getDirection

public Vector2D getDirection()

Get the direction of the ray. This is a convenience method for ray.getLine().getDirection().

Returns:

the direction of the ray

transform

public Ray transform(Transform<Vector2D> transform)

Specified by:

transform in interface HyperplaneConvexSubset<Vector2D>

Specified by:

transform in interface HyperplaneSubset<Vector2D>

Specified by:

transform in class LineConvexSubset

reverse

public ReverseRay reverse()

Specified by:

reverse in interface HyperplaneConvexSubset<Vector2D>

Specified by:

reverse in class LineConvexSubset

toString

public String toString()

Overrides:

toString in class Object