InkUtils Class Reference

List of all members.

Static Public Member Functions
static List< Ink >	clusterStrokes (List< InkStroke > strokes, final double margin)
	Clusters a list of strokes into a list of list of strokes.
static List< InkStroke >	getAllStrokesContainedWithin (List< Ink > inkWell, InkStroke container)
	Finds all the strokes contained within another stroke's bounding box.
static List< InkStroke >	getAllStrokesOutside (List< Ink > inkWell, InkStroke container)
	Finds all strokes outside a containing stroke (no overlap).
static Ink	getInkNearPoint (List< Ink > inkWell, Point2D point, double range)
	Finds the first clusters near a particular point (perhaps revise to find nearest cluster).
static double	getMaxDistanceBetweenSamples (InkStroke stroke)
static List< InkStroke >	getStrokesPartlyOutside (List< Ink > inkWell, InkStroke container)
	Finds all strokes that intersect with but are not entirely contained by another stroke.
static InkStroke	getStrokeWithLargestArea (List< Ink > inkWell)
	Finds the stroke with the largest area within a list of clusters.
static Ink	getStrokeWithMostSamples (Ink ink)
	Use this in the example!
HideFromFlash static void	main (String[] args)
Package Functions
	HideFromFlash () public static List< Method > getExposedMethods()
	Last year's Remote API fun was actually useful! Wow.

---

Detailed Description

Integrate all the nice features that we can use to analyze ink into this class.

This software is distributed under the BSD License.

Author:

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

Definition at line 25 of file InkUtils.java.

---

Member Function Documentation

static List<Ink> clusterStrokes	(	List< InkStroke >	strokes,
		final double	margin
	)			[static]

Clusters a list of strokes into a list of list of strokes.

The margin allows you to control how big the compared bounding boxes are. A margin of 2.0 would double the width and height of each bounding box before making intersection comparisons.

Parameters:

	strokes	list of strokes to group
	margin	the fraction of each stroke size to check for overlap

Returns:

a list of inkstroke clusters

Definition at line 38 of file InkUtils.java.

References InkStroke.getBounds().

static List<InkStroke> getAllStrokesContainedWithin	(	List< Ink >	inkWell,
		InkStroke	container
	)			[static]

Finds all the strokes contained within another stroke's bounding box.

Parameters:

	inkWell	the strokes to check
	container	the containing stroke

Returns:

a list of strokes within the container

Definition at line 94 of file InkUtils.java.

References InkStroke.getBounds().

static List<InkStroke> getAllStrokesOutside	(	List< Ink >	inkWell,
		InkStroke	container
	)			[static]

Finds all strokes outside a containing stroke (no overlap).

Parameters:

	inkWell	the list of strokes to check
	container	the containing stroke

Returns:

a list of strokes not within the container

Definition at line 123 of file InkUtils.java.

References InkStroke.getBounds().

static Ink getInkNearPoint	(	List< Ink >	inkWell,
		Point2D	point,
		double	range
	)			[static]

Finds the first clusters near a particular point (perhaps revise to find nearest cluster).

Parameters:

	inkWell	list of clusters
	point	the point to compare to
	range	number of units away from the point to check

Returns:

the first cluster near the point

Definition at line 182 of file InkUtils.java.

static double getMaxDistanceBetweenSamples

(

InkStroke

stroke

)

[static]

Parameters:

stroke

Returns:

Definition at line 197 of file InkUtils.java.

References InkStroke.getSamples().

static List<InkStroke> getStrokesPartlyOutside	(	List< Ink >	inkWell,
		InkStroke	container
	)			[static]

Finds all strokes that intersect with but are not entirely contained by another stroke.

Parameters:

	inkWell	the list of strokes
	container	the containing stroke

Returns:

a list of strokes that are partly inside and outside the container

Definition at line 217 of file InkUtils.java.

References InkStroke.getBounds().

static InkStroke getStrokeWithLargestArea

(

List< Ink >

inkWell

)

[static]

Finds the stroke with the largest area within a list of clusters.

Parameters:

inkWell

the list of clusters

Returns:

the inkstroke with the largest area

Definition at line 245 of file InkUtils.java.

References InkStroke.getArea().

static Ink getStrokeWithMostSamples

(

Ink

ink

)

[static]

Use this in the example!

Parameters:

ink

Returns:

Definition at line 271 of file InkUtils.java.

References Ink.getStrokes().

HideFromFlash

(

)

[package]

Last year's Remote API fun was actually useful! Wow.

Returns:

Definition at line 147 of file InkUtils.java.

HideFromFlash static void main

(

String[]

args

)

[static]

Parameters:

args

Definition at line 297 of file InkUtils.java.

---

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

• InkUtils.java

---