hitTest Method

Summary

Performs hit-testing on this AnnPointerObject.

Syntax
TypeScript
JavaScript
AnnPointerObject.prototype.hitTest = function( 
   point, 
   hitTestBuffer 
) 
hitTest( 
   point: LeadPointD, 
   hitTestBuffer: number 
): boolean; 

Parameters

point

The LeadPointD to be tested.

hitTestBuffer

Threshold buffer value, in pixels.

Return Value

true if the test point intersects with the object; otherwise, false.

Remarks

The point should be in physical coordinates.

The hitTestBuffer is used to make the test point "bigger" to compensate for errors and provide smoother hit-testing. For example, if the buffer is 2, a square with a length of 4 pixels around the test point will be used to perform the hit-testing.

By default, an annotation object will return true if hit-testing was satisfied. Derived objects can override this method to fine-tune the return value.

Requirements

Target Platforms

Help Version 20.0.2019.12.4
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Engine Assembly