DrawingTool (ImageJ2 Javadocs 0-SNAPSHOT API)

java.lang.Object
- net.imagej.DrawingTool

```
public class DrawingTool
extends Object
```
Draws data across all channels in an orthoplane of a Dataset. Many methods adapted from ImageJ1's ImageProcessor methods. Internally the drawing routines work in a UV plane. U and V can be specified from existing coord axes (i.e UV can equal XY or ZT or any other combination of Dataset axes that do not involve the channel axis). It is the user's responsibility to avoid using a single axis to specify both the U and V axes.

Author:

Barry DeZonia

Constructor Summary

Constructors
Constructor and Description

DrawingTool(Dataset ds, RenderingService service)
Creates a DrawingTool to modify a specified Dataset.

Constructors
Constructor and Description
`DrawingTool(Dataset ds, RenderingService service)` Creates a DrawingTool to modify a specified Dataset.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`drawDot(long u, long v)` Draws a dot in the current UV plane at specified UV coordinates.
`void`	`drawLine(long u1, long v1, long u2, long v2)` Draws a line from (u1,v1) to (u2,v2).
`void`	`drawPixel(long u, long v)` Draws a pixel in the current UV plane at specified UV coordinates.
`void`	`drawRect(long uOrg, long vOrg, long w, long h)` Draws the outline of a rectangle in the current UV plane.
`void`	`drawText(long anchorU, long anchorV, String text, TextRenderer.TextJustification just)` Draws a line of text along the U axis
`void`	`fill()` Fills the current UV plane.
`void`	`fillCircle(long uc, long vc)` Draws a filled circle in the current UV plane centered at the specified UV coordinates.
`void`	`fillRect(long uOrigin, long vOrigin, long w, long h)` Draws a filled rectangle in the current UV plane.
`ChannelCollection`	`getChannels()`
`Dataset`	`getDataset()` Return the Dataset associated with this DrawingTool.
`TextRenderer.FontFamily`	`getFontFamily()` Gets the family name of the drawing font.
`int`	`getFontSize()` Gets the size of the drawing font.
`TextRenderer.FontStyle`	`getFontStyle()` Gets the style of the drawing font.
`long`	`getLineWidth()` Gets the current drawing line width.
`void`	`getPosition(long[] position)` Gets this DrawingHelper's current drawing position.
`boolean`	`getTextAntialiasing()` Get the drawn text antialiasing value: on (true) or off (false)
`int`	`getUAxis()` Returns the index of the U axis of this Drawing Tool.
`int`	`getVAxis()` Returns the index of the V axis of this Drawing Tool.
`void`	`lineTo(long u1, long v1)` Draws a line in the current UV plane from the current origin to the specified coordinate.
`void`	`moveTo(long u, long v)` Moves the drawing origin of the current UV plane to the specified coordinates.
`void`	`setChannels(ChannelCollection chans)`
`void`	`setFontFamily(TextRenderer.FontFamily family)` Sets the family name of the drawing font.
`void`	`setFontSize(int size)` Sets the size of the drawing font.
`void`	`setFontStyle(TextRenderer.FontStyle style)` Sets the style of the drawing font.
`void`	`setLineWidth(long lineWidth)` Sets the current drawing line width.
`void`	`setPosition(long[] position)` Sets this DrawingHelper's current drawing position.
`void`	`setPreferredChannel(long channelNumber)` Set the preferred channel to draw on.
`void`	`setTextAntialiasing(boolean value)` Turns antialiasing of drawn text on (true) or off (false)
`void`	`setTextRenderer(TextRenderer renderer)`
`void`	`setUAxis(int axisNum)` Sets the U axis index this DrawingTool will work in.
`void`	`setVAxis(int axisNum)` Sets the V axis index this DrawingTool will work in.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DrawingTool
```
public DrawingTool(Dataset ds,
                   RenderingService service)
```
    Creates a DrawingTool to modify a specified Dataset. Will draw pixel values using current channel values (default all zero). After construction the default U axis will be the first non-channel axis. The default V axis will be the second non-channel axis.
- Method Detail
  - setPreferredChannel
```
public void setPreferredChannel(long channelNumber)
```
    Set the preferred channel to draw on. By default drawing takes place across all channels of the current plane. If you specify a nonnegative channel number with this method drawing will be restricted to that channel. If the channel number specified is negative then drawing is done on all channels. In general one should specify setPreferredChannel(-1) to undo any specification of a preferred channel.
    
    Parameters:
    
    channelNumber -
  - getDataset
```
public Dataset getDataset()
```
    Return the Dataset associated with this DrawingTool.
  - setUAxis
```
public void setUAxis(int axisNum)
```
    Sets the U axis index this DrawingTool will work in.
  - getUAxis
```
public int getUAxis()
```
    Returns the index of the U axis of this Drawing Tool.
  - setVAxis
```
public void setVAxis(int axisNum)
```
    Sets the V axis index this DrawingTool will work in.
  - getVAxis
```
public int getVAxis()
```
    Returns the index of the V axis of this Drawing Tool.
  - setPosition
```
public void setPosition(long[] position)
```
    Sets this DrawingHelper's current drawing position. Usually specified once before a series of drawing operations are done. Useful for changing the drawing plane position quickly. Also useful when changing U or V axes.
  - getPosition
```
public void getPosition(long[] position)
```
    Gets this DrawingHelper's current drawing position.
  - getChannels
```
public ChannelCollection getChannels()
```
  - setChannels
```
public void setChannels(ChannelCollection chans)
```
  - setLineWidth
```
public void setLineWidth(long lineWidth)
```
    Sets the current drawing line width. This affects how other methods draw such as lines, circles, dots, etc.
  - getLineWidth
```
public long getLineWidth()
```
    Gets the current drawing line width.
  - setTextRenderer
```
public void setTextRenderer(TextRenderer renderer)
```
  - setFontFamily
```
public void setFontFamily(TextRenderer.FontFamily family)
```
    Sets the family name of the drawing font.
  - getFontFamily
```
public TextRenderer.FontFamily getFontFamily()
```
    Gets the family name of the drawing font.
  - setFontStyle
```
public void setFontStyle(TextRenderer.FontStyle style)
```
    Sets the style of the drawing font.
  - getFontStyle
```
public TextRenderer.FontStyle getFontStyle()
```
    Gets the style of the drawing font.
  - setFontSize
```
public void setFontSize(int size)
```
    Sets the size of the drawing font.
  - getFontSize
```
public int getFontSize()
```
    Gets the size of the drawing font.
  - setTextAntialiasing
```
public void setTextAntialiasing(boolean value)
```
    Turns antialiasing of drawn text on (true) or off (false)
  - getTextAntialiasing
```
public boolean getTextAntialiasing()
```
    Get the drawn text antialiasing value: on (true) or off (false)
  - drawPixel
```
public void drawPixel(long u,
                      long v)
```
    Draws a pixel in the current UV plane at specified UV coordinates.
  - drawDot
```
public void drawDot(long u,
                    long v)
```
    Draws a dot in the current UV plane at specified UV coordinates. The size of the dot is determined by the current line width.
  - moveTo
```
public void moveTo(long u,
                   long v)
```
    Moves the drawing origin of the current UV plane to the specified coordinates.
  - lineTo
```
public void lineTo(long u1,
                   long v1)
```
    Draws a line in the current UV plane from the current origin to the specified coordinate.
  - drawLine
```
public void drawLine(long u1,
                     long v1,
                     long u2,
                     long v2)
```
    Draws a line from (u1,v1) to (u2,v2).
  - fillCircle
```
public void fillCircle(long uc,
                       long vc)
```
    Draws a filled circle in the current UV plane centered at the specified UV coordinates. The radius of the circle is equals the current line width.
  - drawRect
```
public void drawRect(long uOrg,
                     long vOrg,
                     long w,
                     long h)
```
    Draws the outline of a rectangle in the current UV plane. Uses given width, height, and origin.
  - fillRect
```
public void fillRect(long uOrigin,
                     long vOrigin,
                     long w,
                     long h)
```
    Draws a filled rectangle in the current UV plane. Uses given width, height, and origin.
  - fill
```
public void fill()
```
    Fills the current UV plane.
  - drawText
```
public void drawText(long anchorU,
                     long anchorV,
                     String text,
                     TextRenderer.TextJustification just)
```
    Draws a line of text along the U axis

Class DrawingTool

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DrawingTool

Method Detail

setPreferredChannel

getDataset

setUAxis

getUAxis

setVAxis

getVAxis

setPosition

getPosition

getChannels

setChannels

setLineWidth

getLineWidth

setTextRenderer

setFontFamily

getFontFamily

setFontStyle

getFontStyle

setFontSize

getFontSize

setTextAntialiasing

getTextAntialiasing

drawPixel

drawDot

moveTo

lineTo

drawLine

fillCircle

drawRect

fillRect

fill

drawText