{"__v":0,"_id":"58b158271756cf370022f90e","category":{"project":"571fa55ca0acd42000af9545","version":"58796781cd4a9c37007c96ef","_id":"58b157ca1756cf370022f90d","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-02-25T10:09:14.086Z","from_sync":false,"order":3,"slug":"pointer-renderers","title":"Pointer Renderers"},"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:10:47.790Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"> extends [VRTK_BasePointerRenderer](doc:vrtk_basepointerrenderer)\n\n## Overview\n\nThe Straight Pointer Renderer emits a coloured beam from the end of the object it is attached to and simulates a laser beam.\n\nIt can be useful for pointing to objects within a scene and it can also determine the object it is pointing at and the distance the object is from the controller the beam is being emitted from.\n\n## Inspector Parameters\n\n * **Maximum Length:** The maximum length the pointer tracer can reach.\n * **Scale Factor:** The scale factor to scale the pointer tracer object by.\n * **Cursor Scale Multiplier:** The scale multiplier to scale the pointer cursor object by in relation to the `Scale Factor`.\n * **Cursor Match Target Rotation:** The cursor will be rotated to match the angle of the target surface if this is true, if it is false then the pointer cursor will always be horizontal.\n * **Cursor Distance Rescale:** Rescale the cursor proportionally to the distance from the tracer origin.\n * **Custom Tracer:** A custom game object to use as the appearance for the pointer tracer. If this is empty then a Box primitive will be created and used.\n * **Custom Cursor:** A custom game object to use as the appearance for the pointer cursor. If this is empty then a Sphere primitive will be created and used.\n\n## Class Methods\n\n### UpdateRenderer/0\n\n  > `public override void UpdateRenderer()`\n\n  * Parameters\n   * _none_\n  * Returns\n   * _none_\n\nThe UpdateRenderer method is used to run an Update routine on the pointer.\n\n## Example\n\n`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`","excerpt":"","slug":"vrtk_straightpointerrenderer","type":"basic","title":"VRTK_StraightPointerRenderer"}

VRTK_StraightPointerRenderer


> extends [VRTK_BasePointerRenderer](doc:vrtk_basepointerrenderer) ## Overview The Straight Pointer Renderer emits a coloured beam from the end of the object it is attached to and simulates a laser beam. It can be useful for pointing to objects within a scene and it can also determine the object it is pointing at and the distance the object is from the controller the beam is being emitted from. ## Inspector Parameters * **Maximum Length:** The maximum length the pointer tracer can reach. * **Scale Factor:** The scale factor to scale the pointer tracer object by. * **Cursor Scale Multiplier:** The scale multiplier to scale the pointer cursor object by in relation to the `Scale Factor`. * **Cursor Match Target Rotation:** The cursor will be rotated to match the angle of the target surface if this is true, if it is false then the pointer cursor will always be horizontal. * **Cursor Distance Rescale:** Rescale the cursor proportionally to the distance from the tracer origin. * **Custom Tracer:** A custom game object to use as the appearance for the pointer tracer. If this is empty then a Box primitive will be created and used. * **Custom Cursor:** A custom game object to use as the appearance for the pointer cursor. If this is empty then a Sphere primitive will be created and used. ## Class Methods ### UpdateRenderer/0 > `public override void UpdateRenderer()` * Parameters * _none_ * Returns * _none_ The UpdateRenderer method is used to run an Update routine on the pointer. ## 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`