/*
 * Copyright (C) 2024 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 com.android.wallpaper.picker.preview.shared.model

import android.graphics.Point
import android.graphics.Rect

/**
 * Data class represents user's cropHint for a dimension.
 *
 * It could be one of below:
 * 1. A current wallpaper crop.
 * 2. User's crop via full preview.
 * 3. Default crop from small preview.
 *
 * Only #2 will it contains [cropSizeModel], the other cases parallax (0 for #3) has already
 * included in [cropHint].
 */
data class FullPreviewCropModel(
    /** The user's crop of wallpaper based on the full wallpaper size. */
    val cropHint: Rect,
    /** The data required to compute parallax for this crop, null for no parallax. */
    val cropSizeModel: CropSizeModel?,
)

/** Required for computing parallax. */
data class CropSizeModel(
    /** The zoom of the wallpaper on its hosting view when user selects the cropHint. */
    val wallpaperZoom: Float,
    /** The size of the view hosting the wallpaper, e.g. SurfaceView. */
    val hostViewSize: Point,
    /** A larger version of hostViewSize that can safely contain parallax. */
    val cropViewSize: Point,
)