API reference
API reference
Select your platform
No SDKs available
No versions available

PointerEventType

PointerEventType

enum PointerEventType : Enum<PointerEventType>
Enum class representing different types of pointer events.
A PointerEvent represents some activity on an entity. This enum classifies the nature of the action taken. For example when we start hovering an entity we get a "Hover" type of event.
Notice we do not know if the intent of the user. E.g. is this to grab or select or teleport. See the SemanticType enum for the intent of the interaction.

Entries

NameSummary
Hover
Event triggered when the pointer starts hovering over an entity.
Unhover
Event triggered when the pointer stops hovering over an entity.
Select
Event triggered when the pointer initially selects an entity (i.e. click-down).
Unselect
Event triggered when the pointer stops selecting an entity (i.e. click-up).
Move
Event triggered every frame while hovering or selecting an entity.
Cancel
Event triggered when the pointer event is cancelled (e.g. poke too far through a panel).

Properties

NameSummary
id
val id: Int
name
val name: String
ordinal
val ordinal: Int

Functions

NameSummary
valueOf
fun valueOf(value: String): PointerEventType
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
values
fun values(): Array<PointerEventType>
Returns an array containing the constants of this enum type, in the order they’re declared.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon