org.jscience.physics.waves.optics.rays
Class RayPoint

java.lang.Object
  extended by org.jscience.physics.waves.optics.rays.RayPoint
All Implemented Interfaces:
java.lang.Cloneable

public class RayPoint
extends java.lang.Object
implements java.lang.Cloneable

DOCUMENT ME!


Constructor Summary
RayPoint()
          Creates a new RayPoint object.
RayPoint(Double3Vector pos, Double3Vector k, double w)
          Creates a new RayPoint object.
RayPoint(Double3Vector pos, Double3Vector k, double w, double d)
          Creates a new RayPoint object.
 
Method Summary
 java.lang.Object clone()
           
 double getAmplitude()
          DOCUMENT ME!
 Double3Vector getKVector()
          DOCUMENT ME!
 double getPhase()
          DOCUMENT ME!
 Double3Vector getPolarisation()
          DOCUMENT ME!
 Double3Vector getPosition()
          DOCUMENT ME!
 double getWavelength()
          DOCUMENT ME!
 void goStraight(double x_distance)
          DOCUMENT ME!
 void invalidate()
          DOCUMENT ME!
 boolean isValid()
          DOCUMENT ME!
 void setAmplitude(double a)
          DOCUMENT ME!
 void setKVector(Double3Vector k)
          DOCUMENT ME!
 void setPhase(double p)
          DOCUMENT ME!
 void setPolarisation(Double3Vector p)
          DOCUMENT ME!
 void setPosition(Double3Vector pos)
           
 void setWavelength(double w)
          DOCUMENT ME!
 void translate(double x, double y, double z)
          DOCUMENT ME!
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RayPoint

public RayPoint()
Creates a new RayPoint object.


RayPoint

public RayPoint(Double3Vector pos,
                Double3Vector k,
                double w)
Creates a new RayPoint object.

Parameters:
pos - DOCUMENT ME!
k - DOCUMENT ME!
w - DOCUMENT ME!

RayPoint

public RayPoint(Double3Vector pos,
                Double3Vector k,
                double w,
                double d)
Creates a new RayPoint object.

Parameters:
pos - DOCUMENT ME!
k - DOCUMENT ME!
w - DOCUMENT ME!
d - DOCUMENT ME!
Method Detail

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

goStraight

public void goStraight(double x_distance)
DOCUMENT ME!

Parameters:
x_distance - DOCUMENT ME!

invalidate

public void invalidate()
DOCUMENT ME!


setPosition

public void setPosition(Double3Vector pos)

translate

public void translate(double x,
                      double y,
                      double z)
DOCUMENT ME!

Parameters:
x - DOCUMENT ME!
y - DOCUMENT ME!
z - DOCUMENT ME!

setKVector

public void setKVector(Double3Vector k)
DOCUMENT ME!

Parameters:
k - DOCUMENT ME!

setWavelength

public void setWavelength(double w)
DOCUMENT ME!

Parameters:
w - DOCUMENT ME!

setPolarisation

public void setPolarisation(Double3Vector p)
DOCUMENT ME!

Parameters:
p - DOCUMENT ME!

setAmplitude

public void setAmplitude(double a)
DOCUMENT ME!

Parameters:
a - DOCUMENT ME!

setPhase

public void setPhase(double p)
DOCUMENT ME!

Parameters:
p - DOCUMENT ME!

isValid

public boolean isValid()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getPosition

public Double3Vector getPosition()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getKVector

public Double3Vector getKVector()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getWavelength

public double getWavelength()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getPolarisation

public Double3Vector getPolarisation()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getAmplitude

public double getAmplitude()
DOCUMENT ME!

Returns:
DOCUMENT ME!

getPhase

public double getPhase()
DOCUMENT ME!

Returns:
DOCUMENT ME!