de.mcp.cutcad.application

Class Tool

java.lang.Object

de.mcp.cutcad.application.Tool

All Implemented Interfaces:

Drawable2D

Direct Known Subclasses:

ChangeSTLTool, ConnectTool, CopyTool, CutoutTool, DeleteTool, ImportSTLTool, ImportSVGTool, LoadTool, NewProjectTool, PolygonTool, PrintTool, RectangleTool, SaveTool, SelectTool, SymmetricPolygonTool, TrapeziumTool

public abstract class Tool
extends java.lang.Object
implements Drawable2D

Template class for the implementation of a tool. Provides a set of event-based methods that need to be overriden to achieve custom behaviour. Tools can be informed about mouse events (mouseButtonPressed, mouseButtonReleased, mouseMoved) and tool selection events (toolWasSelected, toolWasUnselected). Tools are by now associated with the 2D drawing view of the application. By overriding the draw2D method, it is possible for a tool to draw its own content into the 2D drawing view.

Author:

dennis

Field Summary

Fields

Modifier and Type	Field and Description
protected CutCADApplet	application A reference to the application itself.
private ShapeButton	button
protected ObjectContainer	objectContainer A reference to the object container.
protected DrawingView2D	view The 2D drawing view of the application.

Constructor Summary

Constructors

Constructor and Description
Tool(CutCADApplet application, ObjectContainer container) Default constructor for a tool.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canStaySelected() Return whether this tool can be selected for a longer time (such as the drawing tools or select tool) or whether it is a click-and-forget-tool (such as the save, load or new tool).
void	draw2D(processing.core.PGraphics p, Transformation transform) Will be called by the drawing runloop of the application whenever the screen is redrawn.
ShapeButton	getButton() Returns the button to select this tool.
private SVGIcon	getIcon() Loads the SVGIcon for the tool.
abstract java.lang.String	getIconName() Return the name of the SVG for the icon for the tool.
void	mouseButtonPressed(Vector2D position, int button) Will be called by the application when a mouse button was pressed.
void	mouseButtonReleased(Vector2D position, int button) Will be called by the application when a mouse button was released.
void	mouseMoved(Vector2D position) Will be called by the application when the mouse was moved.
void	toolWasSelected() Will be called by the application when this tool was selected.
void	toolWasUnselected() Will be called by the application when another tool was selected.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

view

protected DrawingView2D view

The 2D drawing view of the application.

application

protected CutCADApplet application

A reference to the application itself.

objectContainer

protected ObjectContainer objectContainer

A reference to the object container.

button

private ShapeButton button

Constructor Detail

Tool

public Tool(CutCADApplet application,
    ObjectContainer container)

Default constructor for a tool.

Parameters:

application - Reference to the application.

container - Reference to the object container.

Method Detail

getIconName

public abstract java.lang.String getIconName()

Return the name of the SVG for the icon for the tool. This method will be called on initialization to load the icon for later representation.

Returns:

The fully qualified name of the SVG of the icon.

mouseButtonPressed

public void mouseButtonPressed(Vector2D position,
                      int button)

Will be called by the application when a mouse button was pressed.

Parameters:

position - The absolute position of the mouse cursor.

button - The button that was pressed.

mouseButtonReleased

public void mouseButtonReleased(Vector2D position,
                       int button)

Will be called by the application when a mouse button was released.

Parameters:

position - The absolute position of the mouse cursor.

button - The button that was released.

mouseMoved

public void mouseMoved(Vector2D position)

Will be called by the application when the mouse was moved.

Parameters:

position - The absolute position of the mouse cursor.

toolWasSelected

public void toolWasSelected()

Will be called by the application when this tool was selected.

toolWasUnselected

public void toolWasUnselected()

Will be called by the application when another tool was selected.

draw2D

public void draw2D(processing.core.PGraphics p,
          Transformation transform)

Will be called by the drawing runloop of the application whenever the screen is redrawn.

Specified by:

draw2D in interface Drawable2D

Parameters:

p - The graphics context to draw into.

transform - The transformation currently applied to the context.

canStaySelected

public boolean canStaySelected()

Return whether this tool can be selected for a longer time (such as the drawing tools or select tool) or whether it is a click-and-forget-tool (such as the save, load or new tool).

Returns:

Return whether the tool will stay selected until a new tool is selected.

getButton

public ShapeButton getButton()

Returns the button to select this tool.

Returns:

The button to select this tool.

getIcon

private SVGIcon getIcon()

Loads the SVGIcon for the tool. Uses getIconName in order to get the icons file name.

Returns:

A SVGIcon with the tools icon loaded from the icon SVG file.