HitTest Method

Summary

Retrieves the object at the specified coordinates.

Syntax

C++

public virtual AnnObject HitTest( 
   AnnPoint testPoint, 
   int buffer 
)

  
Public Overridable Function HitTest( _ 
   ByVal testPoint As Leadtools.Annotations.AnnPoint, _ 
   ByVal buffer As Integer _ 
) As Leadtools.Annotations.AnnObject

public: 
virtual Leadtools.Annotations.AnnObject^ HitTest(  
   Leadtools.Annotations.AnnPoint testPoint, 
   int buffer 
)

Parameters

testPoint
The AnnPoint to be tested.

buffer
Threshold buffer value.

Return Value

An AnnObject that represents the object at the given screen coordinates; or null (Nothing in VB) if no object is at the tested location.

Remarks

testPoint should be in physical coordinates.

buffer 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 pixels around testPoint will be used to perform the hit-testing.

If more than one object overlaps underneath the test point, the method will return the object on top of the Z-order.

Example

For an example, refer to AnnContainer.

Requirements

Target Platforms