ScaleSettings.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 System;
 
namespace TiltFive
{

    [System.Serializable]
    public class ScaleSettings
    {
        public LengthUnit contentScaleUnit = LengthUnit.Centimeters;

        public float contentScaleRatio = 5f;

        public float physicalMetersPerWorldSpaceUnit => new Length(contentScaleRatio, contentScaleUnit).ToMeters;
 
        public float worldSpaceUnitsPerPhysicalMeter => 1 / Mathf.Max(physicalMetersPerWorldSpaceUnit, float.Epsilon);  // No dividing by zero.
 
        public float oneUnitLengthInMeters => (new Length(1, contentScaleUnit)).ToMeters;

        public bool legacyInvertGameboardScale = false;
 
        public const float MIN_CONTENT_SCALE_RATIO = 0.0000001f;
 
        [Obsolete("ScaleSettings.GetScaleToUWRLD_UGBD is deprecated. Please use ScaleSettings.GetScaleToWorldSpaceFromGameboardSpace instead.")]
        public float GetScaleToUWRLD_UGBD(float gameboardScale) { return GetScaleToWorldSpaceFromGameboardSpace(gameboardScale); }
 
        public float GetScaleToWorldSpaceFromGameboardSpace(float gameboardScale)
        {
            float scaleToUWRLD_USTAGE = 0.0f;
 
            if (legacyInvertGameboardScale) {
                float scaleToUSTAGE_UWRLD = physicalMetersPerWorldSpaceUnit * gameboardScale;
                scaleToUWRLD_USTAGE = scaleToUSTAGE_UWRLD > 0
                    ? 1f / scaleToUSTAGE_UWRLD
                    : 1f / float.Epsilon;
            } else {
                scaleToUWRLD_USTAGE = gameboardScale / physicalMetersPerWorldSpaceUnit;
            }
 
            return scaleToUWRLD_USTAGE;
        }
 
#if UNITY_EDITOR
        public bool copyPlayerOneScaleRatio = true;
        public bool copyPlayerOneScaleUnit = true;
#endif
 
        internal ScaleSettings Copy()
        {
            return (ScaleSettings)MemberwiseClone();
        }
    }
}