hitTest Method

Summary

Performs hit-testing on this AnnObject.

Syntax

JavaScript Syntax

AnnObject.prototype.hitTest = function( 
   point, 
   hitTestBuffer 
)

TypeScript Syntax

hitTest( 
   point: LeadPointD, 
   hitTestBuffer: number 
): boolean;

Parameters

point

The LeadPointD to be tested.

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.

Requirements

Target Platforms

Reference

AnnObject Class

AnnObject Members

Leadtools.Annotations.Core Namespace

Help Version 19.0.2017.10.27

Leadtools.Annotations.Core Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Core Namespace

Assemblies