/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 * All rights reserved.
 *
 * Licensed under the Oculus SDK License Agreement (the "License");
 * you may not use the Oculus SDK except in compliance with the License,
 * which is provided at the time of installation or download, or which
 * otherwise accompanies this software in either electronic or hard copy form.
 *
 * You may obtain a copy of the License at
 *
 * https://developer.oculus.com/licenses/oculussdk/
 *
 * Unless required by applicable law or agreed to in writing, the Oculus SDK
 * 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.
 */

using System;
using UnityEngine;

namespace Oculus.Interaction.Grab.GrabSurfaces
{
    /// <summary>
    /// This interface defines the methods needed to use grab surfaces, such as finding the nearest poses at
    /// the surface to a given set of parameters and duplicating and mirroring the surface.
    /// </summary>
    /// <remarks>
    /// For a canonical example of an implementation of this interface, see <see cref="ColliderGrabSurface"/>.
    /// </remarks>
    public interface IGrabSurface
    {

        /// <summary>
        /// Finds the Pose at the surface that is the closest to the given pose.
        /// </summary>
        /// <param name="targetPose">The root pose to find the nearest to.</param>
        /// <param name="bestPose">The best found pose at the surface.<</param>
        /// <param name="scoringModifier">Weight used to decide which target pose to select</param>
        /// <param name="relativeTo">Reference transform to measure the poses against</param>
        /// <returns>The score indicating how good the found pose was, -1 for invalid result.</returns>
        [Obsolete("Use " + nameof(CalculateBestPoseAtSurface) + " with offset instead")]
        GrabPoseScore CalculateBestPoseAtSurface(in Pose targetPose, out Pose bestPose,
            in PoseMeasureParameters scoringModifier, Transform relativeTo);

        /// <summary>
        /// Finds the Pose at the surface that is the closest to the given pose.
        /// </summary>
        /// <param name="targetPose">The root pose to find the nearest to.</param>
        /// <param name="offset">The offset from the root, for accurate scoring</param>
        /// <param name="bestPose">The best found pose at the surface.<</param>
        /// <param name="scoringModifier">Weight used to decide which target pose to select</param>
        /// <param name="relativeTo">Reference transform to measure the poses against</param>
        /// <returns>The score indicating how good the found pose was, -1 for invalid result.</returns>
        GrabPoseScore CalculateBestPoseAtSurface(in Pose targetPose, in Pose offset, out Pose bestPose,
            in PoseMeasureParameters scoringModifier, Transform relativeTo);

        /// <summary>
        /// Finds the Pose at the surface that is the closest to the given ray.
        /// </summary>
        /// <param name="targetRay">Ray searching for the nearest snap pose</param>
        /// <param name="bestPose">The best found pose at the surface.</param>
        /// <param name="relativeTo">Reference transform to measure the poses against</param>
        /// <returns>True if the pose was found</returns>
        bool CalculateBestPoseAtSurface(Ray targetRay, out Pose bestPose,
            Transform relativeTo);

        /// <summary>
        /// Method for mirroring a Pose around the surface. Different surfaces will prefer mirroring
        /// along different axes.
        /// </summary>
        /// <remarks>
        /// For example, <see cref="BoxGrabSurface"/> mirrors along its "left-right" axis, whereas
        /// <see cref="BezierGrabSurface"/> does not support mirroring and simply returns the
        /// provided <paramref name="gripPose"/>.
        /// </remarks>
        /// <param name="gripPose">The Pose to be mirrored.</param>
        /// <param name="relativeTo">Reference transform to mirror the pose around</param>
        /// <returns>A new pose mirrored at this surface.</returns>
        Pose MirrorPose(in Pose gripPose, Transform relativeTo);

        /// <summary>
        /// Creates a new IGrabSurface under the selected gameobject
        /// that is a mirror version of the current.
        /// </summary>
        /// <param name="gameObject">The gameobject in which to place the new IGrabSurface.</param>
        /// <returns>A mirror of this IGrabSurface.</returns>
        IGrabSurface CreateMirroredSurface(GameObject gameObject);

        /// <summary>
        /// Creates a new IGrabSurface under the selected gameobject
        /// with the same data as this one.
        /// </summary>
        /// <param name="gameObject">The gameobject in which to place the new IGrabSurface.</param>
        /// <returns>A clone of this IGrabSurface.</returns>
        IGrabSurface CreateDuplicatedSurface(GameObject gameObject);
    }
}