updates for 0.9.3

[debian/openrocket] / src / net / sf / openrocket / rocketcomponent / ClusterConfiguration.java

diff --git a/src/net/sf/openrocket/rocketcomponent/ClusterConfiguration.java b/src/net/sf/openrocket/rocketcomponent/ClusterConfiguration.java
index d80d369562075862a562e93c2bb0b340e72ff8df..73e8a6dee7db33dec134ba276e4b92e75dd4a9d5 100644 (file)
--- a/src/net/sf/openrocket/rocketcomponent/ClusterConfiguration.java
+++ b/src/net/sf/openrocket/rocketcomponent/ClusterConfiguration.java
@@ -82,6 +82,13 @@ public class ClusterConfiguration {
                return points.size()/2;
        }
        
+       /**
+        * Returns the relative positions of the cluster components.  The list is of length
+        * <code>2*getClusterCount()</code> with (x,y) value pairs.  The origin is at (0,0)
+        * and the values are positioned so that the closest clusters have distance of 1.
+        * 
+        * @return      a list of (x,y) coordinate pairs.
+        */
        public List<Double> getPoints() {
                return points;  // Unmodifiable
        }