{"__v":0,"_id":"58796782cd4a9c37007c9736","category":{"version":"58796781cd4a9c37007c96ef","project":"571fa55ca0acd42000af9545","_id":"58796781cd4a9c37007c96f5","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-01-01T16:48:47.829Z","from_sync":false,"order":7,"slug":"highlighters","title":"Highlighters"},"parentDoc":null,"project":"571fa55ca0acd42000af9545","user":"571fa519db52d01700f5cf3d","version":{"__v":4,"_id":"58796781cd4a9c37007c96ef","project":"571fa55ca0acd42000af9545","createdAt":"2017-01-13T23:49:21.393Z","releaseDate":"2017-01-13T23:49:21.393Z","categories":["58796781cd4a9c37007c96f0","58796781cd4a9c37007c96f1","58796781cd4a9c37007c96f2","58796781cd4a9c37007c96f3","58796781cd4a9c37007c96f4","58796781cd4a9c37007c96f5","58796781cd4a9c37007c96f6","58796781cd4a9c37007c96f7","58796781cd4a9c37007c96f8","58796781cd4a9c37007c96f9","58796781cd4a9c37007c96fa","58796781cd4a9c37007c96fb","58796781cd4a9c37007c96fc","58796781cd4a9c37007c96fd","58796781cd4a9c37007c96fe","58796781cd4a9c37007c96ff","58796781cd4a9c37007c9700","58b157ca1756cf370022f90d","58b1596f5dae732f00adeca2","58b1605a5dae732f00adecb1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Mukota","version_clean":"3.1.0","version":"3.1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-01T16:49:47.363Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"> extends [VRTK_BaseHighlighter](doc:vrtk_basehighlighter)\n\n## Overview\n\nThe Outline Object Copy Highlighter works by making a copy of a mesh and adding an outline shader to it and toggling the appearance of the highlighted object.\n\n## Inspector Parameters\n\n * **Thickness:** The thickness of the outline effect\n * **Custom Outline Models:** The GameObjects to use as the model to outline. If one isn't provided then the first GameObject with a valid Renderer in the current GameObject hierarchy will be used.\n * **Custom Outline Model Paths:** A path to a GameObject to find at runtime, if the GameObject doesn't exist at edit time.\n * **Enable Submesh Highlight:** If the mesh has multiple sub-meshes to highlight then this should be checked, otherwise only the first mesh will be highlighted.\n\n## Class Methods\n\n### Initialise/2\n\n  > `public override void Initialise(Color? color = null, Dictionary<string, object> options = null)`\n\n  * Parameters\n   * `Color? color` - Not used.\n   * `Dictionary<string, object> 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.\n  * Returns\n   * _none_\n\nThe Initialise method sets up the highlighter for use.\n\n### ResetHighlighter/0\n\n  > `public override void ResetHighlighter()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * _none_\n\nThe ResetHighlighter method creates the additional model to use as the outline highlighted object.\n\n### Highlight/2\n\n  > `public override void Highlight(Color? color, float duration = 0f)`\n\n  * Parameters\n   * `Color? color` - The colour to outline with.\n   * `float duration` - Not used.\n  * Returns\n   * _none_\n\nThe Highlight method initiates the outline object to be enabled and display the outline colour.\n\n### Unhighlight/2\n\n  > `public override void Unhighlight(Color? color = null, float duration = 0f)`\n\n  * Parameters\n   * `Color? color` - Not used.\n   * `float duration` - Not used.\n  * Returns\n   * _none_\n\nThe Unhighlight method hides the outline object and removes the outline colour.\n\n## Example\n\n`VRTK/Examples/005_Controller_BasicObjectGrabbing` demonstrates the outline highlighting on the green sphere when the controller touches it.\n\n`VRTK/Examples/035_Controller_OpacityAndHighlighting` demonstrates the outline highlighting if the left controller collides with the green box.","excerpt":"","slug":"vrtk_outlineobjectcopyhighlighter","type":"basic","title":"VRTK_OutlineObjectCopyHighlighter"}

VRTK_OutlineObjectCopyHighlighter


> extends [VRTK_BaseHighlighter](doc:vrtk_basehighlighter) ## Overview The Outline Object Copy Highlighter works by making a copy of a mesh and adding an outline shader to it and toggling the appearance of the highlighted object. ## Inspector Parameters * **Thickness:** The thickness of the outline effect * **Custom Outline Models:** The GameObjects to use as the model to outline. If one isn't provided then the first GameObject with a valid Renderer in the current GameObject hierarchy will be used. * **Custom Outline Model Paths:** A path to a GameObject to find at runtime, if the GameObject doesn't exist at edit time. * **Enable Submesh Highlight:** If the mesh has multiple sub-meshes to highlight then this should be checked, otherwise only the first mesh will be highlighted. ## Class Methods ### Initialise/2 > `public override void Initialise(Color? color = null, Dictionary<string, object> options = null)` * Parameters * `Color? color` - Not used. * `Dictionary<string, object> 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. * Returns * _none_ The Initialise method sets up the highlighter for use. ### ResetHighlighter/0 > `public override void ResetHighlighter()` * Parameters * _none_ * Returns * _none_ The ResetHighlighter method creates the additional model to use as the outline highlighted object. ### Highlight/2 > `public override void Highlight(Color? color, float duration = 0f)` * Parameters * `Color? color` - The colour to outline with. * `float duration` - Not used. * Returns * _none_ The Highlight method initiates the outline object to be enabled and display the outline colour. ### Unhighlight/2 > `public override void Unhighlight(Color? color = null, float duration = 0f)` * Parameters * `Color? color` - Not used. * `float duration` - Not used. * Returns * _none_ The Unhighlight method hides the outline object and removes the outline colour. ## Example `VRTK/Examples/005_Controller_BasicObjectGrabbing` demonstrates the outline highlighting on the green sphere when the controller touches it. `VRTK/Examples/035_Controller_OpacityAndHighlighting` demonstrates the outline highlighting if the left controller collides with the green box.