Update of /cvsroot/bprocessor/gl/src/net/sourceforge/bprocessor/gl/tool
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv32532/src/net/sourceforge/bprocessor/gl/tool
Modified Files:
AbstractTool.java AbstractPencil.java
Log Message:
added a more describing javadoc header for both abstract tools
Index: AbstractPencil.java
===================================================================
RCS file: /cvsroot/bprocessor/gl/src/net/sourceforge/bprocessor/gl/tool/AbstractPencil.java,v
retrieving revision 1.72
retrieving revision 1.73
diff -C2 -d -r1.72 -r1.73
*** AbstractPencil.java 14 Nov 2006 15:10:05 -0000 1.72
--- AbstractPencil.java 6 Feb 2007 17:28:26 -0000 1.73
***************
*** 42,46 ****
/**
* AbstractPencil
! *
*/
public abstract class AbstractPencil extends AbstractTool {
--- 42,63 ----
/**
* AbstractPencil
! * The tool to extend if lots of feedback and automation for release and drag are wanted
! * It extends AbstactTool and implement drag and release as well as som std. cleanup and excape
! * methods
! *
! * The only two abstact methods left are pressed and moved
! *
! * AbstractPencil are ment to be working on intersection points, and therefore give way to
! * findIntersection methods, which return the found intersection.
! *
! * use start and current intersection in this object to store the pressed intersection as well as
! * the current one under the mouse
! *
! * As in AbstractTool it is common to implement cleanUp which is called when a tool is exited, to
! * secure nothing is left in some special case when the tool is used next time (REMEMBER TO CALL
! * SUPER IMPL.)
! *
! * If some geometry are needed to be drawn in the view for feedback and so on, use the feedback
! * method to add geometry to be shown
*/
public abstract class AbstractPencil extends AbstractTool {
Index: AbstractTool.java
===================================================================
RCS file: /cvsroot/bprocessor/gl/src/net/sourceforge/bprocessor/gl/tool/AbstractTool.java,v
retrieving revision 1.110
retrieving revision 1.111
diff -C2 -d -r1.110 -r1.111
*** AbstractTool.java 26 Jan 2007 14:04:57 -0000 1.110
--- AbstractTool.java 6 Feb 2007 17:28:26 -0000 1.111
***************
*** 37,40 ****
--- 37,54 ----
/**
* The abstracttool
+ * The tool to extend if only object selection is needed
+ * It is methods called when the mouse is invoked that are to be implemented
+ * when extending this class
+ * moved, pressed, dragged and released are the abstact methods
+ *
+ * When canceling tool action escape are called, so override if for canceling cleanup
+ *
+ * When a tool finishes, that is when another tool are chosen, cleanUp are called, so
+ * implement it to cleanUp any unfinished business in a tool. REMEMBER TO CALL THE SUPER
+ * IMPLEMENTATION WHEN EXTENDING
+ *
+ * findTarger come in handy for findinge the current object that the mouse is hooveing above
+ *
+ * A known implementation is SelectTool
*/
public abstract class AbstractTool implements Tool {
|
