Packagenet.reclipse.handwriting
Classpublic dynamic class InkTimeline

Class for handling ink points. Includes a public Array instance for InkPoint storage.



Public Properties
 PropertyDefined by
  array : Array
InkTimeline
  height : Number
[read-only] A bounding box-like structure.
InkTimeline
  latestStroke : InkTimeline
[read-only] Uses pressure data to find the last stroke in the collection of strokes.
InkTimeline
  maxX : Number
[read-only] Point with the greatest x coordinate.
InkTimeline
  maxY : Number
[read-only] Point with the greatest y coordinate.
InkTimeline
  minX : Number
[read-only] Point with the least x coordinate.
InkTimeline
  minY : Number
[read-only] Point with the least y coordinate.
InkTimeline
  ratioWH : Number
[read-only] The width:height ratio.
InkTimeline
  segmentClassifications : Array
InkTimeline
  segmented : Boolean = false
InkTimeline
  segmentPartitions : Array
InkTimeline
  segments : Array
InkTimeline
  signature : Array
InkTimeline
  splitPartitions : Array
InkTimeline
  width : Number
[read-only] A bounding box-like structure.
InkTimeline
Public Methods
 MethodDefined by
  
InkTimeline(inputArray:Array = null)
Constructor.
InkTimeline
  
Makes a copy of the InkTimeline instance.
InkTimeline
  
intersectsWith(_otherInk:InkTimeline, leniency:Number = 0):Boolean
Determines whether or not two InkTimeline's bounding boxes intersect.
InkTimeline
  
isDotAbove(_otherInk:InkTimeline, leniency:Number = 0):Boolean
Determines if the latest stroke is a 'dot'-like structure above the previous stroke.
InkTimeline
  
Joins two InkTimelines.
InkTimeline
  
normalize():void
Removes duplicate directional values.
InkTimeline
  
segment(_splitPoints:Array):void
Segments the InkTimeline into Arrays based on pivot points.
InkTimeline
Public Constants
 ConstantDefined by
  SEGMENT_FOUR : int = 4
[static]
InkTimeline
  SEGMENT_ONE : int = 1
[static]
InkTimeline
  SEGMENT_POINT_ABOVE : int = 5
[static]
InkTimeline
  SEGMENT_STRAIGHT : int = 0
[static]
InkTimeline
  SEGMENT_THREE : int = 3
[static]
InkTimeline
  SEGMENT_TWO : int = 2
[static]
InkTimeline
Property detail
arrayproperty
public var array:Array
heightproperty 
height:Number  [read-only]

A bounding box-like structure.

Implementation
    public function get height():Number
latestStrokeproperty 
latestStroke:InkTimeline  [read-only]

Uses pressure data to find the last stroke in the collection of strokes.

Implementation
    public function get latestStroke():InkTimeline
maxXproperty 
maxX:Number  [read-only]

Point with the greatest x coordinate.

Implementation
    public function get maxX():Number
maxYproperty 
maxY:Number  [read-only]

Point with the greatest y coordinate.

Implementation
    public function get maxY():Number
minXproperty 
minX:Number  [read-only]

Point with the least x coordinate.

Implementation
    public function get minX():Number
minYproperty 
minY:Number  [read-only]

Point with the least y coordinate.

Implementation
    public function get minY():Number
ratioWHproperty 
ratioWH:Number  [read-only]

The width:height ratio.

Implementation
    public function get ratioWH():Number
segmentClassificationsproperty 
public var segmentClassifications:Array
segmentedproperty 
public var segmented:Boolean = false
segmentPartitionsproperty 
public var segmentPartitions:Array
segmentsproperty 
public var segments:Array
signatureproperty 
public var signature:Array
splitPartitionsproperty 
public var splitPartitions:Array
widthproperty 
width:Number  [read-only]

A bounding box-like structure.

Implementation
    public function get width():Number
Constructor detail
InkTimeline()constructor
public function InkTimeline(inputArray:Array = null)

Constructor. The input Array is controlled to allow only Array or InkTimeline elements.

Parameters
inputArray:Array (default = null) — The Array of InkPoints or Array of Arrays of InkPoints.
Method detail
clone()method
public function clone(original:InkTimeline):InkTimeline

Makes a copy of the InkTimeline instance.

Parameters
original:InkTimeline

Returns
InkTimeline — A copy.
intersectsWith()method 
public function intersectsWith(_otherInk:InkTimeline, leniency:Number = 0):Boolean

Determines whether or not two InkTimeline's bounding boxes intersect.

Parameters
_otherInk:InkTimeline — The InkTimeline to check.
 
leniency:Number (default = 0) — Extends the bounding box to be lenient.

Returns
Boolean — The result of the check.
isDotAbove()method 
public function isDotAbove(_otherInk:InkTimeline, leniency:Number = 0):Boolean

Determines if the latest stroke is a 'dot'-like structure above the previous stroke.

Parameters
_otherInk:InkTimeline — The InkTimeline to check against.
 
leniency:Number (default = 0) — Extendes the bounding box to be lenient.

Returns
Boolean — The result of the check.
joinWith()method 
public function joinWith(_moreInk:InkTimeline):InkTimeline

Joins two InkTimelines. Useful if the two intersect or one is a dot.

Parameters
_moreInk:InkTimeline — The InkTimeline that will be combined.

Returns
InkTimeline — The resulting InkTimeline.
normalize()method 
public function normalize():void

Removes duplicate directional values.

segment()method 
public function segment(_splitPoints:Array):void

Segments the InkTimeline into Arrays based on pivot points.

Parameters
_splitPoints:Array — The pivot points.
Constant detail
SEGMENT_FOURconstant
public static const SEGMENT_FOUR:int = 4
SEGMENT_ONEconstant 
public static const SEGMENT_ONE:int = 1
SEGMENT_POINT_ABOVEconstant 
public static const SEGMENT_POINT_ABOVE:int = 5
SEGMENT_STRAIGHTconstant 
public static const SEGMENT_STRAIGHT:int = 0
SEGMENT_THREEconstant 
public static const SEGMENT_THREE:int = 3
SEGMENT_TWOconstant 
public static const SEGMENT_TWO:int = 2