Stay organized with collections
Save and categorize content based on your preferences.
PointerProperties
class PointerProperties
Transfer object for pointer properties. Objects of this type can be used to specify the pointer id and tool type when creating new MotionEvent objects and to query pointer properties in bulk.
Summary
| Public constructors |
|
Creates a pointer properties object with an invalid pointer id.
|
|
Creates a pointer properties object as a copy of the contents of another pointer properties object.
|
| Public methods |
| Unit |
Resets the pointer properties to their initial values.
|
| Unit |
Copies the contents of another pointer properties object.
|
| Boolean |
Indicates whether some other object is "equal to" this one.
|
| Int |
|
| Properties |
| Int |
The pointer id.
|
| Int |
The pointer tool type.
|
Public constructors
PointerProperties
PointerProperties()
Creates a pointer properties object with an invalid pointer id.
PointerProperties
PointerProperties(other: MotionEvent.PointerProperties!)
Creates a pointer properties object as a copy of the contents of another pointer properties object.
Public methods
clear
fun clear(): Unit
Resets the pointer properties to their initial values.
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x, x.equals(x) should return true.
- It is symmetric: for any non-null reference values
x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
- It is transitive: for any non-null reference values
x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
- It is consistent: for any non-null reference values
x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
- For any non-null reference value
x, x.equals(null) should return false.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters |
obj |
the reference object with which to compare. |
other |
Any?: This value may be null. |
| Return |
Boolean |
true if this object is the same as the obj argument; false otherwise. |
hashCode
fun hashCode(): Int
| Return |
Int |
a hash code value for this object. |
Properties
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# MotionEvent.PointerProperties\n\nAdded in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nPointerProperties\n=================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/view/MotionEvent.PointerProperties \"View this page in Java\") \n\n```\nclass PointerProperties\n```\n\n|---|-------------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [android.view.MotionEvent.PointerProperties](#) |\n\nTransfer object for pointer properties. Objects of this type can be used to specify the pointer id and tool type when creating new [MotionEvent](/reference/kotlin/android/view/MotionEvent) objects and to query pointer properties in bulk.\n\nSummary\n-------\n\n| Public constructors ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [PointerProperties](#PointerProperties())`()` Creates a pointer properties object with an invalid pointer id. |\n| [PointerProperties](#PointerProperties(android.view.MotionEvent.PointerProperties))`(`other:` `[MotionEvent.PointerProperties](#)!`)` Creates a pointer properties object as a copy of the contents of another pointer properties object. |\n\n| Public methods ||\n|------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [clear](#clear())`()` Resets the pointer properties to their initial values. |\n| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [copyFrom](#copyFrom(android.view.MotionEvent.PointerProperties))`(`other:` `[MotionEvent.PointerProperties](#)!`)` Copies the contents of another pointer properties object. |\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is \"equal to\" this one. |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](#hashCode())`()` \u003cbr /\u003e |\n\n| Properties ||\n|----------------------------------------------------------------------------|---------------------------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [id](#id:kotlin.Int) The pointer id. |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [toolType](#toolType:kotlin.Int) The pointer tool type. |\n\nPublic constructors\n-------------------\n\n### PointerProperties\n\nAdded in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nPointerProperties()\n```\n\nCreates a pointer properties object with an invalid pointer id. \n\n### PointerProperties\n\nAdded in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nPointerProperties(other: MotionEvent.PointerProperties!)\n```\n\nCreates a pointer properties object as a copy of the contents of another pointer properties object.\n\n| Parameters ||\n|---------|--------------------------------------|\n| `other` | [MotionEvent.PointerProperties](#)!: |\n\nPublic methods\n--------------\n\n### clear\n\nAdded in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun clear(): Unit\n```\n\nResets the pointer properties to their initial values. \n\n### copyFrom\n\nAdded in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun copyFrom(other: MotionEvent.PointerProperties!): Unit\n```\n\nCopies the contents of another pointer properties object.\n\n| Parameters ||\n|---------|-----------------------------------------------------------------------------|\n| `other` | [MotionEvent.PointerProperties](#)!: The pointer properties object to copy. |\n\n### equals\n\nAdded in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun equals(other: Any?): Boolean\n```\n\nIndicates whether some other object is \"equal to\" this one.\n\nThe `equals` method implements an equivalence relation on non-null object references:\n\n- It is *reflexive* : for any non-null reference value `x`, `x.equals(x)` should return `true`.\n- It is *symmetric* : for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.\n- It is *transitive* : for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.\n- It is *consistent* : for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.\n- For any non-null reference value `x`, `x.equals(null)` should return `false`.\n\nAn equivalence relation partitions the elements it operates on into *equivalence classes*; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.\n\n| Parameters ||\n|---------|--------------------------------------------------------------------------------------------------------|\n| `obj` | the reference object with which to compare. |\n| `other` | [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?: This value may be `null`. |\n\n| Return ||\n|------------------------------------------------------------------------------------|---------------------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if this object is the same as the obj argument; `false` otherwise. |\n\n### hashCode\n\nAdded in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nfun hashCode(): Int\n```\n\n| Return ||\n|----------------------------------------------------------------------------|------------------------------------|\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |\n\nProperties\n----------\n\n### id\n\nAdded in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nvar id: Int\n```\n\nThe pointer id. Initially set to [INVALID_POINTER_ID](/reference/kotlin/android/view/MotionEvent#INVALID_POINTER_ID:kotlin.Int) (-1). \n**See Also**\n\n- [android.view.MotionEvent#getPointerId(int)](/reference/kotlin/android/view/MotionEvent#getPointerId(kotlin.Int)) \n\n### toolType\n\nAdded in [API level 14](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nvar toolType: Int\n```\n\nThe pointer tool type. Initially set to 0. \nValue is [android.view.MotionEvent#TOOL_TYPE_UNKNOWN](/reference/kotlin/android/view/MotionEvent#TOOL_TYPE_UNKNOWN:kotlin.Int), [android.view.MotionEvent#TOOL_TYPE_FINGER](/reference/kotlin/android/view/MotionEvent#TOOL_TYPE_FINGER:kotlin.Int), [android.view.MotionEvent#TOOL_TYPE_STYLUS](/reference/kotlin/android/view/MotionEvent#TOOL_TYPE_STYLUS:kotlin.Int), [android.view.MotionEvent#TOOL_TYPE_MOUSE](/reference/kotlin/android/view/MotionEvent#TOOL_TYPE_MOUSE:kotlin.Int), [android.view.MotionEvent#TOOL_TYPE_ERASER](/reference/kotlin/android/view/MotionEvent#TOOL_TYPE_ERASER:kotlin.Int), or android.view.MotionEvent.TOOL_TYPE_PALM \n**See Also**\n\n- [android.view.MotionEvent#getToolType(int)](/reference/kotlin/android/view/MotionEvent#getToolType(kotlin.Int))"]]
