HitTest Method

Summary

Queries the specified location to determine if a test point is over the thumb.

Syntax

Objective-C

C++/CLI

Java

public virtual bool HitTest( 
   LeadPointD location, 
   LeadPointD testPoint, 
   double hitTestBuffer 
)

- (BOOL)hitTestPoint:(LeadPointD)location 
           testPoint:(LeadPointD)testPoint 
              buffer:(double)buffer

public boolean hitTest( 
   LeadPointD location, 
   LeadPointD testPoint, 
   double hitTestBuffer 
);

public:  
   virtual bool HitTest( 
      LeadPointD^ location, 
      LeadPointD^ testPoint, 
      double hitTestBuffer 
   )

Parameters

location
The location of the thumb to test in container coordinates.

testPoint
The point to test in container coordinates.

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

Return Value

true if the specified test point is over the thumb, otherwise; false.

Remarks

The automation framework will call HitTest repeatedly to determine if a user input location is over a thumb. For example, to determine if the framework should start dragging a side of a selected object or to start rotating it.

Requirements

Target Platforms