RotaryScrollEvent.kt

/*
 * Copyright 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package androidx.compose.ui.input.rotary

import androidx.compose.ui.ExperimentalComposeUiApi
import androidx.compose.ui.input.focus.FocusAwareEvent

/**
 * This event represents a rotary input event.
 *
 * Some Wear OS devices contain a physical rotating side button, or a rotating bezel. When the user
 * turns the button or rotates the bezel, a [RotaryScrollEvent] is sent to the item in focus.
 */
@ExperimentalComposeUiApi
class RotaryScrollEvent internal constructor(
    /**
     * The amount to scroll (in pixels) in response to a [RotaryScrollEvent] in a container that
     * can scroll vertically.
     */
    val verticalScrollPixels: Float,

    /**
     * The amount to scroll (in pixels) in response to a [RotaryScrollEvent] in a container that
     * can scroll horizontally.
     */
    val horizontalScrollPixels: Float
) : FocusAwareEvent {
    override fun equals(other: Any?): Boolean = other is RotaryScrollEvent &&
        other.verticalScrollPixels == verticalScrollPixels &&
        other.horizontalScrollPixels == horizontalScrollPixels

    override fun hashCode(): Int = 0
            .let { 31 * it + verticalScrollPixels.hashCode() }
            .let { 31 * it + horizontalScrollPixels.hashCode() }

    override fun toString(): String = "RotaryScrollEvent(" +
        "verticalScrollPixels=$verticalScrollPixels," +
        "horizontalScrollPixels=$horizontalScrollPixels)"
}