API reference

Select your platform

No SDKs available

No versions available

Overview

com.meta.spatial.animation

com.meta.spatial.castinputforward

com.meta.spatial.compose

com.meta.spatial.core

com.meta.spatial.datamodelinspector

com.meta.spatial.debugtools

com.meta.spatial.isdk

com.meta.spatial.mruk

com.meta.spatial.ovrmetrics

com.meta.spatial.physics

com.meta.spatial.runtime

ButtonHoverMoveEventArgs

ButtonReleaseEventArgs

SceneMaterialAttribute

SceneMaterialDataType

com.meta.spatial.runtime.panel

com.meta.spatial.toolkit

com.meta.spatial.toolkit.inflate

ButtonClickEventArgs

class ButtonClickEventArgs(val hitInfo: HitInfo, val dataModel: DataModel) : EventArgs

Event arguments for button click events.

ButtonClickEventArgs is used to pass information about a button click interaction through the event system. It contains a HitInfo object that provides details about the interaction, such as the hit point, normal, and distance.

This class is typically used when registering event listeners for button click events on entities, allowing components to respond to user interactions.

Example usage:

// Register a button click event listener on an entity
entity.registerEventListener<ButtonClickEventArgs>(ButtonClickEventArgs.EVENT_NAME) { entity, eventArgs ->
    // Handle the button click event
    val hitPoint = eventArgs.hitInfo.hitPoint
    // Perform actions based on the click
}

// Send a button click event to an entity
dataModel.sendEvent(
    entity,
    ButtonClickEventArgs.EVENT_NAME,
    ButtonClickEventArgs.fromHitInfo(hitInfo, dataModel)
)

Constructors

Name	Summary
ButtonClickEventArgs	constructor(hitInfo: HitInfo, dataModel: DataModel)

Types

Name	Summary
Companion	object Companion

Properties

Name	Summary
dataModel	val dataModel: DataModel
eventName	val eventName: String
handled	var handled: Boolean
hitInfo	val hitInfo: HitInfo Information about the hit/interaction that triggered the button click
throttleTime	var throttleTime: Int?

Companion

object Companion

Properties

Name	Summary
EVENT_NAME	const val EVENT_NAME: String The name of the button click event, used when registering event listeners.

Functions

Name	Summary
fromHitInfo	fun fromHitInfo(hitInfo: HitInfo, dataModel: DataModel): ButtonClickEventArgs Creates a ButtonClickEventArgs instance from a HitInfo object and DataModel.