Class Index | File Index

Classes


Class gui.LineBoundaryScanner


Defined in: LineBoundaryScanner.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Finds line-wrap points by comparing the visual overlap between visible rectangles.
Method Summary
Method Attributes Method Name and Description
<inner>  
combineRects(rect1, rect2)
<inner>  
growRect(originalRect, newRect)
<inner>  
isLineBoundary(nextRect)
Returns true if the amount of overlap between the known line rectangle and the visible next rectangle is below the specified MIN_OVERLAP_THRESHOLD.
 
process(stepInfo, previousRect, nextRect)
<inner>  
verticalOverlapPercent(rect1, rect2)
Return the fraction of overlap between two rectangles.
Class Detail
gui.LineBoundaryScanner()
Finds line-wrap points by comparing the visual overlap between visible rectangles.
Method Detail
<inner> {!core.SimpleClientRect} combineRects(rect1, rect2)
Parameters:
{!core.SimpleClientRect} rect1
{!core.SimpleClientRect} rect2
Returns:
{!core.SimpleClientRect}

<inner> {?core.SimpleClientRect} growRect(originalRect, newRect)
Parameters:
{?core.SimpleClientRect} originalRect
{?core.SimpleClientRect} newRect
Returns:
{?core.SimpleClientRect}

<inner> {!boolean} isLineBoundary(nextRect)
Returns true if the amount of overlap between the known line rectangle and the visible next rectangle is below the specified MIN_OVERLAP_THRESHOLD. If there is no known line rectangle, this will return false.
Parameters:
{!core.SimpleClientRect} nextRect
Client rect of next step (by direction)
Returns:
{!boolean}

{!boolean} process(stepInfo, previousRect, nextRect)
Parameters:
{!gui.StepInfo} stepInfo
{?ClientRect} previousRect
{?ClientRect} nextRect
Returns:
{!boolean}

<inner> {!number} verticalOverlapPercent(rect1, rect2)
Return the fraction of overlap between two rectangles. If there is no overlap, or either of the rectangles is 0 height, this will return 0.
Parameters:
{!core.SimpleClientRect} rect1
{!core.SimpleClientRect} rect2
Returns:
{!number}

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Aug 06 2015 04:10:40 GMT+0200 (MESZ)