com.smarttech.boardtoolid

Class PointerProperties

java.lang.Object

com.smarttech.boardtoolid.PointerProperties

public class PointerProperties
extends java.lang.Object

Provide access to SMART ToolSense data in android.view.MotionEvent.PointerProperties

This class returns ToolId16 ToolType and PreferredToolColorIndex or ToolSense ToolSense for a given MotionEvent pointer

The following code fragment illustrates a method to obtain SMART ToolSense data from Android MotionEvent#PointerProperties

       //
       // Class member variables for Android MotionEvent#PointerProperties and
       // SMART ToolSense PointerProperties.  We allocate the objects once and
       // reuse it for all MotionEvent.
       //
       MotionEvent.PointerProperties motionEventPointerProperties = new MotionEvent.PointerProperties();
       com.smarttech.boardtoolid.PointerProperties toolSensePointerProperties = new com.smarttech.boardtoolid.PointerProperties(motionEventPointerProperties);

       public boolean onTouchEvent(MotionEvent event) {
           int pointerCount = event.getPointerCount();
           for (int idx = 0; idx < pointerCount; ++idx) {
               int pointer_id = event.getPointerId(idx);
               int tool_type = event.getToolType(idx);
               //
               // Obtain Android MotionEvent.PointerProperties for the current pointer Id
               //
               event.getPointerProperties(idx, motionEventPointerProperties);
               //
               // toolSensePointerProperties object has already been associated with
               // motionEventPointerProperties.  Thus, we can obtain ToolSense ToolType and
               // PreferredToolColorIndex directly from toolSensePointerProperties
               //
               com.smarttech.boardtoolid.ToolType extended_tool_type =
                   toolSensePointerProperties.getExtendedToolType();
               if (extended_tool_type != ToolType.ToolSense) {
                   com.smarttech.boardtoolid.PreferredToolColorIndex preferred_tool_color_index =
                       toolSensePointerProperties.getPreferredToolColorIndex();
                   // Application logic to process ToolId16 data...
               } else {
                   com.smarttech.boardtoolid.ToolSense tool_sense =
                       toolSensePointerProperties.getToolSense();
                   // Application logic to process ToolSense data...
               }
           }
       }
 

Constructor Summary

Constructors

Constructor and Description
PointerProperties(android.view.MotionEvent.PointerProperties motionEventPointerProperties) Constructor

Method Summary

Modifier and Type	Method and Description
int	copySerialNumber(byte[] outSerialNumber) Deprecated
ToolType	getExtendedToolType() Return ToolSense tool type for a given MotionEvent pointer
PreferredToolColorIndex	getPreferredToolColorIndex() Return preferred tool color index for a given MotionEvent pointer
byte[]	getSerialNumber() Deprecated
int	getSerialNumberLength() Deprecated
ToolSense	getToolSense() Return ToolSense record blob associated with a touch contact

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PointerProperties

public PointerProperties(android.view.MotionEvent.PointerProperties motionEventPointerProperties)

Constructor

This class does not make a deep copy of android.view.MotionEvent.PointerProperties. Thus, it is more efficient to allocate this object and android.view.MotionEvent#PointerProperties once, and reuse it for all MotionEvents.

Parameters:

motionEventPointerProperties - Extract ToolSense data from a given MotionEvent.PointerProperties

See Also:

ToolType, PreferredToolColorIndex

Method Detail

getExtendedToolType

public ToolType getExtendedToolType()

Return ToolSense tool type for a given MotionEvent pointer

ToolSense tool type represents additional tool types that are not defined in Android MotionEvent TOOL_TYPE_* constants

• Added in SDK level 1

Returns:

Return ToolType for a given MotionEvent pointer
If ToolSense is not supported, ToolType.Unknown is returned instead

getPreferredToolColorIndex

public PreferredToolColorIndex getPreferredToolColorIndex()

Return preferred tool color index for a given MotionEvent pointer

Preferred tool color index contains symbolic name of a color. The name is defined in Appendix D in USB HID HUTRR53 "Stylus Preferred ink Color" Callers may use PreferredToolColorLookupTable to lookup color value for a given tool color index

• Added in SDK level 1

Returns:

Return PreferredToolColorIndex for a given MotionEvent pointer
If ToolSense is not supported, PreferredToolColorIndex.Unknown is returned instead

getSerialNumberLength

public int getSerialNumberLength()

Deprecated

• Added in SDK level 1

• Deprecated in SDK level 2

Returns:

Always return 0

getSerialNumber

public byte[] getSerialNumber()

Deprecated

• Added in SDK level 1

• Deprecated in SDK level 2

Returns:

Always return null

copySerialNumber

public int copySerialNumber(byte[] outSerialNumber)

Deprecated

• Added in SDK level 1

• Deprecated in SDK level 2

Returns:

Always return 0

getToolSense

public ToolSense getToolSense()

Return ToolSense record blob associated with a touch contact

• Added in SDK level 2

Returns:

If ToolSense is not available, returns null