Class pwlib.tools.rectangle

The rectangle tool.
Defined in: rectangle.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	pwlib.tools.rectangle(app)

Field Summary
Field Attributes	Field Name and Description
<private> <inner>	needsRedraw Tells if the drawing canvas needs to be updated or not.
<private> <inner>	shiftKey Tells if the `Shift` key is down or not.
<private> <inner>	timer The interval ID used for invoking the drawing operation every few milliseconds.
<private> <inner>	x0 Holds the starting point on the `x` axis of the image, for the current drawing operation.
<private> <inner>	y0 Holds the starting point on the `y` axis of the image, for the current drawing operation.

Method Summary
Method Attributes	Method Name and Description
	deactivate() Tool deactivation event handler.
	draw() Perform the drawing operation.
	keydown(ev) Allows the user to press `Escape` to cancel the drawing operation.
	mousedown(ev) Initialize the drawing operation.
	mousemove(ev) Store the `Shift` key state which is used by the drawing function.
	mouseup(ev) End the drawing operation, once the user releases the mouse button.

Class Detail

pwlib.tools.rectangle(app)

Field Detail

<private> <inner> {Boolean} needsRedraw

Tells if the drawing canvas needs to be updated or not.

<private> <inner> {Boolean} shiftKey

Tells if the Shift key is down or not. This is used by the drawing function.

<private> <inner> timer

The interval ID used for invoking the drawing operation every few milliseconds.

<private> <inner> {Number} x0

Holds the starting point on the x axis of the image, for the current drawing operation.

<private> <inner> {Number} y0

Holds the starting point on the y axis of the image, for the current drawing operation.

Method Detail

deactivate()

Tool deactivation event handler.

draw()

Perform the drawing operation. This function is called every few milliseconds.

Hold down the Shift key to draw a square.

Press Escape to cancel the drawing operation.

{Boolean} keydown(ev)

Allows the user to press Escape to cancel the drawing operation.

Returns:: {Boolean} True if the drawing operation was cancelled, or false if not.

mousedown(ev)

Initialize the drawing operation.

mousemove(ev)

Store the Shift key state which is used by the drawing function.

mouseup(ev)

End the drawing operation, once the user releases the mouse button.

Classes