CesiumSubScene.cs

Go to the documentation of this file.

using System;
using Unity.Mathematics;
using UnityEngine;
 
namespace CesiumForUnity
{
    [ExecuteInEditMode]
    [AddComponentMenu("Cesium/Cesium Sub Scene")]
    [IconAttribute("Packages/com.cesium.unity/Editor/Resources/Cesium-24x24.png")]
    public class CesiumSubScene : MonoBehaviour
    {
#if UNITY_EDITOR
        // Caches the built-in sphere mesh across all CesiumSubScenes for use in OnDrawGizmos
        private static Mesh _previewSphereMesh;
#endif
 
        [SerializeField]
        private double _activationRadius = 1000;
 
        public double activationRadius
        {
            get => this._activationRadius;
            set
            {
                this._activationRadius = value;
            }
        }
 
        [SerializeField]
        private bool _showActivationRadius = true;
 
        public bool showActivationRadius
        {
            get => this._showActivationRadius;
            set => this._showActivationRadius = value;
        }
 
        [SerializeField]
        private CesiumGeoreferenceOriginAuthority _originAuthority =
            CesiumGeoreferenceOriginAuthority.LongitudeLatitudeHeight;
 
        public CesiumGeoreferenceOriginAuthority originAuthority
        {
            get => this._originAuthority;
            set
            {
                this._originAuthority = value;
                this.UpdateOrigin();
            }
        }
 
        [SerializeField]
        private double _latitude = 39.736401;
 
        public double latitude
        {
            get => this._latitude;
            set
            {
                this._latitude = value;
                this.originAuthority = CesiumGeoreferenceOriginAuthority.LongitudeLatitudeHeight;
            }
        }
 
        [SerializeField]
        private double _longitude = -105.25737;
 
        public double longitude
        {
            get => this._longitude;
            set
            {
                this._longitude = value;
                this.originAuthority = CesiumGeoreferenceOriginAuthority.LongitudeLatitudeHeight;
            }
        }
 
        [SerializeField]
        private double _height = 2250.0;
 
        public double height
        {
            get => this._height;
            set
            {
                this._height = value;
                this.originAuthority = CesiumGeoreferenceOriginAuthority.LongitudeLatitudeHeight;
            }
        }
 
        [SerializeField]
        private double _ecefX = 6378137.0;
 
        public double ecefX
        {
            get => this._ecefX;
            set
            {
                this._ecefX = value;
                this.originAuthority = CesiumGeoreferenceOriginAuthority.EarthCenteredEarthFixed;
            }
        }
 
        [SerializeField]
        private double _ecefY = 0.0;
 
        public double ecefY
        {
            get => this._ecefY;
            set
            {
                this._ecefY = value;
                this.originAuthority = CesiumGeoreferenceOriginAuthority.EarthCenteredEarthFixed;
            }
        }
 
        [SerializeField]
        private double _ecefZ = 0.0;
 
        public double ecefZ
        {
            get => this._ecefZ;
            set
            {
                this._ecefZ = value;
                this.originAuthority = CesiumGeoreferenceOriginAuthority.EarthCenteredEarthFixed;
            }
        }
 
        // The resolved georeference containing this globe anchor. This is just a cache
        // of `GetComponentInParent<CesiumGeoreference>()`.
        [NonSerialized]
        internal CesiumGeoreference _parentGeoreference;
 
#if UNITY_EDITOR
        // The coordinates of the parent CesiumGeoreference before being changed by `UpdateOrigin`.
        // This is used when adding a CesiumSubScene component to a GameObject. Since `OnEnable`
        // runs before `Reset`, it will force the georeference to move to the default coordinates
        // of CesiumSubScene, which is undesired. But there's no way to modify `OnEnable` to
        // distinguish whether the subscene was just added or already existed in the scene.
        // Instead, we need to store the georeference's previous values during `OnEnable`,
        // so that we can move it back during `Reset`.
        [NonSerialized]
        private double3 _oldParentCoordinates = double3.zero;
 
        [NonSerialized]
        private CesiumGeoreferenceOriginAuthority _oldParentOriginAuthority;
#endif
 
        public void SetOriginEarthCenteredEarthFixed(double x, double y, double z)
        {
            this._ecefX = x;
            this._ecefY = y;
            this._ecefZ = z;
            this.originAuthority = CesiumGeoreferenceOriginAuthority.EarthCenteredEarthFixed;
        }
 
        public void SetOriginLongitudeLatitudeHeight(double longitude, double latitude, double height)
        {
            this._longitude = longitude;
            this._latitude = latitude;
            this._height = height;
            this.originAuthority = CesiumGeoreferenceOriginAuthority.LongitudeLatitudeHeight;
        }
 
        private void CopyParentCoordinates()
        {
            this._longitude = this._parentGeoreference.longitude;
            this._latitude = this._parentGeoreference.latitude;
            this._height = this._parentGeoreference.height;
 
            this._ecefX = this._parentGeoreference.ecefX;
            this._ecefY = this._parentGeoreference.ecefY;
            this._ecefZ = this._parentGeoreference.ecefZ;
        }
 
        private void DetachFromParentIfNeeded()
        {
            if (this._parentGeoreference != null)
            {
                this._parentGeoreference.changed -= this.OnParentChanged;
                this._parentGeoreference = null;
            }
        }
 
        private void UpdateParentReference()
        {
            DetachFromParentIfNeeded();
 
            this._parentGeoreference = this.GetComponentInParent<CesiumGeoreference>();
 
            if (this._parentGeoreference != null)
            {
                this._parentGeoreference.Initialize();
                this._parentGeoreference.changed += this.OnParentChanged;
            }
        }
 
        private void OnValidate()
        {
            this.UpdateOrigin();
        }
 
#if UNITY_EDITOR
        private void Reset()
        {
            this.UpdateParentReference();
 
            // The default coordinates for the CesiumSubScene component should be the coordinates of its parent, if possible.
            // This means adding the component as the child of an existing CesiumGeoreference won't reset the parent's coordinates.
            if (this._parentGeoreference != null)
            {
                if (this._oldParentOriginAuthority == CesiumGeoreferenceOriginAuthority.EarthCenteredEarthFixed)
                {
                    this._parentGeoreference.SetOriginEarthCenteredEarthFixed(this._oldParentCoordinates.x, this._oldParentCoordinates.y, this._oldParentCoordinates.z);
                }
                else
                {
                    this._parentGeoreference.SetOriginLongitudeLatitudeHeight(this._oldParentCoordinates.x, this._oldParentCoordinates.y, this._oldParentCoordinates.z);
                }
 
                this.CopyParentCoordinates();
            }
        }
#endif
 
        private void OnEnable()
        {
            this.UpdateParentReference();
 
            // If not under a georef, nothing to do
            if (this._parentGeoreference == null)
                throw new InvalidOperationException(
                    "CesiumSubScene is not nested inside a game object with a CesiumGeoreference.");
 
            // When this sub-scene is enabled, all others are disabled.
            CesiumSubScene[] subscenes = this._parentGeoreference.GetComponentsInChildren<CesiumSubScene>();
            foreach (CesiumSubScene scene in subscenes)
            {
                if (scene == this)
                    continue;
                scene.gameObject.SetActive(false);
            }
 
#if UNITY_EDITOR
            // The parent's previous coordinates are saved here in case they have to be reverted in the editor during `Reset`
            this._oldParentOriginAuthority = this._parentGeoreference.originAuthority;
            if (this._oldParentOriginAuthority == CesiumGeoreferenceOriginAuthority.EarthCenteredEarthFixed)
            {
                this._oldParentCoordinates = new double3(this._parentGeoreference.ecefX, this._parentGeoreference.ecefY, this._parentGeoreference.ecefZ);
            }
            else
            {
                this._oldParentCoordinates = new double3(this._parentGeoreference.longitude, this._parentGeoreference.latitude, this._parentGeoreference.height);
            }
#endif
 
            this.UpdateOrigin();
        }
 
        private void OnParentChanged()
        {
            if (!this.isActiveAndEnabled)
                return;
 
            this.UpdateParentReference();
 
            // If not under a georef, nothing to do
            if (this._parentGeoreference == null)
            {
                throw new InvalidOperationException(
                    "CesiumSubScene should have been nested inside a game object with a CesiumGeoreference.");
            }
 
            // Update our origin to our parent georef, maintain our origin authority,
            // and copy both sets of reference coordinates. No need to calculate any of this again
            this.CopyParentCoordinates();
        }
 
        private void OnDisable()
        {
            DetachFromParentIfNeeded();
        }
 
        private void OnDestroy()
        {
            DetachFromParentIfNeeded();
        }
 
        private void UpdateOtherCoordinates()
        {
            if(this._parentGeoreference == null)
            {
                this.UpdateParentReference();
 
                if(this._parentGeoreference == null)
                {
                    throw new InvalidOperationException("CesiumSubScene should have been nested inside a game object with a CesiumGeoreference.");
                }
            }
 
            if (this._originAuthority == CesiumGeoreferenceOriginAuthority.LongitudeLatitudeHeight)
            {
                double3 ecef = this._parentGeoreference.ellipsoid.LongitudeLatitudeHeightToCenteredFixed(new double3(
                    this._longitude,
                    this._latitude,
                    this._height
                ));
 
                this._ecefX = ecef.x;
                this._ecefY = ecef.y;
                this._ecefZ = ecef.z;
            }
 
            if (this._originAuthority == CesiumGeoreferenceOriginAuthority.EarthCenteredEarthFixed)
            {
                double3 llh = this._parentGeoreference.ellipsoid.CenteredFixedToLongitudeLatitudeHeight(new double3(
                    this._ecefX,
                    this._ecefY,
                    this._ecefZ
                ));
 
                this._longitude = llh.x;
                this._latitude = llh.y;
                this._height = llh.z;
            }
        }
 
        public void UpdateOrigin()
        {
            UpdateOtherCoordinates();
 
            if (this.isActiveAndEnabled)
            {
                this.UpdateParentReference();
 
                if (this._parentGeoreference == null)
                    throw new InvalidOperationException("CesiumSubScene is not nested inside a game object with a CesiumGeoreference.");
 
                if (this.originAuthority == CesiumGeoreferenceOriginAuthority.EarthCenteredEarthFixed)
                    this._parentGeoreference.SetOriginEarthCenteredEarthFixed(
                        this._ecefX,
                        this._ecefY,
                        this._ecefZ);
                else
                    this._parentGeoreference.SetOriginLongitudeLatitudeHeight(
                        this._longitude,
                        this._latitude,
                        this._height);
            }
        }
 
#if UNITY_EDITOR
        private void OnDrawGizmos()
        {
            if (this._showActivationRadius)
            {
                // Gizmos.DrawWireSphere only draws three wire circles representing the sphere's radii
                // To do better, we need to fetch the built-in sphere mesh and use that
                if (_previewSphereMesh == null)
                {
                    _previewSphereMesh = Resources.GetBuiltinResource<Mesh>("Sphere.fbx");
                }
 
                Gizmos.color = Color.blue;
                Gizmos.DrawWireMesh(_previewSphereMesh, this.transform.position, Quaternion.identity, (float3)new double3(this._activationRadius, this._activationRadius, this._activationRadius));
            }
        }
#endif
    }
}