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

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

        public BaseGrabber GrabberPrimary
        {
            get
            {
                return activeGrabbers.Count > 0 ? activeGrabbers[activeGrabbers.Count - 1] : null;
            }
        }

        public BaseGrabber[] ActiveGrabbers
        {
            get
            {
                return activeGrabbers.ToArray();
            }
        }

        public Vector3 GrabPoint
        {
            get
            {
                return grabSpot != null ? grabSpot.position : transform.position;
            }
        }

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

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

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

        protected HashSet<BaseGrabber> availableGrabbers = new HashSet<BaseGrabber>();

        protected List<BaseGrabber> activeGrabbers = new List<BaseGrabber>();

        //left protected unless we have the occasion to use them publicly, then switch to public access
        [SerializeField]
        protected Transform grabSpot;

        [SerializeField]
        protected GrabStyleEnum grabStyle = GrabStyleEnum.Exclusive;

        private GrabStateEnum prevGrabState = GrabStateEnum.Inactive;
        private GrabStateEnum prevContactState = GrabStateEnum.Inactive;
        private Vector3 velocity;
        private Vector3 averageVelocity;
        private Vector3 previousVel;

        public virtual bool TryGrabWith(BaseGrabber grabber)
        {
            // TODO error checking, multi-grab checking
            if (GrabState != GrabStateEnum.Inactive)
            {
                switch (grabStyle)
                {
                    case GrabStyleEnum.Exclusive:
                        // Try to transfer ownership of grabbed object
                        BaseGrabber primary = GrabberPrimary;
                        if (GrabberPrimary.CanTransferOwnershipTo(this, grabber))
                        {
                            // Remove from grabbable list and detach
                            activeGrabbers.Remove(primary);
                            DetachFromGrabber(primary);
                        }
                        else
                        {
                            // If we can't, it's a no-go
                            return false;
                        }
                        break;
                    case GrabStyleEnum.Multi:
                        break;
                    default:
                        throw new ArgumentOutOfRangeException();
                }
            }

            StartGrab(grabber);
            return true;
        }

        public void AddContact(BaseGrabber availableObject)
        {
            availableGrabbers.Add(availableObject);
        }

        public void RemoveContact(BaseGrabber availableObject)
        {
            availableGrabbers.Remove(availableObject);
        }

        // The next three functions provide basic behavior. Extend from this base script in order to provide more specific functionality.

        protected virtual void AttachToGrabber(BaseGrabber grabber)
        {
            // By default this does nothing
            // In most cases this will parent or create a joint
        }

        protected virtual void DetachFromGrabber(BaseGrabber grabber)
        {
            // By default this does nothing
            // In most cases this will un-parent or destroy a joint
        }

        protected virtual void StartGrab(BaseGrabber grabber)
        {
            Debug.Log("Start grab");
            if (GrabState == GrabStateEnum.Inactive)
            {
                Debug.Log("State is inactive");
                // If we're not already updating our grab state, start now
                activeGrabbers.Add(grabber);
                StartCoroutine(StayGrab());
            }
            else
            {
                Debug.Log("State is not inactive");
                // Otherwise just push the grabber
                activeGrabbers.Add(grabber);
            }

            // Attach ourselves to this grabber
            AttachToGrabber(grabber);
            if (OnGrabbed != null)
            {
                OnGrabbed(this);
            }
        }

        protected virtual IEnumerator StayGrab()
        {
            yield return null;

            // While grabbers are grabbing
            while (GrabState != GrabStateEnum.Inactive)
            {
                // Call on grab stay in case this grabbable wants to update itself
                OnGrabStay();
                for (int i = activeGrabbers.Count - 1; i >= 0; i--)
                {
                    if (activeGrabbers[i] == null || !activeGrabbers[i].IsGrabbing(this))
                    {
                        Debug.Log("no longer being grabbed by active grabber");
                        if (activeGrabbers[i] != null)
                        {
                            DetachFromGrabber(activeGrabbers[i]);
                        }

                        activeGrabbers.RemoveAt(i);
                    }
                }
                yield return null;
            }

            EndGrab();
        }
        protected virtual void EndGrab()
        {
            if (OnReleased != null)
            {
                OnReleased(this);
            }
        }

        protected virtual void OnGrabStay()
        {
        }

        protected virtual void Start()
        {
        }

        protected virtual void Update()
        {
            if (prevGrabState != GrabState && OnGrabStateChange != null)
            {
                Debug.Log("Calling on grab change in grabbable");
                OnGrabStateChange(this);
            }

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

            prevGrabState = GrabState;
            prevContactState = ContactState;
        }
    }
}