org.monospark.geometrix.plane

Class PlaneCoordinateSystem

java.lang.Object

org.monospark.geometrix.GeometrixObject

org.monospark.geometrix.plane.PlaneCoordinateSystem

public final class PlaneCoordinateSystem
extends GeometrixObject

Method Summary

Modifier and Type	Method and Description
static PlaneCoordinateSystem	create(Plane plane, Vec<Three> center, Vec<Three> xAxis, Vec<Three> yAxis) Creates a local coordinate system of plane out of a given center and two axes.
boolean	equals(java.lang.Object o)
Vec<Three>	getCenter()
Vec<Three>	getGlobalDirection(Vec<Two> localDirection)
Vec<Three>	getGlobalPoint(Vec<Two> localPoint)
Vec<Two>	getLocalDirection(Vec<Three> globalDirection)
Vec<Two>	getLocalPoint(Vec<Three> globalPoint)
Plane	getPlane()
Vec<Three>	getXAxis()
Vec<Three>	getYAxis()
int	hashCode()
boolean	resembles(java.lang.Object o)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static PlaneCoordinateSystem create(Plane plane,
                                           Vec<Three> center,
                                           Vec<Three> xAxis,
                                           Vec<Three> yAxis)

Creates a local coordinate system of plane out of a given center and two axes.

Parameters:

plane - the plane on which the coordinate system lies on

center - the point at which the center of the coordinate system lies on the plane

xAxis - the x-axis of the coordinate system

yAxis - the y-axis of the coordinate system

Returns:

a two-dimensional coordinate system on a plane

Throws:

java.lang.NullPointerException - if one of the arguments is null

java.lang.IllegalArgumentException - if center lies outside the object space

java.lang.IllegalArgumentException - if xAxis or yAxis is a zero vector

java.lang.IllegalArgumentException - if xAxis or yAxis is perpendicular to the plane

java.lang.IllegalArgumentException - if xAxis and yAxis are parallel

getLocalPoint

public Vec<Two> getLocalPoint(Vec<Three> globalPoint)

getLocalDirection

public Vec<Two> getLocalDirection(Vec<Three> globalDirection)

getGlobalPoint

public Vec<Three> getGlobalPoint(Vec<Two> localPoint)

getGlobalDirection

public Vec<Three> getGlobalDirection(Vec<Two> localDirection)

resembles

public boolean resembles(java.lang.Object o)

Specified by:

resembles in class GeometrixObject

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in class GeometrixObject

hashCode

public int hashCode()

Specified by:

hashCode in class GeometrixObject

toString

public java.lang.String toString()

Specified by:

toString in class GeometrixObject

getPlane

public Plane getPlane()

getCenter

public Vec<Three> getCenter()

getXAxis

public Vec<Three> getXAxis()

getYAxis

public Vec<Three> getYAxis()