{"__v":0,"_id":"58b15d385dae732f00adeca8","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-02-25T10:32:24.449Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"> extends [VRTK_MaterialColorSwapHighlighter](doc:vrtk_materialcolorswaphighlighter)\n\n## Overview\n\nThis highlighter swaps the texture colour for the given highlight colour using MaterialPropertyBlocks.\nThe effect of this highlighter is the same as of the VRTK_MaterialColorSwapHighlighter.cs but this highlighter can additionally handle objects which make use material instances.\n\nDue to the way the object material is interacted with, changing the material colour will break Draw Call Batching in Unity whilst the object is highlighted.\n\nThe Draw Call Batching will resume on the original material when the item is no longer 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     * `<'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.\n  * Returns\n   * _none_\n\nThe Initialise method sets up the highlighter for use.\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 returns the object back to it's original colour.","excerpt":"","slug":"vrtk_materialpropertyblockcolorswaphighlighter","type":"basic","title":"VRTK_MaterialPropertyBlockColorSwapHighlighter"}

VRTK_MaterialPropertyBlockColorSwapHighlighter


> extends [VRTK_MaterialColorSwapHighlighter](doc:vrtk_materialcolorswaphighlighter) ## Overview This highlighter swaps the texture colour for the given highlight colour using MaterialPropertyBlocks. The effect of this highlighter is the same as of the VRTK_MaterialColorSwapHighlighter.cs but this highlighter can additionally handle objects which make use material instances. Due to the way the object material is interacted with, changing the material colour will break Draw Call Batching in Unity whilst the object is highlighted. The Draw Call Batching will resume on the original material when the item is no longer 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 * `<'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 * _none_ The Initialise method sets up the highlighter for use. ### 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 returns the object back to it's original colour.