lcsim/src/org/lcsim/spacegeom
diff -u -r1.8 -r1.9
--- SpacePoint.java 29 Aug 2006 19:50:19 -0000 1.8
+++ SpacePoint.java 25 Oct 2006 08:11:01 -0000 1.9
@@ -9,8 +9,14 @@
import java.io.Serializable;
/**
- *
- *@version $Id: SpacePoint.java,v 1.8 2006/08/29 19:50:19 jstrube Exp $
+ * A SpacePoint represents a concrete point in 3D Space,
+ * much like a coordinate.
+ * SpacePoint objects know about their representation in
+ * cartesian, spherical and cylindrical coordinates.
+ * For interoperability with Freehep classes SpacePoint implements the Hep3Vector interface.
+ *
+ * In distinction to vectors, two points cannot be added, and multiplication with a scalar is not defined, neither is the addition of two points.
+ *@version $Id: SpacePoint.java,v 1.9 2006/10/25 08:11:01 jstrube Exp $
*/
public class SpacePoint implements Serializable, Cloneable, Hep3Vector
{
lcsim/src/org/lcsim/spacegeom
diff -u -r1.4 -r1.5
--- SpaceVector.java 10 Sep 2006 11:47:44 -0000 1.4
+++ SpaceVector.java 25 Oct 2006 08:11:02 -0000 1.5
@@ -3,9 +3,13 @@
import hep.physics.vec.Hep3Vector;
/**
+ * A SpaceVector is the representation of a vector in 3D space, where a vector is defined to have a direction and a length.
+ * SpaceVector objects know about their representation in cartesian, spherical and cylindrical coordinate systems.
+ * In distinction to points in space, vectors are invariant under translation and can be multiplied by a scalar.
+ * A scalar and a vector product is defined for vectors, and the difference between two SpacePoints is a SpaceVector.
+ * For interoperability with Freehep classes, SpaceVector implements the Hep3Vector interface.
*
- *
- *@version $Id: SpaceVector.java,v 1.4 2006/09/10 11:47:44 jstrube Exp $
+ *@version $Id: SpaceVector.java,v 1.5 2006/10/25 08:11:02 jstrube Exp $
*/
public class SpaceVector extends SpacePoint
{