chore(Pointer): rename world pointer to base pointer for consistency

thestonefox · thestonefox · commit 15f5266d935a · 2016-11-13T23:45:58.000Z
All other base abstract classes are named `Base_`. It is more
appropriate for the World Pointer to be called Base Pointer as this
is more consistent with other scripts.
diff --git a/Assets/VRTK/Examples/Resources/Scripts/Setup_Scene_031.cs b/Assets/VRTK/Examples/Resources/Scripts/Setup_Scene_031.cs
@@ -21,7 +21,7 @@ private void Update()
                     var pointer = headset.gameObject.AddComponent<VRTK_BezierPointer>();
 
                     pointer.controller = VRTK_DeviceFinder.GetControllerRightHand().GetComponent<VRTK_ControllerEvents>();
-                    pointer.pointerVisibility = VRTK_WorldPointer.pointerVisibilityStates.Always_Off;
+                    pointer.pointerVisibility = VRTK_BasePointer.pointerVisibilityStates.Always_Off;
                     pointer.pointerLength = 7f;
                     pointer.pointerDensity = 1;
                     pointer.pointerCursorRadius = 0.3f;
diff --git a/Assets/VRTK/Examples/Resources/Scripts/Setup_Scene_034.cs b/Assets/VRTK/Examples/Resources/Scripts/Setup_Scene_034.cs
@@ -20,7 +20,7 @@ private void Update()
 
                     pointer.controller = controllerEvents;
                     pointer.enableTeleport = false;
-                    pointer.pointerVisibility = VRTK_WorldPointer.pointerVisibilityStates.Always_Off;
+                    pointer.pointerVisibility = VRTK_BasePointer.pointerVisibilityStates.Always_Off;
                     pointer.pointerLength = 100f;
                     pointer.showPointerTip = true;
                 }
diff --git a/Assets/VRTK/Scripts/Interactions/VRTK_InteractableObject.cs b/Assets/VRTK/Scripts/Interactions/VRTK_InteractableObject.cs
@@ -99,7 +99,7 @@ public enum ValidDropTypes
         public bool holdButtonToUse = true;
         [Tooltip("If this is checked the object can be used only if it is currently being grabbed.")]
         public bool useOnlyIfGrabbed = false;
-        [Tooltip("If this is checked then when a World Pointer beam (projected from the controller) hits the interactable object, if the object has `Hold Button To Use` unchecked then whilst the pointer is over the object it will run it's `Using` method. If `Hold Button To Use` is unchecked then the `Using` method will be run when the pointer is deactivated. The world pointer will not throw the `Destination Set` event if it is affecting an interactable object with this setting checked as this prevents unwanted teleporting from happening when using an object with a pointer.")]
+        [Tooltip("If this is checked then when a Base Pointer beam (projected from the controller) hits the interactable object, if the object has `Hold Button To Use` unchecked then whilst the pointer is over the object it will run it's `Using` method. If `Hold Button To Use` is unchecked then the `Using` method will be run when the pointer is deactivated. The world pointer will not throw the `Destination Set` event if it is affecting an interactable object with this setting checked as this prevents unwanted teleporting from happening when using an object with a pointer.")]
         public bool pointerActivatesUseAction = false;
         [Tooltip("If this is set to `Undefined` then the global use alias button will use the object, setting it to any other button will ensure the override button is used to use this specific interactable object.")]
         public VRTK_ControllerEvents.ButtonAlias useOverrideButton = VRTK_ControllerEvents.ButtonAlias.Undefined;
diff --git a/Assets/VRTK/Scripts/Locomotion/VRTK_BasicTeleport.cs b/Assets/VRTK/Scripts/Locomotion/VRTK_BasicTeleport.cs
@@ -12,7 +12,7 @@ namespace VRTK
     public delegate void TeleportEventHandler(object sender, DestinationMarkerEventArgs e);
 
     /// <summary>
-    /// The basic teleporter updates the `[CameraRig]` x/z position in the game world to the position of a World Pointer's tip location which is set via the `WorldPointerDestinationSet` event. The y position is never altered so the basic teleporter cannot be used to move up and down game objects as it only allows for travel across a flat plane.
+    /// The basic teleporter updates the `[CameraRig]` x/z position in the game world to the position of a Base Pointer's tip location which is set via the `DestinationMarkerSet` event. The y position is never altered so the basic teleporter cannot be used to move up and down game objects as it only allows for travel across a flat plane.
     /// </summary>
     /// <remarks>
     /// The Basic Teleport script is attached to the `[CameraRig]` prefab.
diff --git a/Assets/VRTK/Scripts/Locomotion/VRTK_DashTeleport.cs b/Assets/VRTK/Scripts/Locomotion/VRTK_DashTeleport.cs
@@ -24,7 +24,7 @@ public struct DashTeleportEventArgs
     /// The dash teleporter extends the height adjust teleporter and allows to have the `[CameraRig]` dashing to a new teleport location. 
     /// </summary>
     /// <remarks>
-    /// Like the basic teleporter and the height adjustable teleporter the Dash Teleport script is attached to the `[CameraRig]` prefab and requires a World Pointer to be available.
+    /// Like the basic teleporter and the height adjustable teleporter the Dash Teleport script is attached to the `[CameraRig]` prefab.
     ///
     /// The basic principle is to dash for a very short amount of time, to avoid sim sickness. The default value is 100 miliseconds. This value is fixed for all normal and longer distances. When the distances get very short the minimum speed is clamped to 50 mps, so the dash time becomes even shorter.
     ///
diff --git a/Assets/VRTK/Scripts/Pointers/VRTK_BasePointer.cs b/Assets/VRTK/Scripts/Pointers/VRTK_BasePointer.cs
@@ -1,17 +1,17 @@
-﻿// World Pointer|Pointers|10020
+﻿// Base Pointer|Pointers|10020
 namespace VRTK
 {
     using UnityEngine;
 
     /// <summary>
-    /// This abstract class provides any game pointer the ability to know the state of the implemented pointer. It extends the `VRTK_DestinationMarker` to allow for destination events to be emitted when the pointer cursor collides with objects.
+    /// This abstract class provides any game pointer the ability to know the state of the implemented pointer.
     /// </summary>
     /// <remarks>
-    /// The World Pointer also provides a play area cursor to be displayed for all cursors that utilise this class. The play area cursor is a representation of the current calibrated play area space and is useful for visualising the potential new play area space in the game world prior to teleporting. It can also handle collisions with objects on the new play area space and prevent teleporting if there are any collisions with objects at the potential new destination.
+    /// It extends the `VRTK_DestinationMarker` to allow for destination events to be emitted when the pointer cursor collides with objects.
     ///
-    /// The play area collider does not work well with terrains as they are uneven and cause collisions regularly so it is recommended that handling play area collisions is not enabled when using terrains.
+    /// As this is an abstract class, it cannot be applied directly to a game object and performs no logic.
     /// </remarks>
-    public abstract class VRTK_WorldPointer : VRTK_DestinationMarker
+    public abstract class VRTK_BasePointer : VRTK_DestinationMarker
     {
         /// <summary>
         /// States of Pointer Visibility.
@@ -26,7 +26,8 @@ public enum pointerVisibilityStates
             Always_Off
         }
 
-        [Header("Generic Pointer Settings", order = 2)]
+        [Header("Base Pointer Settings", order = 2)]
+
         [Tooltip("The controller that will be used to toggle the pointer. If the script is being applied onto a controller then this parameter can be left blank as it will be auto populated by the controller the script is on at runtime.")]
         public VRTK_ControllerEvents controller = null;
         [Tooltip("A custom transform to use as the origin of the pointer. If no pointer origin transform is provided then the transform the script is attached to is used.")]
@@ -113,7 +114,7 @@ protected virtual void Awake()
             }
             if (controller == null)
             {
-                Debug.LogError("VRTK_WorldPointer requires a Controller that has the VRTK_ControllerEvents script attached to it");
+                Debug.LogError("VRTK_BasePointer requires a Controller that has the VRTK_ControllerEvents script attached to it");
                 return;
             }
             Utilities.SetPlayerObject(gameObject, VRTK_PlayerObject.ObjectTypes.Pointer);
@@ -375,13 +376,13 @@ protected virtual bool ValidDestination(Transform target, Vector3 destinationPos
 
         protected virtual void CreateObjectInteractor()
         {
-            objectInteractor = new GameObject(string.Format("[{0}]WorldPointer_ObjectInteractor_Holder", gameObject.name));
+            objectInteractor = new GameObject(string.Format("[{0}]BasePointer_ObjectInteractor_Holder", gameObject.name));
             objectInteractor.transform.SetParent(controller.transform);
             objectInteractor.transform.localPosition = Vector3.zero;
             objectInteractor.layer = LayerMask.NameToLayer("Ignore Raycast");
             Utilities.SetPlayerObject(objectInteractor, VRTK_PlayerObject.ObjectTypes.Pointer);
 
-            var objectInteractorCollider = new GameObject(string.Format("[{0}]WorldPointer_ObjectInteractor_Collider", gameObject.name));
+            var objectInteractorCollider = new GameObject(string.Format("[{0}]BasePointer_ObjectInteractor_Collider", gameObject.name));
             objectInteractorCollider.transform.SetParent(objectInteractor.transform);
             objectInteractorCollider.transform.localPosition = Vector3.zero;
             objectInteractorCollider.layer = LayerMask.NameToLayer("Ignore Raycast");
@@ -391,7 +392,7 @@ protected virtual void CreateObjectInteractor()
 
             if (grabToPointerTip)
             {
-                objectInteractorAttachPoint = new GameObject(string.Format("[{0}]WorldPointer_ObjectInteractor_AttachPoint", gameObject.name));
+                objectInteractorAttachPoint = new GameObject(string.Format("[{0}]BasePointer_ObjectInteractor_AttachPoint", gameObject.name));
                 objectInteractorAttachPoint.transform.SetParent(objectInteractor.transform);
                 objectInteractorAttachPoint.transform.localPosition = Vector3.zero;
                 objectInteractorAttachPoint.layer = LayerMask.NameToLayer("Ignore Raycast");
diff --git a/Assets/VRTK/Scripts/Pointers/VRTK_BasePointer.cs.meta b/Assets/VRTK/Scripts/Pointers/VRTK_BasePointer.cs.meta
diff --git a/Assets/VRTK/Scripts/Pointers/VRTK_BezierPointer.cs b/Assets/VRTK/Scripts/Pointers/VRTK_BezierPointer.cs
@@ -18,9 +18,10 @@ namespace VRTK
     ///
     /// `VRTK/Examples/036_Controller_CustomCompoundPointer' shows how to display an object (a teleport beam) only if the teleport location is valid, and can create an animated trail along the tracer curve.
     /// </example>
-    public class VRTK_BezierPointer : VRTK_WorldPointer
+    public class VRTK_BezierPointer : VRTK_BasePointer
     {
         [Header("Bezier Pointer Settings", order = 3)]
+
         [Tooltip("The length of the projected forward pointer beam, this is basically the distance able to point from the controller position.")]
         public float pointerLength = 10f;
         [Tooltip("The number of items to render in the beam bezier curve. A high number here will most likely have a negative impact of game performance due to large number of rendered objects.")]
@@ -99,18 +100,18 @@ protected override void InitPointer()
             if (validTeleportLocationObject != null)
             {
                 validTeleportLocationInstance = Instantiate(validTeleportLocationObject);
-                validTeleportLocationInstance.name = string.Format("[{0}]WorldPointer_BezierPointer_TeleportBeam", gameObject.name);
+                validTeleportLocationInstance.name = string.Format("[{0}]BasePointer_BezierPointer_TeleportBeam", gameObject.name);
                 validTeleportLocationInstance.transform.parent = pointerCursor.transform;
                 validTeleportLocationInstance.layer = LayerMask.NameToLayer("Ignore Raycast");
                 validTeleportLocationInstance.SetActive(false);
             }
 
-            pointerCursor.name = string.Format("[{0}]WorldPointer_BezierPointer_PointerCursor", gameObject.name);
+            pointerCursor.name = string.Format("[{0}]BasePointer_BezierPointer_PointerCursor", gameObject.name);
             Utilities.SetPlayerObject(pointerCursor, VRTK_PlayerObject.ObjectTypes.Pointer);
             pointerCursor.layer = LayerMask.NameToLayer("Ignore Raycast");
             pointerCursor.SetActive(false);
 
-            curvedBeamContainer = new GameObject(string.Format("[{0}]WorldPointer_BezierPointer_CurvedBeamContainer", gameObject.name));
+            curvedBeamContainer = new GameObject(string.Format("[{0}]BasePointer_BezierPointer_CurvedBeamContainer", gameObject.name));
             Utilities.SetPlayerObject(curvedBeamContainer, VRTK_PlayerObject.ObjectTypes.Pointer);
             curvedBeamContainer.SetActive(false);
             curvedBeam = curvedBeamContainer.gameObject.AddComponent<CurveGenerator>();
diff --git a/Assets/VRTK/Scripts/Pointers/VRTK_DestinationMarker.cs b/Assets/VRTK/Scripts/Pointers/VRTK_DestinationMarker.cs
@@ -33,7 +33,7 @@ public struct DestinationMarkerEventArgs
     /// This abstract class provides the ability to emit events of destination markers within the game world. It can be useful for tagging locations for specific purposes such as teleporting.
     /// </summary>
     /// <remarks>
-    /// It is utilised by the `VRTK_WorldPointer` for dealing with pointer events when the pointer cursor touches areas within the game world.
+    /// It is utilised by the `VRTK_BasePointer` for dealing with pointer events when the pointer cursor touches areas within the game world.
     /// </remarks>
     public abstract class VRTK_DestinationMarker : MonoBehaviour
     {
diff --git a/Assets/VRTK/Scripts/Pointers/VRTK_PlayAreaCursor.cs b/Assets/VRTK/Scripts/Pointers/VRTK_PlayAreaCursor.cs
@@ -4,7 +4,7 @@ namespace VRTK
     using UnityEngine;
 
     /// <summary>
-    /// The Play Area Cursor is used in conjunction with a World Pointer script and displays a representation of the play area where the pointer cursor hits.
+    /// The Play Area Cursor is used in conjunction with a Base Pointer script and displays a representation of the play area where the pointer cursor hits.
     /// </summary>
     /// <example>
     /// `VRTK/Examples/012_Controller_PointerWithAreaCollision` shows how a Bezier Pointer with the Play Area Cursor and Collision Detection enabled can be used to traverse a game area but not allow teleporting into areas where the walls or other objects would fall into the play area space enabling the user to enter walls.
@@ -13,7 +13,7 @@ public class VRTK_PlayAreaCursor : MonoBehaviour
     {
         [Tooltip("Determines the size of the play area cursor and collider. If the values are left as zero then the Play Area Cursor will be sized to the calibrated Play Area space.")]
         public Vector2 playAreaCursorDimensions = Vector2.zero;
-        [Tooltip("If this is ticked then if the play area cursor is colliding with any other object then the pointer colour will change to the `Pointer Miss Color` and the `WorldPointerDestinationSet` event will not be triggered, which will prevent teleporting into areas where the play area will collide.")]
+        [Tooltip("If this is ticked then if the play area cursor is colliding with any other object then the pointer colour will change to the `Pointer Miss Color` and the `DestinationMarkerSet` event will not be triggered, which will prevent teleporting into areas where the play area will collide.")]
         public bool handlePlayAreaCursorCollisions = false;
         [Tooltip("If this is ticked then if the user's headset is outside of the play area cursor bounds then it is considered a collision even if the play area isn't colliding with anything.")]
         public bool headsetOutOfBoundsIsCollision = false;
@@ -121,9 +121,9 @@ public virtual void ToggleState(bool state)
 
         protected virtual void Awake()
         {
-            if (!GetComponent<VRTK_WorldPointer>())
+            if (!GetComponent<VRTK_BasePointer>())
             {
-                Debug.LogError("VRTK_PlayAreaCursor requires a VRTK_WorldPointer script attached to the same object.");
+                Debug.LogError("VRTK_PlayAreaCursor requires a VRTK_BasePointer script attached to the same object.");
                 return;
             }
 
diff --git a/Assets/VRTK/Scripts/Pointers/VRTK_SimplePointer.cs b/Assets/VRTK/Scripts/Pointers/VRTK_SimplePointer.cs
@@ -14,9 +14,10 @@ namespace VRTK
     /// <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>
-    public class VRTK_SimplePointer : VRTK_WorldPointer
+    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.")]
@@ -100,13 +101,13 @@ protected override void UpdateObjectInteractor()
 
         protected override void InitPointer()
         {
-            pointerHolder = new GameObject(string.Format("[{0}]WorldPointer_SimplePointer_Holder", gameObject.name));
+            pointerHolder = new GameObject(string.Format("[{0}]BasePointer_SimplePointer_Holder", gameObject.name));
             pointerHolder.transform.parent = transform;
             pointerHolder.transform.localPosition = Vector3.zero;
             Utilities.SetPlayerObject(pointerHolder, VRTK_PlayerObject.ObjectTypes.Pointer);
 
             pointer = GameObject.CreatePrimitive(PrimitiveType.Cube);
-            pointer.transform.name = string.Format("[{0}]WorldPointer_SimplePointer_Pointer", gameObject.name);
+            pointer.transform.name = string.Format("[{0}]BasePointer_SimplePointer_Pointer", gameObject.name);
             pointer.transform.parent = pointerHolder.transform;
             pointer.GetComponent<BoxCollider>().isTrigger = true;
             pointer.AddComponent<Rigidbody>().isKinematic = true;
@@ -135,7 +136,7 @@ protected override void InitPointer()
             }
 
             pointerCursorOriginalScale = pointerTip.transform.localScale;
-            pointerTip.transform.name = string.Format("[{0}]WorldPointer_SimplePointer_PointerTip", gameObject.name);
+            pointerTip.transform.name = string.Format("[{0}]BasePointer_SimplePointer_PointerTip", gameObject.name);
             pointerTip.transform.parent = pointerHolder.transform;
             pointerTip.GetComponent<Collider>().isTrigger = true;
             pointerTip.AddComponent<Rigidbody>().isKinematic = true;
diff --git a/Assets/VRTK/Scripts/UI/VRTK_UIPointer.cs b/Assets/VRTK/Scripts/UI/VRTK_UIPointer.cs
@@ -28,7 +28,7 @@ public struct UIPointerEventArgs
     public delegate void UIPointerEventHandler(object sender, UIPointerEventArgs e);
 
     /// <summary>
-    /// The UI Pointer provides a mechanism for interacting with Unity UI elements on a world canvas. The UI Pointer can be attached to any game object the same way in which a World Pointer can be and the UI Pointer also requires a controller to initiate the pointer activation and pointer click states.
+    /// The UI Pointer provides a mechanism for interacting with Unity UI elements on a world canvas. The UI Pointer can be attached to any game object the same way in which a Base Pointer can be and the UI Pointer also requires a controller to initiate the pointer activation and pointer click states.
     /// </summary>
     /// <remarks>
     /// The simplest way to use the UI Pointer is to attach the script to a game controller within the `[CameraRig]` along with a Simple Pointer as this provides visual feedback as to where the UI ray is pointing.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ private void Update()`
`20`	`20`
`21`	`21`	`pointer.controller = controllerEvents;`
`22`	`22`	`pointer.enableTeleport = false;`
`23`		`- pointer.pointerVisibility = VRTK_WorldPointer.pointerVisibilityStates.Always_Off;`
	`23`	`+ pointer.pointerVisibility = VRTK_BasePointer.pointerVisibilityStates.Always_Off;`
`24`	`24`	`pointer.pointerLength = 100f;`
`25`	`25`	`pointer.showPointerTip = true;`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public struct DestinationMarkerEventArgs`
`33`	`33`	`/// This abstract class provides the ability to emit events of destination markers within the game world. It can be useful for tagging locations for specific purposes such as teleporting.`
`34`	`34`	`/// </summary>`
`35`	`35`	`/// <remarks>`
`36`		- /// It is utilised by the `VRTK_WorldPointer` for dealing with pointer events when the pointer cursor touches areas within the game world.
	`36`	+ /// It is utilised by the `VRTK_BasePointer` for dealing with pointer events when the pointer cursor touches areas within the game world.
`37`	`37`	`/// </remarks>`
`38`	`38`	`public abstract class VRTK_DestinationMarker : MonoBehaviour`
`39`	`39`	`{`