HitTest Method (original) (raw)

Summary

Performs hit-testing on this AnnObject.

Syntax

C#

Objective-C

C++/CLI

Java

Python

- (BOOL)hitTest:(LeadPointD)point buffer:(double)buffer; 

Parameters

hitTestBuffer
Threshold buffer value, in container units.

Return Value

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

Remarks hitTestBuffer is used to make the test point "bigger" to compensate for errors and provide smoother hit-testing. For example, if buffer is 2, a square with a length of 4 units 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.