Ink Class Reference

List of all members.

Public Types
	BATCHED
enum	InkSource { BATCHED, STREAMED, UNKNOWN }
Public Member Functions
	Ink ()
	New ink object w/ an empty array of strokes.
	Ink (File xmlFile)
	Create an ink object from a serialized XML file.
	Ink (List< InkStroke > theStrokes)
void	addStroke (InkStroke s)
String	getAsXML ()
String	getAsXML (boolean useSeparatorLines)
	Represents this Ink object as an XML string.
Color	getColor ()
String	getInnerXML ()
String	getInnerXML (boolean useSeparatorLines)
double	getMaxX ()
double	getMaxY ()
double	getMinX ()
double	getMinY ()
String	getName ()
int	getNumStrokes ()
InkRenderer	getRenderer ()
PageAddress	getSourcePageAddress ()
InkSource	getSourceType ()
List< InkStroke >	getStrokes ()
void	loadFromXMLFile (File xmlFileSource)
	Load strokes and other information from an xml file.
void	removeStroke (InkStroke s)
File	renderToJPEGFile ()
void	resetColor ()
	Start over.
void	saveToXMLFile (File xmlFileDest)
	Save this object out as an XML file.
void	setColor (Color c)
void	setName (String theName)
	Use this for anything you like.
void	setSourcePageAddress (PageAddress address)
	Set the Anoto page address that we got this Ink object from.
void	setSourcePageAddress (String pageAddrString)
void	setSourceType (InkSource src)

---

Detailed Description

On its surface, this is just a List<InkStroke>... However, this class will provide nice functions for clustering strokes, selecting strokes, etc.

This software is distributed under the BSD License.

Author:

Ron B Yeh (ronyeh(AT)cs.stanford.edu)

Definition at line 28 of file Ink.java.

---

Member Enumeration Documentation

enum InkSource

Helps us determine where we got this ink from. It is not a required field, but is set when it is convenient.

Definition at line 36 of file Ink.java.

---

Constructor & Destructor Documentation

Ink

(

File

xmlFile

)

Create an ink object from a serialized XML file.

Parameters:

xmlFile

Definition at line 104 of file Ink.java.

References Ink.loadFromXMLFile().

Ink

(

List< InkStroke >

theStrokes

)

Parameters:

theStrokes

Definition at line 112 of file Ink.java.

---

Member Function Documentation

void addStroke

(

InkStroke

s

)

Parameters:

s

the stroke to be added to the internal list.

Definition at line 124 of file Ink.java.

Referenced by BatchedEventHandler.batchedDataArrived(), GestureDatabase.createBestImage(), GestureDatabase.display(), GestureDatabase.generateGesture(), and PenSimulator.mousePressed().

String getAsXML

(

boolean

useSeparatorLines

)

Represents this Ink object as an XML string.

Parameters:

useSeparatorLines

Returns:

Definition at line 142 of file Ink.java.

References Ink.getInnerXML().

String getAsXML

(

)

Returns:

return an XML representation of this Ink object.

Definition at line 132 of file Ink.java.

Referenced by HandwritingRecognizer.recognizeHandwriting(), and Ink.saveToXMLFile().

Color getColor

(

)

Returns:

Definition at line 155 of file Ink.java.

Referenced by InkPCanvas.addInk(), and InkRenderer.renderToG2D().

String getInnerXML

(

boolean

useSeparatorLines

)

Returns:

the xml without the outer <ink></ink> tags.

Definition at line 166 of file Ink.java.

String getName

(

)

Returns:

Definition at line 204 of file Ink.java.

Referenced by Ink.renderToJPEGFile().

int getNumStrokes

(

)

Returns:

the number of strokes in this ink object.

Definition at line 211 of file Ink.java.

Referenced by CalibrationEngine.alignInkStrokes().

InkRenderer getRenderer

(

)

Returns:

a new Renderer for this Ink object.

Definition at line 229 of file Ink.java.

PageAddress getSourcePageAddress

(

)

Returns:

the page address that generated this ink.

Definition at line 236 of file Ink.java.

Referenced by CalibrationEngine.alignInkStrokes().

InkSource getSourceType

(

)

Returns:

Definition at line 243 of file Ink.java.

List<InkStroke> getStrokes

(

)

Returns:

the strokes that this Ink object comprises.

Definition at line 250 of file Ink.java.

Referenced by InkPCanvas.addInk(), CalibrationEngine.alignInkStrokes(), InkUtils.getStrokeWithMostSamples(), and InkRenderer.renderToG2D().

void loadFromXMLFile

(

File

xmlFileSource

)

Load strokes and other information from an xml file.

It will clear this object before the load occurs, effectively replacing this Ink object with the one represented by the XML file.

Parameters:

xmlFileSource

Definition at line 260 of file Ink.java.

Referenced by Ink.Ink().

void removeStroke

(

InkStroke

s

)

Parameters:

s

Definition at line 267 of file Ink.java.

File renderToJPEGFile

(

)

Parameters:

	w
	h

Definition at line 275 of file Ink.java.

References Ink.getName().

void resetColor

(

)

Start over.

..

Definition at line 287 of file Ink.java.

References Ink.setColor().

void saveToXMLFile

(

File

xmlFileDest

)

Save this object out as an XML file.

Parameters:

xmlFileDest

Definition at line 296 of file Ink.java.

References Ink.getAsXML().

void setColor

(

Color

c

)

Parameters:

c

Definition at line 303 of file Ink.java.

Referenced by Ink.resetColor().

void setName

(

String

theName

)

Use this for anything you like.

It may help in debugging, or uniquely identifying ink clusters.

Parameters:

theName

Definition at line 313 of file Ink.java.

Referenced by BatchedEventHandler.batchedDataArrived().

void setSourcePageAddress

(

String

pageAddrString

)

Parameters:

pageAddrString

Definition at line 331 of file Ink.java.

References Ink.setSourcePageAddress().

void setSourcePageAddress

(

PageAddress

address

)

Set the Anoto page address that we got this Ink object from.

When we do this, it is implied that our sourceType is BATCHED.

Parameters:

address

Definition at line 323 of file Ink.java.

References Ink.setSourceType().

Referenced by BatchedEventHandler.batchedDataArrived(), and Ink.setSourcePageAddress().

void setSourceType

(

InkSource

src

)

Parameters:

src

Definition at line 338 of file Ink.java.

Referenced by Ink.setSourcePageAddress().

---

The documentation for this class was generated from the following file:

• Ink.java

---