BaseGrabber.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 System.Collections.Generic;
using UnityEngine;

#if UNITY_WSA && UNITY_2017_2_OR_NEWER
using UnityEngine.XR.WSA.Input;
#endif

namespace HoloToolkit.Unity.InputModule.Examples.Grabbables
{
    public abstract class BaseGrabber : MonoBehaviour
    {
        public event Action<BaseGrabber> OnGrabStateChange;
        public event Action<BaseGrabber> OnContactStateChange;

#if UNITY_WSA && UNITY_2017_2_OR_NEWER
        public InteractionSourceHandedness Handedness { get { return handedness; } set { handedness = value; } }
#endif

        public List<BaseGrabbable> GrabbedObjects { get { return new List<BaseGrabbable>(grabbedObjects); } }


        public GrabStateEnum GrabState
        {
            get
            {
                if (grabbedObjects.Count > 1)
                {
                    return GrabStateEnum.Multi;
                }

                return grabbedObjects.Count > 0 ? GrabStateEnum.Single : GrabStateEnum.Inactive;
            }
        }

        public GrabStateEnum ContactState
        {
            get
            {
                if (contactObjects.Count > 1)
                    return GrabStateEnum.Multi;
                else if (contactObjects.Count > 0)
                    return GrabStateEnum.Single;
                else
                    return GrabStateEnum.Inactive;
            }
        }

        public Transform GrabHandle
        {
            get
            {
                return grabAttachSpot != null ? grabAttachSpot : transform;
            }
        }

        public float Strength { get { return strength; } }

        [SerializeField]
        protected Transform grabAttachSpot;

        [SerializeField]
        protected float strength = 1.0f;

        protected HashSet<BaseGrabbable> grabbedObjects = new HashSet<BaseGrabbable>();
        protected List<BaseGrabbable> contactObjects = new List<BaseGrabbable>();

        protected float grabForgivenessRadius;

        private GrabStateEnum prevGrabState = GrabStateEnum.Inactive;
        private GrabStateEnum prevContactState = GrabStateEnum.Inactive;

#if UNITY_WSA && UNITY_2017_2_OR_NEWER
        [SerializeField]
        protected InteractionSourceHandedness handedness;
#endif

        public bool IsGrabbing(BaseGrabbable grabbable)
        {
            return grabbedObjects.Contains(grabbable);
        }

        public virtual bool CanTransferOwnershipTo(BaseGrabbable ownerGrab, BaseGrabber otherGrabber)
        {
            Debug.Log("Transferring ownership of " + ownerGrab.name + " to grabber " + otherGrabber.name);
            grabbedObjects.Remove(ownerGrab);
            return true;
        }

        protected virtual void GrabStart()
        {
            // Clean out the list of available objects list
            for (int i = contactObjects.Count - 1; i >= 0; i--)
            {
                if ((contactObjects[i] == null || !contactObjects[i].isActiveAndEnabled) && !grabbedObjects.Contains(contactObjects[i]))
                {
                    contactObjects.RemoveAt(i);
                }
            }

            // If there are any left after pruning
            if (contactObjects.Count > 0)
            {
                // Sort by distance and try to grab the closest
                SortAvailable();
                BaseGrabbable closestAvailable = contactObjects[0];
                if (closestAvailable.TryGrabWith(this))
                {
                    grabbedObjects.Add(contactObjects[0]);
                }
            }
        }

        protected virtual void GrabEnd()
        {
            grabbedObjects.Clear();
        }

        protected virtual void OnEnable()
        {
        }

        protected virtual void OnDisable()
        {
            grabbedObjects.Clear();
        }

        protected void AddContact(BaseGrabbable availableObject)
        {
            if (!contactObjects.Contains(availableObject))
            {
                contactObjects.Add(availableObject);
                availableObject.AddContact(this);
            }
        }


        protected void RemoveContact(BaseGrabbable availableObject)
        {
            contactObjects.Remove(availableObject);
            availableObject.RemoveContact(this);

            if (contactObjects.Contains(availableObject))
            {
                // What's supposed to happen here?
            }
        }

        protected virtual void SortAvailable()
        {
            contactObjects.Sort(delegate (BaseGrabbable b1, BaseGrabbable b2)
            {
                return Vector3.Distance(b1.GrabPoint, GrabHandle.position).CompareTo(Vector3.Distance(b2.GrabPoint, GrabHandle.position));
            });
        }

        void Update()
        {
#if UNITY_EDITOR
            if (UnityEditor.Selection.activeGameObject == gameObject)
            {
                if (Input.GetKeyDown(KeyCode.G))
                {
                    if (GrabState == GrabStateEnum.Inactive)
                    {
                        Debug.Log("Grab start");
                        GrabStart();
                    }
                    else
                    {
                        Debug.Log("Grab end");
                        GrabEnd();
                    }
                }
            }
#endif

            if (prevGrabState != GrabState && OnGrabStateChange != null)
            {
                Debug.Log("Calling on grab change in grabber");
                OnGrabStateChange(this);
            }

            if (prevContactState != ContactState && OnContactStateChange != null)
            {
                Debug.Log("Calling on contact change in grabber");
                OnContactStateChange(this);
            }

            prevGrabState = GrabState;
            prevContactState = ContactState;
        }
    }
}