summaryrefslogtreecommitdiffstats
path: root/src/jrummikub/model/Sizeable.java
diff options
context:
space:
mode:
authorJannis Harder <harder@informatik.uni-luebeck.de>2011-05-02 04:46:00 +0200
committerJannis Harder <harder@informatik.uni-luebeck.de>2011-05-02 04:46:00 +0200
commit1e7cdb33f5bfce2d3fb174abd778788108557078 (patch)
tree7ef56ce60b813402eabff2bc1aee77ba6142cbd8 /src/jrummikub/model/Sizeable.java
parent91b921248f4a74bddd8434bcad65c45fd8486549 (diff)
downloadJRummikub-1e7cdb33f5bfce2d3fb174abd778788108557078.tar
JRummikub-1e7cdb33f5bfce2d3fb174abd778788108557078.zip
More javadocs for the model
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@64 72836036-5685-4462-b002-a69064685172
Diffstat (limited to 'src/jrummikub/model/Sizeable.java')
-rw-r--r--src/jrummikub/model/Sizeable.java15
1 files changed, 14 insertions, 1 deletions
diff --git a/src/jrummikub/model/Sizeable.java b/src/jrummikub/model/Sizeable.java
index fa022cc..3c78e5c 100644
--- a/src/jrummikub/model/Sizeable.java
+++ b/src/jrummikub/model/Sizeable.java
@@ -1,9 +1,22 @@
package jrummikub.model;
/**
- * Objects that have a size
+ * Objects that have a size. This interface has to be implemented for objects
+ * placed on a @{link StoneTray} to make detection of overlapping objects
+ * possible.
*/
public interface Sizeable {
+ /**
+ * Get the width of the object
+ *
+ * @return object width
+ */
public float getWidth();
+
+ /**
+ * Get the height of the object
+ *
+ * @return object height
+ */
public float getHeight();
}