GlassesSettings.cs

/*
 * Copyright (C) 2020-2023 Tilt Five, Inc.
 *
 * 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.
 */
using UnityEngine;
 
using Obsolete = System.ObsoleteAttribute;
 
namespace TiltFive
{
    [System.Serializable]
    public class GlassesSettings : TrackableSettings
    {
        #region Constants

        internal const uint MAX_SUPPORTED_GLASSES_COUNT = 4;
 
        public const float MIN_FOV = 35f;
        public const float MAX_FOV = 64f;
        public const float DEFAULT_FOV = 48f;
 
        // A default value will be returned by the client API if a custom IPD hasn't been set for
        // the glasses starting in version 1.1.0+, which means this constant won't be needed.  It
        // is kept for compatibility with older releases.
        [Obsolete("GlassesSettings.DEFAULT_IPD_UGBD is deprecated.")]
        public const float DEFAULT_IPD_UGBD = 0.059f;
        internal const float DEFAULT_IPD_STAGE = 0.059f;
 
        // Enforce a near clip plane that keeps objects from getting too close to the user's head.
        // TODO: Determine the threshold for discomfort (plus a small amount of margin) via usability testing.
        public const float MIN_NEAR_CLIP_DISTANCE_IN_METERS = 0.1f;
 
        public static readonly string DEFAULT_FRIENDLY_NAME = "Tilt Five Glasses";
 
        #endregion
 
 
#if UNITY_EDITOR
        public bool tiltFiveXR = true;
 
        public bool copyPlayerOneCameraTemplate = true;
        public bool copyPlayerOneObjectTemplate = true;
#if UNITY_2019_1_OR_NEWER && INPUTSYSTEM_AVAILABLE
        public bool copyPlayerOnePlayerTemplate = true;
#endif
        public bool copyCloneCameraTemplateChildren = true;
        public bool copyPlayerOneCullingMask = true;
        public bool copyPlayerOneFOVToggle = true;
        public bool copyPlayerOneFOV = true;
        public bool copyPlayerOneNearClipPlane = true;
        public bool copyPlayerOneFarClipPlane = true;
#endif
        [System.Obsolete("headPoseCamera is deprecated, and its functionality has been split between " +
            "GlassesSettings.cameraTemplate (for instantiating eye cameras) " +
            "and SpectatorSettings.spectatorCamera (for the onscreen preview).")]
        public Camera headPoseCamera;
 
        // TODO: make this the default name and get rid of headPoseCamera when we update API in
        // 2.0.0.  We want to hold off until then because changing this will clear every scene's
        // TiltFiveManager reference to the preview/headpose camera, requiring a manual fix of the
        // broken reference in every scene.
        public Camera cameraTemplate {
            #pragma warning disable 618 // this is for compatibility; disable obsolete warning
            get { return headPoseCamera; }
            set { headPoseCamera = value; }
            #pragma warning restore 618
        }

        public GameObject objectTemplate;
 
#if UNITY_2019_1_OR_NEWER && INPUTSYSTEM_AVAILABLE
        public GameObject playerTemplate;
#endif

        public bool cloneCameraTemplateChildren = false;

        public LayerMask cullingMask = ~0;

        public float nearClipPlane = MIN_NEAR_CLIP_DISTANCE_IN_METERS;

        public float farClipPlane = 100f;
 
        public bool overrideFOV = false;
        public float customFOV = DEFAULT_FOV;
        public float fieldOfView => overrideFOV
            ? Mathf.Clamp(customFOV, MIN_FOV, MAX_FOV)
            : DEFAULT_FOV;
 
        public GlassesMirrorMode glassesMirrorMode = GlassesMirrorMode.LeftEye;
 
        public bool usePreviewPose = true;
        public Transform previewPose;
 
        public string friendlyName = DEFAULT_FRIENDLY_NAME;
 
        internal GlassesSettings Copy()
        {
            return (GlassesSettings)MemberwiseClone();
        }
    }
}