unityzgy/Assets/ThirdPackages/VRPackage/VRTK/Scripts/Pointers/VRTK_SimplePointer.cs

// Simple Pointer|Pointers|10030
namespace VRTK
{
    using UnityEngine;
    using System;

    /// <summary>
    /// The Simple Pointer emits a coloured beam from the end of the object it is attached to and simulates a laser beam.
    /// </summary>
    /// <remarks>
    /// It can be useful for pointing to objects within a scene and it can also determine the object it is pointing at and the distance the object is from the controller the beam is being emitted from.
    ///
    /// The laser beam is activated by default by pressing the `Touchpad` on the linked controller. The event it is listening for is the `AliasPointer` events so the pointer toggle button can be set by changing the `Pointer Toggle` button on the `VRTK_ControllerEvents` script parameters.
    /// </remarks>
    /// <example>
    /// `VRTK/Examples/003_Controller_SimplePointer` shows the simple pointer in action and code examples of how the events are utilised and listened to can be viewed in the script `VRTK/Examples/Resources/Scripts/VRTK_ControllerPointerEvents_ListenerExample.cs`
    /// </example>
    [Obsolete("`VRTK_SimplePointer` has been replaced with `VRTK_StraightPointerRenderer` attached to a `VRTK_Pointer`. This script will be removed in a future version of VRTK.")]
    public class VRTK_SimplePointer : VRTK_BasePointer
    {
        [Header("Simple Pointer Settings", order = 3)]

        [Tooltip("The thickness and length of the beam can also be set on the script as well as the ability to toggle the sphere beam tip that is displayed at the end of the beam (to represent a cursor).")]
        public float pointerThickness = 0.002f;
        [Tooltip("The distance the beam will project before stopping.")]
        public float pointerLength = 100f;
        [Tooltip("Toggle whether the cursor is shown on the end of the pointer beam.")]
        public bool showPointerTip = true;
        [Header("Custom Appearance Settings", order = 4)]
        [Tooltip("A custom Game Object can be applied here to use instead of the default sphere for the pointer cursor.")]
        public GameObject customPointerCursor;
        [Tooltip("Rotate the pointer cursor to match the normal of the target surface (or the pointer direction if no target was hit).")]
        public bool pointerCursorMatchTargetNormal = false;
        [Tooltip("Rescale the pointer cursor proportionally to the distance from this game object (useful when used as a gaze pointer).")]
        public bool pointerCursorRescaledAlongDistance = false;

        private GameObject pointerHolder;
        private GameObject pointerBeam;
        private GameObject pointerTip;
        private Vector3 pointerTipScale = new Vector3(0.05f, 0.05f, 0.05f);
        private Vector3 pointerCursorOriginalScale = Vector3.one;
        private bool activeEnabled;
        private bool storedBeamState;
        private bool storedTipState;

        protected override void OnEnable()
        {
            base.OnEnable();
            InitPointer();
        }

        protected override void OnDisable()
        {
            base.OnDisable();
            if (pointerHolder != null)
            {
                Destroy(pointerHolder);
            }
        }

        protected override void Update()
        {
            base.Update();
            if (pointerBeam && pointerBeam.activeSelf)
            {
                var origin = GetOrigin();
                Ray pointerRaycast = new Ray(origin.position, origin.forward);
                RaycastHit pointerCollidedWith;
                var rayHit = Physics.Raycast(pointerRaycast, out pointerCollidedWith, pointerLength, ~layersToIgnore);
                var pointerBeamLength = GetPointerBeamLength(rayHit, pointerCollidedWith);
                SetPointerTransform(pointerBeamLength, pointerThickness);
                if (rayHit)
                {
                    if (pointerCursorMatchTargetNormal)
                    {
                        pointerTip.transform.forward = -pointerCollidedWith.normal;
                    }
                    if (pointerCursorRescaledAlongDistance)
                    {
                        float collisionDistance = Vector3.Distance(pointerCollidedWith.point, origin.position);
                        pointerTip.transform.localScale = pointerCursorOriginalScale * collisionDistance;
                    }
                }
                else
                {
                    if (pointerCursorMatchTargetNormal)
                    {
                        pointerTip.transform.forward = origin.forward;
                    }
                    if (pointerCursorRescaledAlongDistance)
                    {
                        pointerTip.transform.localScale = pointerCursorOriginalScale * pointerBeamLength;
                    }
                }

                if (activeEnabled)
                {
                    activeEnabled = false;
                    pointerBeam.GetComponentInChildren<Renderer>().enabled = storedBeamState;
                    pointerTip.GetComponentInChildren<Renderer>().enabled = storedTipState;
                }
            }
        }

        protected override void UpdateObjectInteractor()
        {
            base.UpdateObjectInteractor();
            //if the object interactor is too far from the pointer tip then set it to the pointer tip position to prevent glitching.
            if (Vector3.Distance(objectInteractor.transform.position, pointerTip.transform.position) > 0)
            {
                objectInteractor.transform.position = pointerTip.transform.position;
            }
        }

        protected override void InitPointer()
        {
            pointerHolder = new GameObject(string.Format("[{0}]BasePointer_SimplePointer_Holder", gameObject.name));
            pointerHolder.transform.localPosition = Vector3.zero;
            VRTK_PlayerObject.SetPlayerObject(pointerHolder, VRTK_PlayerObject.ObjectTypes.Pointer);

            pointerBeam = GameObject.CreatePrimitive(PrimitiveType.Cube);
            pointerBeam.transform.name = string.Format("[{0}]BasePointer_SimplePointer_Pointer", gameObject.name);
            pointerBeam.transform.SetParent(pointerHolder.transform);
            pointerBeam.GetComponent<BoxCollider>().isTrigger = true;
            pointerBeam.AddComponent<Rigidbody>().isKinematic = true;
            pointerBeam.layer = LayerMask.NameToLayer("Ignore Raycast");

            var pointerRenderer = pointerBeam.GetComponent<MeshRenderer>();
            pointerRenderer.shadowCastingMode = UnityEngine.Rendering.ShadowCastingMode.Off;
            pointerRenderer.receiveShadows = false;
            pointerRenderer.material = pointerMaterial;

            VRTK_PlayerObject.SetPlayerObject(pointerBeam, VRTK_PlayerObject.ObjectTypes.Pointer);

            if (customPointerCursor)
            {
                pointerTip = Instantiate(customPointerCursor);
            }
            else
            {
                pointerTip = GameObject.CreatePrimitive(PrimitiveType.Sphere);
                pointerTip.transform.localScale = pointerTipScale;

                var pointerTipRenderer = pointerTip.GetComponent<MeshRenderer>();
                pointerTipRenderer.shadowCastingMode = UnityEngine.Rendering.ShadowCastingMode.Off;
                pointerTipRenderer.receiveShadows = false;
                pointerTipRenderer.material = pointerMaterial;
            }

            pointerCursorOriginalScale = pointerTip.transform.localScale;
            pointerTip.transform.name = string.Format("[{0}]BasePointer_SimplePointer_PointerTip", gameObject.name);
            pointerTip.transform.SetParent(pointerHolder.transform);
            pointerTip.GetComponent<Collider>().isTrigger = true;
            pointerTip.AddComponent<Rigidbody>().isKinematic = true;
            pointerTip.layer = LayerMask.NameToLayer("Ignore Raycast");
            VRTK_PlayerObject.SetPlayerObject(pointerTip, VRTK_PlayerObject.ObjectTypes.Pointer);

            base.InitPointer();

            ResizeObjectInteractor();

            SetPointerTransform(pointerLength, pointerThickness);
            TogglePointer(false);
        }

        protected override void SetPointerMaterial(Color color)
        {
            base.SetPointerMaterial(color);

            base.ChangeMaterialColor(pointerBeam, color);
            base.ChangeMaterialColor(pointerTip, color);
        }

        protected override void TogglePointer(bool state)
        {
            state = (pointerVisibility == pointerVisibilityStates.Always_On ? true : state);
            base.TogglePointer(state);
            if (pointerBeam)
            {
                pointerBeam.SetActive(state);
            }

            var tipState = (showPointerTip ? state : false);
            if (pointerTip)
            {
                pointerTip.SetActive(tipState);
            }

            if (pointerBeam && pointerBeam.GetComponentInChildren<Renderer>() && pointerVisibility == pointerVisibilityStates.Always_Off)
            {
                pointerBeam.GetComponentInChildren<Renderer>().enabled = false;
            }

            activeEnabled = state;

            if (activeEnabled)
            {
                storedBeamState = pointerBeam.GetComponentInChildren<Renderer>().enabled;
                storedTipState = pointerTip.GetComponentInChildren<Renderer>().enabled;

                pointerBeam.GetComponentInChildren<Renderer>().enabled = false;
                pointerTip.GetComponentInChildren<Renderer>().enabled = false;
            }

            ResizeObjectInteractor();
        }

        private void ResizeObjectInteractor()
        {
            if (showPointerTip && pointerTip && objectInteractor)
            {
                objectInteractor.transform.localScale = pointerTip.transform.localScale * 1.05f;
            }
        }

        private void SetPointerTransform(float setLength, float setThicknes)
        {
            //if the additional decimal isn't added then the beam position glitches
            var beamPosition = setLength / (2 + 0.00001f);
            Transform smoothedOrigin = GetOrigin();

            pointerBeam.transform.localScale = new Vector3(setThicknes, setThicknes, setLength);
            pointerBeam.transform.localPosition = new Vector3(0f, 0f, beamPosition);

            pointerHolder.transform.position = GetOrigin(false).position;
            pointerTip.transform.position = smoothedOrigin.position + smoothedOrigin.forward * (setLength - (pointerTip.transform.localScale.z / 2));
            pointerHolder.transform.LookAt(pointerTip.transform);

            base.UpdateDependencies(pointerTip.transform.position);
        }

        private float GetPointerBeamLength(bool hasRayHit, RaycastHit collidedWith)
        {
            var actualLength = pointerLength;

            //reset if beam not hitting or hitting new collider
            if (!hasRayHit || (pointerContactRaycastHit.collider && pointerContactRaycastHit.collider != collidedWith.collider))
            {
                if (pointerContactRaycastHit.collider != null)
                {
                    base.PointerOut();
                }

                pointerContactDistance = 0f;
                pointerContactTarget = null;
                pointerContactRaycastHit = new RaycastHit();
                destinationPosition = Vector3.zero;

                UpdatePointerMaterial(pointerMissColor);
            }

            //check if beam has hit a new target
            if (hasRayHit)
            {
                pointerContactDistance = collidedWith.distance;
                pointerContactTarget = collidedWith.transform;
                pointerContactRaycastHit = collidedWith;
                destinationPosition = pointerTip.transform.position;

                UpdatePointerMaterial(pointerHitColor);

                base.PointerIn();
            }

            //adjust beam length if something is blocking it
            if (hasRayHit && pointerContactDistance < pointerLength)
            {
                actualLength = pointerContactDistance;
            }

            return OverrideBeamLength(actualLength);
        }
    }
}