Merge pull request #1365 from thestonefox/fix/button-movement-on-enable

Fix/button movement on enable - fixes #1333

Author: thestonefox

Assets/VRTK/Scripts/Controls/3D/VRTK_Button.cs

@@ -113,30 +113,37 @@ protected override void OnDrawGizmos()
             Gizmos.DrawLine(bounds.center, bounds.center + activationDir);
         }
 
-        protected override void InitRequiredComponents()
+        protected virtual void SetupCollider()
         {
-            restingPosition = transform.position;
-
-            if (!GetComponent<Collider>())
+            if (GetComponent<Collider>() == null)
             {
                 gameObject.AddComponent<BoxCollider>();
             }
+        }
 
+        protected virtual void SetupRigidbody()
+        {
             buttonRigidbody = GetComponent<Rigidbody>();
             if (buttonRigidbody == null)
             {
                 buttonRigidbody = gameObject.AddComponent<Rigidbody>();
             }
             buttonRigidbody.isKinematic = false;
             buttonRigidbody.useGravity = false;
+        }
 
+        protected virtual void SetupConstantForce()
+        {
             buttonForce = GetComponent<ConstantForce>();
             if (buttonForce == null)
             {
                 buttonForce = gameObject.AddComponent<ConstantForce>();
             }
+        }
 
-            if (connectedTo)
+        protected virtual void SetupConnectedTo()
+        {
+            if (connectedTo != null)
             {
                 Rigidbody connectedToRigidbody = connectedTo.GetComponent<Rigidbody>();
                 if (connectedToRigidbody == null)
@@ -147,6 +154,115 @@ protected override void InitRequiredComponents()
             }
         }
 
+        protected override void InitRequiredComponents()
+        {
+            restingPosition = transform.position;
+
+            SetupCollider();
+            SetupRigidbody();
+            SetupConstantForce();
+            SetupConnectedTo();
+        }
+
+        protected virtual void DetectJointSetup()
+        {
+            buttonJoint = GetComponent<ConfigurableJoint>();
+            bool recreate = false;
+            Rigidbody oldBody = null;
+            Vector3 oldAnchor = Vector3.zero;
+            Vector3 oldAxis = Vector3.zero;
+
+            if (buttonJoint != null)
+            {
+                // save old values, needs to be recreated
+                oldBody = buttonJoint.connectedBody;
+                oldAnchor = buttonJoint.anchor;
+                oldAxis = buttonJoint.axis;
+                DestroyImmediate(buttonJoint);
+                recreate = true;
+            }
+
+            // since limit applies to both directions object needs to be moved halfway to activation before adding joint
+            transform.position = transform.position + ((activationDir.normalized * activationDistance) * 0.5f);
+            buttonJoint = gameObject.AddComponent<ConfigurableJoint>();
+
+            if (recreate)
+            {
+                buttonJoint.connectedBody = oldBody;
+                buttonJoint.anchor = oldAnchor;
+                buttonJoint.axis = oldAxis;
+            }
+
+            buttonJoint.connectedBody = (connectedTo != null ? connectedTo.GetComponent<Rigidbody>() : buttonJoint.connectedBody);
+            buttonJoint.autoConfigureConnectedAnchor = false;
+        }
+
+        protected virtual void DetectJointLimitsSetup()
+        {
+            SoftJointLimit buttonJointLimits = new SoftJointLimit();
+            buttonJointLimits.limit = activationDistance * 0.501f; // set limit to half (since it applies to both directions) and a tiny bit larger since otherwise activation distance might be missed
+            buttonJoint.linearLimit = buttonJointLimits;
+
+            buttonJoint.angularXMotion = ConfigurableJointMotion.Locked;
+            buttonJoint.angularYMotion = ConfigurableJointMotion.Locked;
+            buttonJoint.angularZMotion = ConfigurableJointMotion.Locked;
+            buttonJoint.xMotion = ConfigurableJointMotion.Locked;
+            buttonJoint.yMotion = ConfigurableJointMotion.Locked;
+            buttonJoint.zMotion = ConfigurableJointMotion.Locked;
+        }
+
+        protected virtual void DetectJointDirectionSetup()
+        {
+            switch (finalDirection)
+            {
+                case ButtonDirection.x:
+                case ButtonDirection.negX:
+                    if (Mathf.RoundToInt(Mathf.Abs(transform.right.x)) == 1)
+                    {
+                        buttonJoint.xMotion = ConfigurableJointMotion.Limited;
+                    }
+                    else if (Mathf.RoundToInt(Mathf.Abs(transform.up.x)) == 1)
+                    {
+                        buttonJoint.yMotion = ConfigurableJointMotion.Limited;
+                    }
+                    else if (Mathf.RoundToInt(Mathf.Abs(transform.forward.x)) == 1)
+                    {
+                        buttonJoint.zMotion = ConfigurableJointMotion.Limited;
+                    }
+                    break;
+                case ButtonDirection.y:
+                case ButtonDirection.negY:
+                    if (Mathf.RoundToInt(Mathf.Abs(transform.right.y)) == 1)
+                    {
+                        buttonJoint.xMotion = ConfigurableJointMotion.Limited;
+                    }
+                    else if (Mathf.RoundToInt(Mathf.Abs(transform.up.y)) == 1)
+                    {
+                        buttonJoint.yMotion = ConfigurableJointMotion.Limited;
+                    }
+                    else if (Mathf.RoundToInt(Mathf.Abs(transform.forward.y)) == 1)
+                    {
+                        buttonJoint.zMotion = ConfigurableJointMotion.Limited;
+                    }
+                    break;
+                case ButtonDirection.z:
+                case ButtonDirection.negZ:
+                    if (Mathf.RoundToInt(Mathf.Abs(transform.right.z)) == 1)
+                    {
+                        buttonJoint.xMotion = ConfigurableJointMotion.Limited;
+                    }
+                    else if (Mathf.RoundToInt(Mathf.Abs(transform.up.z)) == 1)
+                    {
+                        buttonJoint.yMotion = ConfigurableJointMotion.Limited;
+                    }
+                    else if (Mathf.RoundToInt(Mathf.Abs(transform.forward.z)) == 1)
+                    {
+                        buttonJoint.zMotion = ConfigurableJointMotion.Limited;
+                    }
+                    break;
+            }
+        }
+
         protected override bool DetectSetup()
         {
             finalDirection = (direction == ButtonDirection.autodetect ? DetectDirection() : direction);
@@ -155,109 +271,19 @@ protected override bool DetectSetup()
                 activationDir = Vector3.zero;
                 return false;
             }
-            if (direction != ButtonDirection.autodetect)
-            {
-                activationDir = CalculateActivationDir();
-            }
 
-            if (buttonForce)
+            activationDir = (direction != ButtonDirection.autodetect ? CalculateActivationDir() : activationDir);
+
+            if (buttonForce != null)
             {
                 buttonForce.force = GetForceVector();
             }
 
             if (Application.isPlaying)
             {
-                buttonJoint = GetComponent<ConfigurableJoint>();
-
-                bool recreate = false;
-                Rigidbody oldBody = null;
-                Vector3 oldAnchor = Vector3.zero;
-                Vector3 oldAxis = Vector3.zero;
-
-                if (buttonJoint)
-                {
-                    // save old values, needs to be recreated
-                    oldBody = buttonJoint.connectedBody;
-                    oldAnchor = buttonJoint.anchor;
-                    oldAxis = buttonJoint.axis;
-                    DestroyImmediate(buttonJoint);
-                    recreate = true;
-                }
-
-                // since limit applies to both directions object needs to be moved halfway to activation before adding joint
-                transform.position = transform.position + ((activationDir.normalized * activationDistance) * 0.5f);
-                buttonJoint = gameObject.AddComponent<ConfigurableJoint>();
-
-                if (recreate)
-                {
-                    buttonJoint.connectedBody = oldBody;
-                    buttonJoint.anchor = oldAnchor;
-                    buttonJoint.axis = oldAxis;
-                }
-                if (connectedTo)
-                {
-                    buttonJoint.connectedBody = connectedTo.GetComponent<Rigidbody>();
-                }
-
-                SoftJointLimit buttonJointLimits = new SoftJointLimit();
-                buttonJointLimits.limit = activationDistance * 0.501f; // set limit to half (since it applies to both directions) and a tiny bit larger since otherwise activation distance might be missed
-                buttonJoint.linearLimit = buttonJointLimits;
-
-                buttonJoint.angularXMotion = ConfigurableJointMotion.Locked;
-                buttonJoint.angularYMotion = ConfigurableJointMotion.Locked;
-                buttonJoint.angularZMotion = ConfigurableJointMotion.Locked;
-                buttonJoint.xMotion = ConfigurableJointMotion.Locked;
-                buttonJoint.yMotion = ConfigurableJointMotion.Locked;
-                buttonJoint.zMotion = ConfigurableJointMotion.Locked;
-
-                switch (finalDirection)
-                {
-                    case ButtonDirection.x:
-                    case ButtonDirection.negX:
-                        if (Mathf.RoundToInt(Mathf.Abs(transform.right.x)) == 1)
-                        {
-                            buttonJoint.xMotion = ConfigurableJointMotion.Limited;
-                        }
-                        else if (Mathf.RoundToInt(Mathf.Abs(transform.up.x)) == 1)
-                        {
-                            buttonJoint.yMotion = ConfigurableJointMotion.Limited;
-                        }
-                        else if (Mathf.RoundToInt(Mathf.Abs(transform.forward.x)) == 1)
-                        {
-                            buttonJoint.zMotion = ConfigurableJointMotion.Limited;
-                        }
-                        break;
-                    case ButtonDirection.y:
-                    case ButtonDirection.negY:
-                        if (Mathf.RoundToInt(Mathf.Abs(transform.right.y)) == 1)
-                        {
-                            buttonJoint.xMotion = ConfigurableJointMotion.Limited;
-                        }
-                        else if (Mathf.RoundToInt(Mathf.Abs(transform.up.y)) == 1)
-                        {
-                            buttonJoint.yMotion = ConfigurableJointMotion.Limited;
-                        }
-                        else if (Mathf.RoundToInt(Mathf.Abs(transform.forward.y)) == 1)
-                        {
-                            buttonJoint.zMotion = ConfigurableJointMotion.Limited;
-                        }
-                        break;
-                    case ButtonDirection.z:
-                    case ButtonDirection.negZ:
-                        if (Mathf.RoundToInt(Mathf.Abs(transform.right.z)) == 1)
-                        {
-                            buttonJoint.xMotion = ConfigurableJointMotion.Limited;
-                        }
-                        else if (Mathf.RoundToInt(Mathf.Abs(transform.up.z)) == 1)
-                        {
-                            buttonJoint.yMotion = ConfigurableJointMotion.Limited;
-                        }
-                        else if (Mathf.RoundToInt(Mathf.Abs(transform.forward.z)) == 1)
-                        {
-                            buttonJoint.zMotion = ConfigurableJointMotion.Limited;
-                        }
-                        break;
-                }
+                DetectJointSetup();
+                DetectJointLimitsSetup();
+                DetectJointDirectionSetup();
             }
 
             return true;
@@ -294,7 +320,7 @@ protected override void HandleUpdate()
             }
             else
             {
-                if(oldState == 1)
+                if (oldState == 1)
                 {
                     value = 0;
                     OnReleased(SetControlEvent());
@@ -305,7 +331,7 @@ protected override void HandleUpdate()
         protected virtual void FixedUpdate()
         {
             // update reference position if no force is acting on the button to support scenarios where the button is moved at runtime with a connected body
-            if (forceCount == 0 && buttonJoint.connectedBody)
+            if (forceCount == 0 && buttonJoint.connectedBody != null)
             {
                 restingPosition = transform.position;
             }