/*
 * Copyright (C) 2025 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.wm.shell.appzoomout;

import android.os.Handler;

import com.android.wm.shell.shared.annotations.ExternalThread;

/**
 * Interface to engage with the app zoom out feature.
 */
@ExternalThread
public interface AppZoomOut {

    /**
     * Sets the squeeze effect progress.
     *
     * <p>The {@code progress} parameter determines the current zoom level and surface crop, ranging
     * from {@code 0f} to {@code 1f}.
     * <ul>
     * <li>A value of {@code 0f} indicates no scaling and cropping (content is displayed at its
     * original size).</li>
     * <li>A value of {@code 0.0f} represents the maximum zoom-out, effectively scaling and cropping
     * the content to the max pushback level</li>
     * <li>Values between {@code 0.0f} and {@code 1.0f} represent intermediate zoom levels.</li>
     * </ul>
     *
     * @param progress The progress to set the squeeze zoom effect to.
     * @param vsyncId The vsync id to align the frame to.
     * @param sysuiMainHandler The main handler from SystemUI (required for CUJ tracking)
     */
    void setTopLevelProgress(float progress, long vsyncId, Handler sysuiMainHandler);

}