feat(Interaction): provide custom highlighter to interactable object

thestonefox · thestonefox · commit 40812fc6bf4f · 2017-09-12T13:04:34.000+01:00
&gt; **Breaking Changes**

The Interactable Object script now has an additional parameter that
allows injecting a Base Highlighter for the Interactable Object to
use.

This means that the Highlighter does not need to be on the same
GameObject as the Interactable Object and can also be swapped out
at runtime for a different highlighter.

To enable this to work, the Highlighters now can accept new
GameObject parameter in the Initialise method. This GameObject
parameter is the second parameter pushing the `options` parameter
to the 3rd param which will cause a breaking change for anyone
using the existing code.
diff --git a/Assets/VRTK/Documentation/API.md b/Assets/VRTK/Documentation/API.md
@@ -3713,6 +3713,7 @@ The highlighting of an Interactable Object is defaulted to use the `VRTK_Materia
  * **Pointer Activates Use Action:** 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.
  * **Use Override Button:** 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.
  * **Allowed Use Controllers:** Determines which controller can initiate a use action.
+ * **Object Highlighter:** An optional Highlighter to use when highlighting this Interactable Object. If this is left blank, then the first active highlighter on the same GameObject will be used, if one isn't found then a Material Color Swap Highlighter will be created at runtime.
 
 ### Class Variables
 
@@ -4530,12 +4531,13 @@ As this is an abstract class, it cannot be applied directly to a game object and
 
 ### Class Methods
 
-#### Initialise/2
+#### Initialise/3
 
-  > `public abstract void Initialise(Color? color = null, Dictionary<string, object> options = null);`
+  > `public abstract void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null);`
 
  * Parameters
    * `Color? color` - An optional colour may be passed through at point of initialisation in case the highlighter requires it.
+   * `GameObject affectObject` - An optional GameObject to specify which object to apply the highlighting to.
    * `Dictionary<string, object> options` - An optional dictionary of highlighter specific options that may be differ with highlighter implementations.
  * Returns
    * _none_
@@ -4635,12 +4637,13 @@ This is the default highlighter that is applied to any script that requires a hi
 
 ### Class Methods
 
-#### Initialise/2
+#### Initialise/3
 
-  > `public override void Initialise(Color? color = null, Dictionary<string, object> options = null)`
+  > `public override void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null)`
 
  * Parameters
    * `Color? color` - Not used.
+   * `GameObject affectObject` - An optional GameObject to specify which object to apply the highlighting to.
    * `Dictionary<string, object> options` - A dictionary array containing the highlighter options:
      * `<'resetMainTexture', bool>` - Determines if the default main texture should be cleared on highlight. `true` to reset the main default texture, `false` to not reset it.
  * Returns
@@ -4706,12 +4709,13 @@ The Draw Call Batching will resume on the original material when the item is no
 
 ### Class Methods
 
-#### Initialise/2
+#### Initialise/3
 
-  > `public override void Initialise(Color? color = null, Dictionary<string, object> options = null)`
+  > `public override void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null)`
 
  * Parameters
    * `Color? color` - Not used.
+   * `GameObject affectObject` - An optional GameObject to specify which object to apply the highlighting to.
    * `Dictionary<string, object> options` - A dictionary array containing the highlighter options:
      * `<'resetMainTexture', bool>` - Determines if the default main texture should be cleared on highlight. `true` to reset the main default texture, `false` to not reset it.
  * Returns
@@ -4749,12 +4753,13 @@ The Outline Object Copy Highlighter works by making a copy of a mesh and adding
 
 ### Class Methods
 
-#### Initialise/2
+#### Initialise/3
 
-  > `public override void Initialise(Color? color = null, Dictionary<string, object> options = null)`
+  > `public override void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null)`
 
  * Parameters
    * `Color? color` - Not used.
+   * `GameObject affectObject` - An optional GameObject to specify which object to apply the highlighting to.
    * `Dictionary<string, object> options` - A dictionary array containing the highlighter options:
      * `<'thickness', float>` - Same as `thickness` inspector parameter.
      * `<'customOutlineModels', GameObject[]>` - Same as `customOutlineModels` inspector parameter.
diff --git a/Assets/VRTK/Source/Scripts/Interactions/Highlighters/VRTK_BaseHighlighter.cs b/Assets/VRTK/Source/Scripts/Interactions/Highlighters/VRTK_BaseHighlighter.cs
@@ -18,13 +18,15 @@ public abstract class VRTK_BaseHighlighter : MonoBehaviour
         public bool unhighlightOnDisable = true;
 
         protected bool usesClonedObject = false;
+        protected GameObject objectToAffect;
 
         /// <summary>
         /// The Initalise method is used to set up the state of the highlighter.
         /// </summary>
         /// <param name="color">An optional colour may be passed through at point of initialisation in case the highlighter requires it.</param>
+        /// <param name="affectObject">An optional GameObject to specify which object to apply the highlighting to.</param>
         /// <param name="options">An optional dictionary of highlighter specific options that may be differ with highlighter implementations.</param>
-        public abstract void Initialise(Color? color = null, Dictionary<string, object> options = null);
+        public abstract void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null);
 
         /// <summary>
         /// The ResetHighlighter method is used to reset the highlighter if anything on the object has changed. It should be called by any scripts changing object materials or colours.
diff --git a/Assets/VRTK/Source/Scripts/Interactions/Highlighters/VRTK_MaterialColorSwapHighlighter.cs b/Assets/VRTK/Source/Scripts/Interactions/Highlighters/VRTK_MaterialColorSwapHighlighter.cs
@@ -37,9 +37,11 @@ public class VRTK_MaterialColorSwapHighlighter : VRTK_BaseHighlighter
         /// The Initialise method sets up the highlighter for use.
         /// </summary>
         /// <param name="color">Not used.</param>
+        /// <param name="affectObject">An optional GameObject to specify which object to apply the highlighting to.</param>
         /// <param name="options">A dictionary array containing the highlighter options:\r     * `&lt;'resetMainTexture', bool&gt;` - Determines if the default main texture should be cleared on highlight. `true` to reset the main default texture, `false` to not reset it.</param>
-        public override void Initialise(Color? color = null, Dictionary<string, object> options = null)
+        public override void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null)
         {
+            objectToAffect = (affectObject != null ? affectObject : gameObject);
             originalSharedRendererMaterials = new Dictionary<string, Material[]>();
             originalRendererMaterials = new Dictionary<string, Material[]>();
             faderRoutines = new Dictionary<string, Coroutine>();
@@ -76,7 +78,7 @@ public override void Highlight(Color? color, float duration = 0f)
         /// <param name="duration">Not used.</param>
         public override void Unhighlight(Color? color = null, float duration = 0f)
         {
-            if (originalRendererMaterials == null)
+            if (originalRendererMaterials == null || objectToAffect == null)
             {
                 return;
             }
@@ -90,7 +92,7 @@ public override void Unhighlight(Color? color = null, float duration = 0f)
                 faderRoutines.Clear();
             }
 
-            Renderer[] renderers = GetComponentsInChildren<Renderer>(true);
+            Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);
             for (int i = 0; i < renderers.Length; i++)
             {
                 Renderer renderer = renderers[i];
@@ -109,7 +111,7 @@ protected virtual void StoreOriginalMaterials()
         {
             originalSharedRendererMaterials.Clear();
             originalRendererMaterials.Clear();
-            Renderer[] renderers = GetComponentsInChildren<Renderer>(true);
+            Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);
             for (int i = 0; i < renderers.Length; i++)
             {
                 Renderer renderer = renderers[i];
@@ -122,7 +124,7 @@ protected virtual void StoreOriginalMaterials()
 
         protected virtual void ChangeToHighlightColor(Color color, float duration = 0f)
         {
-            Renderer[] renderers = GetComponentsInChildren<Renderer>(true);
+            Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);
             for (int j = 0; j < renderers.Length; j++)
             {
                 Renderer renderer = renderers[j];
diff --git a/Assets/VRTK/Source/Scripts/Interactions/Highlighters/VRTK_MaterialPropertyBlockColorSwapHighlighter.cs b/Assets/VRTK/Source/Scripts/Interactions/Highlighters/VRTK_MaterialPropertyBlockColorSwapHighlighter.cs
@@ -25,13 +25,15 @@ public class VRTK_MaterialPropertyBlockColorSwapHighlighter : VRTK_MaterialColor
         /// The Initialise method sets up the highlighter for use.
         /// </summary>
         /// <param name="color">Not used.</param>
+        /// <param name="affectObject">An optional GameObject to specify which object to apply the highlighting to.</param>
         /// <param name="options">A dictionary array containing the highlighter options:\r     * `&lt;'resetMainTexture', bool&gt;` - Determines if the default main texture should be cleared on highlight. `true` to reset the main default texture, `false` to not reset it.</param>
-        public override void Initialise(Color? color = null, Dictionary<string, object> options = null)
+        public override void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null)
         {
+            objectToAffect = (affectObject != null ? affectObject : gameObject);
             originalMaterialPropertyBlocks = new Dictionary<string, MaterialPropertyBlock>();
             highlightMaterialPropertyBlocks = new Dictionary<string, MaterialPropertyBlock>();
             // call to parent highlighter
-            base.Initialise(color, options);
+            base.Initialise(color, affectObject, options);
         }
 
         /// <summary>
@@ -41,7 +43,7 @@ public override void Initialise(Color? color = null, Dictionary<string, object>
         /// <param name="duration">Not used.</param>
         public override void Unhighlight(Color? color = null, float duration = 0f)
         {
-            if (originalMaterialPropertyBlocks == null)
+            if (originalMaterialPropertyBlocks == null || objectToAffect == null)
             {
                 return;
             }
@@ -55,7 +57,7 @@ public override void Unhighlight(Color? color = null, float duration = 0f)
                 faderRoutines.Clear();
             }
 
-            Renderer[] renderers = GetComponentsInChildren<Renderer>(true);
+            Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);
             for (int i = 0; i < renderers.Length; i++)
             {
                 Renderer renderer = renderers[i];
@@ -73,7 +75,7 @@ protected override void StoreOriginalMaterials()
         {
             originalMaterialPropertyBlocks.Clear();
             highlightMaterialPropertyBlocks.Clear();
-            Renderer[] renderers = GetComponentsInChildren<Renderer>(true);
+            Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);
             for (int i = 0; i < renderers.Length; i++)
             {
                 Renderer renderer = renderers[i];
@@ -86,7 +88,7 @@ protected override void StoreOriginalMaterials()
 
         protected override void ChangeToHighlightColor(Color color, float duration = 0f)
         {
-            Renderer[] renderers = GetComponentsInChildren<Renderer>(true);
+            Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);
             for (int i = 0; i < renderers.Length; i++)
             {
                 Renderer renderer = renderers[i];
diff --git a/Assets/VRTK/Source/Scripts/Interactions/Highlighters/VRTK_OutlineObjectCopyHighlighter.cs b/Assets/VRTK/Source/Scripts/Interactions/Highlighters/VRTK_OutlineObjectCopyHighlighter.cs
@@ -33,9 +33,11 @@ public class VRTK_OutlineObjectCopyHighlighter : VRTK_BaseHighlighter
         /// The Initialise method sets up the highlighter for use.
         /// </summary>
         /// <param name="color">Not used.</param>
+        /// <param name="affectObject">An optional GameObject to specify which object to apply the highlighting to.</param>
         /// <param name="options">A dictionary array containing the highlighter options:\r     * `&lt;'thickness', float&gt;` - Same as `thickness` inspector parameter.\r     * `&lt;'customOutlineModels', GameObject[]&gt;` - Same as `customOutlineModels` inspector parameter.\r     * `&lt;'customOutlineModelPaths', string[]&gt;` - Same as `customOutlineModelPaths` inspector parameter.</param>
-        public override void Initialise(Color? color = null, Dictionary<string, object> options = null)
+        public override void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null)
         {
+            objectToAffect = (affectObject != null ? affectObject : gameObject);
             usesClonedObject = true;
 
             if (stencilOutline == null)
@@ -89,6 +91,11 @@ public override void Highlight(Color? color, float duration = 0f)
         /// <param name="duration">Not used.</param>
         public override void Unhighlight(Color? color = null, float duration = 0f)
         {
+            if (objectToAffect == null)
+            {
+                return;
+            }
+
             if (highlightModels != null)
             {
                 for (int i = 0; i < highlightModels.Length; i++)
@@ -185,14 +192,15 @@ protected virtual void SetOptions(Dictionary<string, object> options = null)
 
         protected virtual void DeleteExistingHighlightModels()
         {
-            VRTK_PlayerObject[] existingHighlighterObjects = GetComponentsInChildren<VRTK_PlayerObject>(true);
+            VRTK_PlayerObject[] existingHighlighterObjects = objectToAffect.GetComponentsInChildren<VRTK_PlayerObject>(true);
             for (int i = 0; i < existingHighlighterObjects.Length; i++)
             {
                 if (existingHighlighterObjects[i].objectType == VRTK_PlayerObject.ObjectTypes.Highlighter)
                 {
                     Destroy(existingHighlighterObjects[i].gameObject);
                 }
             }
+            highlightModels = new GameObject[0];
         }
 
         protected virtual GameObject CreateHighlightModel(GameObject givenOutlineModel, string givenOutlineModelPath)
@@ -203,14 +211,15 @@ protected virtual GameObject CreateHighlightModel(GameObject givenOutlineModel,
             }
             else if (givenOutlineModelPath != "")
             {
-                Transform getChildModel = transform.Find(givenOutlineModelPath);
+                Transform getChildModel = objectToAffect.transform.Find(givenOutlineModelPath);
                 givenOutlineModel = (getChildModel ? getChildModel.gameObject : null);
             }
 
             GameObject copyModel = givenOutlineModel;
             if (copyModel == null)
             {
-                copyModel = (GetComponent<Renderer>() ? gameObject : GetComponentInChildren<Renderer>().gameObject);
+                Renderer copyModelRenderer = objectToAffect.GetComponentInChildren<Renderer>();
+                copyModel = (copyModelRenderer != null ? copyModelRenderer.gameObject : null);
             }
 
             if (copyModel == null)
@@ -219,12 +228,12 @@ protected virtual GameObject CreateHighlightModel(GameObject givenOutlineModel,
                 return null;
             }
 
-            GameObject highlightModel = new GameObject(name + "_HighlightModel");
+            GameObject highlightModel = new GameObject(objectToAffect.name + "_HighlightModel");
             highlightModel.transform.SetParent(copyModel.transform.parent, false);
             highlightModel.transform.localPosition = copyModel.transform.localPosition;
             highlightModel.transform.localRotation = copyModel.transform.localRotation;
             highlightModel.transform.localScale = copyModel.transform.localScale;
-            highlightModel.transform.SetParent(transform);
+            highlightModel.transform.SetParent(objectToAffect.transform);
 
             Component[] copyModelComponents = copyModel.GetComponents<Component>();
             for (int i = 0; i < copyModelComponents.Length; i++)
diff --git a/Assets/VRTK/Source/Scripts/Interactions/VRTK_ControllerHighlighter.cs b/Assets/VRTK/Source/Scripts/Interactions/VRTK_ControllerHighlighter.cs
@@ -121,7 +121,7 @@ public virtual void PopulateHighlighters()
 
                 SDK_BaseController.ControllerHand currentHand = VRTK_DeviceFinder.GetControllerHand(actualController);
 
-                objectHighlighter.Initialise(null, highlighterOptions);
+                objectHighlighter.Initialise(null, null, highlighterOptions);
 
                 AddHighlighterToElement(GetElementTransform(VRTK_SDK_Bridge.GetControllerElementPath(SDK_BaseController.ControllerElements.ButtonOne, currentHand)), objectHighlighter, elementHighlighterOverrides.buttonOne);
                 AddHighlighterToElement(GetElementTransform(VRTK_SDK_Bridge.GetControllerElementPath(SDK_BaseController.ControllerElements.ButtonTwo, currentHand)), objectHighlighter, elementHighlighterOverrides.buttonTwo);
@@ -396,7 +396,7 @@ protected virtual void AddHighlighterToElement(Transform element, VRTK_BaseHighl
             {
                 VRTK_BaseHighlighter highlighter = (overrideHighlighter != null ? overrideHighlighter : parentHighlighter);
                 VRTK_BaseHighlighter clonedHighlighter = (VRTK_BaseHighlighter)VRTK_SharedMethods.CloneComponent(highlighter, element.gameObject);
-                clonedHighlighter.Initialise(null, highlighterOptions);
+                clonedHighlighter.Initialise(null, null, highlighterOptions);
             }
         }
 
diff --git a/Assets/VRTK/Source/Scripts/Interactions/VRTK_InteractableObject.cs b/Assets/VRTK/Source/Scripts/Interactions/VRTK_InteractableObject.cs

Original file line number	Diff line number	Diff line change
`@@ -37,9 +37,11 @@ public class VRTK_MaterialColorSwapHighlighter : VRTK_BaseHighlighter`
`37`	`37`	`/// The Initialise method sets up the highlighter for use.`
`38`	`38`	`/// </summary>`
`39`	`39`	`/// <param name="color">Not used.</param>`
	`40`	`+ /// <param name="affectObject">An optional GameObject to specify which object to apply the highlighting to.</param>`
`40`	`41`	/// <param name="options">A dictionary array containing the highlighter options:\r * `<'resetMainTexture', bool>` - Determines if the default main texture should be cleared on highlight. `true` to reset the main default texture, `false` to not reset it.</param>
`41`		`- public override void Initialise(Color? color = null, Dictionary<string, object> options = null)`
	`42`	`+ public override void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null)`
`42`	`43`	`{`
	`44`	`+ objectToAffect = (affectObject != null ? affectObject : gameObject);`
`43`	`45`	`originalSharedRendererMaterials = new Dictionary<string, Material[]>();`
`44`	`46`	`originalRendererMaterials = new Dictionary<string, Material[]>();`
`45`	`47`	`faderRoutines = new Dictionary<string, Coroutine>();`
`@@ -76,7 +78,7 @@ public override void Highlight(Color? color, float duration = 0f)`
`76`	`78`	`/// <param name="duration">Not used.</param>`
`77`	`79`	`public override void Unhighlight(Color? color = null, float duration = 0f)`
`78`	`80`	`{`
`79`		`- if (originalRendererMaterials == null)`
	`81`	`+ if (originalRendererMaterials == null \|\| objectToAffect == null)`
`80`	`82`	`{`
`81`	`83`	`return;`
`82`	`84`	`}`
`@@ -90,7 +92,7 @@ public override void Unhighlight(Color? color = null, float duration = 0f)`
`90`	`92`	`faderRoutines.Clear();`
`91`	`93`	`}`
`92`	`94`
`93`		`- Renderer[] renderers = GetComponentsInChildren<Renderer>(true);`
	`95`	`+ Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);`
`94`	`96`	`for (int i = 0; i < renderers.Length; i++)`
`95`	`97`	`{`
`96`	`98`	`Renderer renderer = renderers[i];`
`@@ -109,7 +111,7 @@ protected virtual void StoreOriginalMaterials()`
`109`	`111`	`{`
`110`	`112`	`originalSharedRendererMaterials.Clear();`
`111`	`113`	`originalRendererMaterials.Clear();`
`112`		`- Renderer[] renderers = GetComponentsInChildren<Renderer>(true);`
	`114`	`+ Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);`
`113`	`115`	`for (int i = 0; i < renderers.Length; i++)`
`114`	`116`	`{`
`115`	`117`	`Renderer renderer = renderers[i];`
`@@ -122,7 +124,7 @@ protected virtual void StoreOriginalMaterials()`
`122`	`124`
`123`	`125`	`protected virtual void ChangeToHighlightColor(Color color, float duration = 0f)`
`124`	`126`	`{`
`125`		`- Renderer[] renderers = GetComponentsInChildren<Renderer>(true);`
	`127`	`+ Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);`
`126`	`128`	`for (int j = 0; j < renderers.Length; j++)`
`127`	`129`	`{`
`128`	`130`	`Renderer renderer = renderers[j];`
Original file line number	Diff line number	Diff line change
`@@ -25,13 +25,15 @@ public class VRTK_MaterialPropertyBlockColorSwapHighlighter : VRTK_MaterialColor`
`25`	`25`	`/// The Initialise method sets up the highlighter for use.`
`26`	`26`	`/// </summary>`
`27`	`27`	`/// <param name="color">Not used.</param>`
	`28`	`+ /// <param name="affectObject">An optional GameObject to specify which object to apply the highlighting to.</param>`
`28`	`29`	/// <param name="options">A dictionary array containing the highlighter options:\r * `<'resetMainTexture', bool>` - Determines if the default main texture should be cleared on highlight. `true` to reset the main default texture, `false` to not reset it.</param>
`29`		`- public override void Initialise(Color? color = null, Dictionary<string, object> options = null)`
	`30`	`+ public override void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null)`
`30`	`31`	`{`
	`32`	`+ objectToAffect = (affectObject != null ? affectObject : gameObject);`
`31`	`33`	`originalMaterialPropertyBlocks = new Dictionary<string, MaterialPropertyBlock>();`
`32`	`34`	`highlightMaterialPropertyBlocks = new Dictionary<string, MaterialPropertyBlock>();`
`33`	`35`	`// call to parent highlighter`
`34`		`- base.Initialise(color, options);`
	`36`	`+ base.Initialise(color, affectObject, options);`
`35`	`37`	`}`
`36`	`38`
`37`	`39`	`/// <summary>`
`@@ -41,7 +43,7 @@ public override void Initialise(Color? color = null, Dictionary<string, object>`
`41`	`43`	`/// <param name="duration">Not used.</param>`
`42`	`44`	`public override void Unhighlight(Color? color = null, float duration = 0f)`
`43`	`45`	`{`
`44`		`- if (originalMaterialPropertyBlocks == null)`
	`46`	`+ if (originalMaterialPropertyBlocks == null \|\| objectToAffect == null)`
`45`	`47`	`{`
`46`	`48`	`return;`
`47`	`49`	`}`
`@@ -55,7 +57,7 @@ public override void Unhighlight(Color? color = null, float duration = 0f)`
`55`	`57`	`faderRoutines.Clear();`
`56`	`58`	`}`
`57`	`59`
`58`		`- Renderer[] renderers = GetComponentsInChildren<Renderer>(true);`
	`60`	`+ Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);`
`59`	`61`	`for (int i = 0; i < renderers.Length; i++)`
`60`	`62`	`{`
`61`	`63`	`Renderer renderer = renderers[i];`
`@@ -73,7 +75,7 @@ protected override void StoreOriginalMaterials()`
`73`	`75`	`{`
`74`	`76`	`originalMaterialPropertyBlocks.Clear();`
`75`	`77`	`highlightMaterialPropertyBlocks.Clear();`
`76`		`- Renderer[] renderers = GetComponentsInChildren<Renderer>(true);`
	`78`	`+ Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);`
`77`	`79`	`for (int i = 0; i < renderers.Length; i++)`
`78`	`80`	`{`
`79`	`81`	`Renderer renderer = renderers[i];`
`@@ -86,7 +88,7 @@ protected override void StoreOriginalMaterials()`
`86`	`88`
`87`	`89`	`protected override void ChangeToHighlightColor(Color color, float duration = 0f)`
`88`	`90`	`{`
`89`		`- Renderer[] renderers = GetComponentsInChildren<Renderer>(true);`
	`91`	`+ Renderer[] renderers = objectToAffect.GetComponentsInChildren<Renderer>(true);`
`90`	`92`	`for (int i = 0; i < renderers.Length; i++)`
`91`	`93`	`{`
`92`	`94`	`Renderer renderer = renderers[i];`
Original file line number	Diff line number	Diff line change
`@@ -33,9 +33,11 @@ public class VRTK_OutlineObjectCopyHighlighter : VRTK_BaseHighlighter`
`33`	`33`	`/// The Initialise method sets up the highlighter for use.`
`34`	`34`	`/// </summary>`
`35`	`35`	`/// <param name="color">Not used.</param>`
	`36`	`+ /// <param name="affectObject">An optional GameObject to specify which object to apply the highlighting to.</param>`
`36`	`37`	/// <param name="options">A dictionary array containing the highlighter options:\r * `<'thickness', float>` - Same as `thickness` inspector parameter.\r * `<'customOutlineModels', GameObject[]>` - Same as `customOutlineModels` inspector parameter.\r * `<'customOutlineModelPaths', string[]>` - Same as `customOutlineModelPaths` inspector parameter.</param>
`37`		`- public override void Initialise(Color? color = null, Dictionary<string, object> options = null)`
	`38`	`+ public override void Initialise(Color? color = null, GameObject affectObject = null, Dictionary<string, object> options = null)`
`38`	`39`	`{`
	`40`	`+ objectToAffect = (affectObject != null ? affectObject : gameObject);`
`39`	`41`	`usesClonedObject = true;`
`40`	`42`
`41`	`43`	`if (stencilOutline == null)`
`@@ -89,6 +91,11 @@ public override void Highlight(Color? color, float duration = 0f)`
`89`	`91`	`/// <param name="duration">Not used.</param>`
`90`	`92`	`public override void Unhighlight(Color? color = null, float duration = 0f)`
`91`	`93`	`{`
	`94`	`+ if (objectToAffect == null)`
	`95`	`+ {`
	`96`	`+ return;`
	`97`	`+ }`
	`98`	`+`
`92`	`99`	`if (highlightModels != null)`
`93`	`100`	`{`
`94`	`101`	`for (int i = 0; i < highlightModels.Length; i++)`
`@@ -185,14 +192,15 @@ protected virtual void SetOptions(Dictionary<string, object> options = null)`
`185`	`192`
`186`	`193`	`protected virtual void DeleteExistingHighlightModels()`
`187`	`194`	`{`
`188`		`- VRTK_PlayerObject[] existingHighlighterObjects = GetComponentsInChildren<VRTK_PlayerObject>(true);`
	`195`	`+ VRTK_PlayerObject[] existingHighlighterObjects = objectToAffect.GetComponentsInChildren<VRTK_PlayerObject>(true);`
`189`	`196`	`for (int i = 0; i < existingHighlighterObjects.Length; i++)`
`190`	`197`	`{`
`191`	`198`	`if (existingHighlighterObjects[i].objectType == VRTK_PlayerObject.ObjectTypes.Highlighter)`
`192`	`199`	`{`
`193`	`200`	`Destroy(existingHighlighterObjects[i].gameObject);`
`194`	`201`	`}`
`195`	`202`	`}`
	`203`	`+ highlightModels = new GameObject[0];`
`196`	`204`	`}`
`197`	`205`
`198`	`206`	`protected virtual GameObject CreateHighlightModel(GameObject givenOutlineModel, string givenOutlineModelPath)`
`@@ -203,14 +211,15 @@ protected virtual GameObject CreateHighlightModel(GameObject givenOutlineModel,`
`203`	`211`	`}`
`204`	`212`	`else if (givenOutlineModelPath != "")`
`205`	`213`	`{`
`206`		`- Transform getChildModel = transform.Find(givenOutlineModelPath);`
	`214`	`+ Transform getChildModel = objectToAffect.transform.Find(givenOutlineModelPath);`
`207`	`215`	`givenOutlineModel = (getChildModel ? getChildModel.gameObject : null);`
`208`	`216`	`}`
`209`	`217`
`210`	`218`	`GameObject copyModel = givenOutlineModel;`
`211`	`219`	`if (copyModel == null)`
`212`	`220`	`{`
`213`		`- copyModel = (GetComponent<Renderer>() ? gameObject : GetComponentInChildren<Renderer>().gameObject);`
	`221`	`+ Renderer copyModelRenderer = objectToAffect.GetComponentInChildren<Renderer>();`
	`222`	`+ copyModel = (copyModelRenderer != null ? copyModelRenderer.gameObject : null);`
`214`	`223`	`}`
`215`	`224`
`216`	`225`	`if (copyModel == null)`
`@@ -219,12 +228,12 @@ protected virtual GameObject CreateHighlightModel(GameObject givenOutlineModel,`
`219`	`228`	`return null;`
`220`	`229`	`}`
`221`	`230`
`222`		`- GameObject highlightModel = new GameObject(name + "_HighlightModel");`
	`231`	`+ GameObject highlightModel = new GameObject(objectToAffect.name + "_HighlightModel");`
`223`	`232`	`highlightModel.transform.SetParent(copyModel.transform.parent, false);`
`224`	`233`	`highlightModel.transform.localPosition = copyModel.transform.localPosition;`
`225`	`234`	`highlightModel.transform.localRotation = copyModel.transform.localRotation;`
`226`	`235`	`highlightModel.transform.localScale = copyModel.transform.localScale;`
`227`		`- highlightModel.transform.SetParent(transform);`
	`236`	`+ highlightModel.transform.SetParent(objectToAffect.transform);`
`228`	`237`
`229`	`238`	`Component[] copyModelComponents = copyModel.GetComponents<Component>();`
`230`	`239`	`for (int i = 0; i < copyModelComponents.Length; i++)`
Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ public virtual void PopulateHighlighters()`
`121`	`121`
`122`	`122`	`SDK_BaseController.ControllerHand currentHand = VRTK_DeviceFinder.GetControllerHand(actualController);`
`123`	`123`
`124`		`- objectHighlighter.Initialise(null, highlighterOptions);`
	`124`	`+ objectHighlighter.Initialise(null, null, highlighterOptions);`
`125`	`125`
`126`	`126`	`AddHighlighterToElement(GetElementTransform(VRTK_SDK_Bridge.GetControllerElementPath(SDK_BaseController.ControllerElements.ButtonOne, currentHand)), objectHighlighter, elementHighlighterOverrides.buttonOne);`
`127`	`127`	`AddHighlighterToElement(GetElementTransform(VRTK_SDK_Bridge.GetControllerElementPath(SDK_BaseController.ControllerElements.ButtonTwo, currentHand)), objectHighlighter, elementHighlighterOverrides.buttonTwo);`
`@@ -396,7 +396,7 @@ protected virtual void AddHighlighterToElement(Transform element, VRTK_BaseHighl`
`396`	`396`	`{`
`397`	`397`	`VRTK_BaseHighlighter highlighter = (overrideHighlighter != null ? overrideHighlighter : parentHighlighter);`
`398`	`398`	`VRTK_BaseHighlighter clonedHighlighter = (VRTK_BaseHighlighter)VRTK_SharedMethods.CloneComponent(highlighter, element.gameObject);`
`399`		`- clonedHighlighter.Initialise(null, highlighterOptions);`
	`399`	`+ clonedHighlighter.Initialise(null, null, highlighterOptions);`
`400`	`400`	`}`
`401`	`401`	`}`
`402`	`402`