SolverBodyLock.cs

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See LICENSE in the project root for license information.

using System;
using UnityEngine;

namespace HoloToolkit.Unity
{
    [Obsolete("Body Locked Solvers are replaced by Orbital Solvers. Use the YawOnly/CameraAligned orientations and a World Offset to exactly replace SolverBodyLocked.", false)]
    public class SolverBodyLock : Solver
    {
        #region public enums
        public enum OrientationReference
        {
            Default,
            CameraFacing,
        }
        #endregion

        #region public members
        [Tooltip("The desired orientation of this object. Default sets the object to face the TrackedObject/TargetTransform. CameraFacing sets the object to always face the user.")]
        public OrientationReference Orientation = OrientationReference.Default;
        [Tooltip("XYZ offset for this object in relation to the TrackedObject/TargetTransform")]
        public Vector3 offset;
        [Tooltip("RotationTether snaps the object to be in front of TrackedObject regardless of the object's local rotation.")]
        public bool RotationTether = false;
        [Tooltip("TetherAngleSteps is the division of steps this object can tether to. Higher the number, the more snapple steps.")]
        [Range(4, 12)]
        public int TetherAngleSteps = 6;
        #endregion

        private Quaternion desiredRot = Quaternion.identity;

        public override void SolverUpdate()
        {

            if (RotationTether)
            {
                float targetYRotation = GetOrientationRef().eulerAngles.y;
                float tetherYRotation = desiredRot.eulerAngles.y;
                float angleDiff = Mathf.DeltaAngle(targetYRotation, tetherYRotation);
                float tetherAngleLimit = 360f / TetherAngleSteps;

                if (Mathf.Abs(angleDiff) > tetherAngleLimit)
                {
                    int numSteps = Mathf.RoundToInt(targetYRotation / tetherAngleLimit);
                    tetherYRotation = numSteps * tetherAngleLimit;
                    desiredRot = Quaternion.Euler(0f, tetherYRotation, 0f);
                }

            }

            Vector3 desiredPos = solverHandler.TransformTarget != null ? solverHandler.TransformTarget.position + (desiredRot * offset) : Vector3.zero;

            GoalPosition = desiredPos;
            GoalRotation = desiredRot;

            UpdateWorkingPosToGoal();
            UpdateWorkingRotToGoal();
        }

        private Transform GetOrientationRef()
        {
            if (Orientation == OrientationReference.CameraFacing)
            {
                return CameraCache.Main.transform;
            }
            return solverHandler.TransformTarget;
        }
    }
}