{"id":6348,"date":"2020-07-20T11:03:49","date_gmt":"2020-07-20T11:03:49","guid":{"rendered":"https:\/\/bssrdf.com\/?post_type=manual_documentation&#038;p=6348"},"modified":"2022-02-10T11:46:52","modified_gmt":"2022-02-10T10:46:52","slug":"keyshotxr-variables","status":"publish","type":"manual_documentation","link":"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/","title":{"rendered":"KeyShotXR Variables"},"content":{"rendered":"<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_83 ez-toc-wrap-right counter-hierarchy ez-toc-counter ez-toc-custom ez-toc-container-direction\">\n<p class=\"ez-toc-title\" style=\"cursor:inherit\">On this page<\/p>\n<label for=\"ez-toc-cssicon-toggle-item-6a325b78cdc65\" class=\"ez-toc-cssicon-toggle-label\"><span class=\"\"><span class=\"eztoc-hide\" style=\"display:none;\">Toggle<\/span><span class=\"ez-toc-icon-toggle-span\"><svg style=\"fill: #ffffff;color:#ffffff\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewBox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #ffffff;color:#ffffff\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewBox=\"0 0 24 24\" version=\"1.2\" baseProfile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/span><\/label><input type=\"checkbox\"  id=\"ez-toc-cssicon-toggle-item-6a325b78cdc65\" checked aria-label=\"Toggle\" \/><nav><ul class='ez-toc-list ez-toc-list-level-1 ' ><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Variable_Location\" >Variable Location<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Variables\" >Variables<\/a><ul class='ez-toc-list-level-3' ><li class='ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#General_Settings\" >General Settings<\/a><\/li><\/ul><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-4\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Frame_number\" >Frame number<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-5\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Start_Frame\" >Start Frame<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-6\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#ViewPort_Size\" >ViewPort Size<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-7\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Rotation_settings\" >Rotation settings<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-8\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Mouse_Sensitivity\" >Mouse Sensitivity<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-9\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Zoom_levels\" >Zoom levels<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-10\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Loading_icon\" >Loading icon<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-11\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Screen_size\" >Screen size<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-12\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Move_Direction\" >Move Direction<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-13\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#Deprecated_variables\" >Deprecated variables<\/a><\/li><\/ul><\/nav><\/div>\n\n<p>Below is a list of KeyShotXR&nbsp;variables. these variables are set in the&nbsp;<em>.html<\/em>&nbsp;file created by KeyShot when the KeyShotXR&nbsp;is rendered. These variables can be edited after the KeyShotXR&nbsp;is created if minor edits are needed, rather than recreating the KeyShotXR&nbsp;over again. The&nbsp;<em>.html<\/em>&nbsp;file can be edited using a standard text editor.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-VariableLocation\"><span class=\"ez-toc-section\" id=\"Variable_Location\"><\/span>Variable Location<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<p>All KeyShot variables are located in the KeyShotXR&nbsp;<em>.html<\/em>&nbsp;file&nbsp;<em><code>&lt;head&gt;<\/code><\/em>&nbsp;section, within a&nbsp;<em><code>&lt;script&gt;<\/code><\/em>&nbsp;tag, and are called by the&nbsp;<em>initKeyShotXR()<\/em>&nbsp;function.<\/p>\n\n\n\n<p><strong>Variable location<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">&lt;head&gt;\n  &lt;script type=\"text\/javascript\"&gt;\n    var keyshotXR;\n \n    function initKeyShotXR() {\n      var nameOfDiv = \"KeyShotXR\";\n      \/\/ Other variables follow here..\n \n      keyshotXR = new keyshotXR(nameOfDiv, \/* The other variables ... *\/);\n    }\n \n    window.onload = initKeyShotXR;\n  &lt;\/script&gt;\n&lt;\/head&gt;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-nameOfDiv\">nameOfDiv<\/h6>\n\n\n\n<p>The div id of the KeyShotXR. This is where the KeyShotXR content is located.<\/p>\n\n\n\n<p><strong>Position in html<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">&lt;body oncontextmenu=\"return false;\"&gt;\n  &lt;div id=\"KeyShotXR\"&gt;&lt;\/div&gt;\n&lt;\/body&gt;<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Variables\"><span class=\"ez-toc-section\" id=\"Variables\"><\/span>Variables<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"KeyShotXRVariables-GeneralSettings\"><span class=\"ez-toc-section\" id=\"General_Settings\"><\/span>General Settings<span class=\"ez-toc-section-end\"><\/span><\/h3>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-FolderName-folderName\">Folder Name &#8211;&nbsp;<em>folderName<\/em><\/h6>\n\n\n\n<p>The name of the folder that contains all the files for the KeyShotXR. This is set under&nbsp;<em>Render,<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab,&nbsp;<em>Name<\/em>&nbsp;entry.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var folderName = \"material_ball_XR.10\";<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Downloadonlyonclick-downloadOnInteraction\"><strong>Download only on click &#8211;&nbsp;<\/strong><em>downloadOnInteraction<\/em><\/h6>\n\n\n\n<p>This variable allows a KeyShotXR&nbsp;only to be loaded after it has been clicked.&nbsp;This option is set in the KeyShotXR&nbsp;settings, under&nbsp;<em>Render<\/em> &gt;&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>Advanced.<\/em><\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var downloadOnInteraction = false;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Imagetype-imageExtension\">Image type &#8211;&nbsp;<em>imageExtension<\/em><\/h6>\n\n\n\n<p>This variable is the image extension for the frames generated for the KeyShotXR. Only one extension type may be used.&nbsp;This is set in the KeyShotXR&nbsp;settings, under&nbsp;<em>Render,<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>KeyShotXR Control &gt; Format.<\/em><\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var imageExtension = \"jpg\";<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Backgroundcolor-backgroundColor\">Background color &#8211;&nbsp;<em>backgroundColor<\/em><\/h6>\n\n\n\n<p>The background color of the .html page in hexidecimal notation. This will be the color behind\/surrounding the KeyShotXR. The default is white (#FFFFFF). This option can only be set from in the&nbsp;<em>.html<\/em>&nbsp;file.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var backgroundColor = \"#FFFFFF\";<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Framenumber\"><span class=\"ez-toc-section\" id=\"Frame_number\"><\/span>Frame number<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Horizontal-uCount\">Horizontal &#8211;&nbsp;<em>uCount<\/em><\/h6>\n\n\n\n<p>This is the number of horizontal frames in the KeyShotXR.&nbsp;This is set under&nbsp;<em>Render,<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>KeyShotXR Control &gt; Smoothness Control<\/em>.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var uCount = 18;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Vertical-vCount\">Vertical &#8211;&nbsp;<em>vCount<\/em><\/h6>\n\n\n\n<p>This is the number of vertical frames in the KeyShotXR.&nbsp;This is set under&nbsp;<em>Render,<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>KeyShotXR Control &gt; Smoothness Control<\/em>.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var vCount = 18;<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-StartFrame\"><span class=\"ez-toc-section\" id=\"Start_Frame\"><\/span>Start Frame<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Horizontal-uStartIndex\">Horizontal &#8211;&nbsp;<em>uStartIndex<\/em><\/h6>\n\n\n\n<p>This controls the horizontal start frame for the KeyShotXR. This is set by viewing angle in the KeyShotXR settings, under&nbsp;<em>Render,<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>KeyShotXR Control &gt; Angle Control<\/em>.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var uStartIndex = 1;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Vertical-vStartIndex\">Vertical &#8211;&nbsp;<em>vStartIndex<\/em><\/h6>\n\n\n\n<p>This controls the vertical start frame for the KeyShotXR. This is set by viewing angle in the KeyShotXR settings, under&nbsp;<em>Render,<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>KeyShotXR Control &gt; Angle Control<\/em>.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var vStartIndex = 0;<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-ViewPortSize\"><span class=\"ez-toc-section\" id=\"ViewPort_Size\"><\/span>ViewPort Size<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Width-viewPortWidth\">Width &#8211;&nbsp;<em>viewPortWidth<\/em><\/h6>\n\n\n\n<p>The width of the KeyShotXR in pixels.&nbsp;This is set under&nbsp;<em>Render<\/em> &gt;&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab,&nbsp;<em>Viewing Resolution<\/em> &gt; first text field entry.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var viewPortWidth = 640;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Height-viewPortHeight\">Height &#8211;&nbsp;<em>viewPortHeight<\/em><\/h6>\n\n\n\n<p>The height of the KeyShotXR in pixels.&nbsp;This is set under&nbsp;<em>Render<\/em> &gt; &nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab,&nbsp;<em>Viewing Resolution<\/em> &gt;&nbsp;second text field entry.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var viewPortHeight = 640;<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Rotationsettings\"><span class=\"ez-toc-section\" id=\"Rotation_settings\"><\/span>Rotation settings<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Continuoushorizontalrotation-uWrap\">Continuous horizontal rotation &#8211;&nbsp;<em>uWrap<\/em><\/h6>\n\n\n\n<p>This allows the KeyShotXR to continue rotation after last frame in the horizontal direction when set to&nbsp;<em>true<\/em>.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var uWrap = true;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Continuousverticalrotation-vWrap\">Continuous vertical rotation &#8211;&nbsp;<em>vWrap<\/em><\/h6>\n\n\n\n<p>This allows the KeyShotXR to continue rotation after last frame in the vertical direction when set to&nbsp;<em>true<\/em>.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var vWrap = true;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Rotationdamping-rotationDamping\">Rotation damping &#8211;&nbsp;<em>rotationDamping<\/em><\/h6>\n\n\n\n<p>This controls the speed at which the rotation slows down when a KeyShotXR&nbsp;is rotated. Increasing this value will increase the duration of rotation before coming to a stop.&nbsp;This is set in the KeyShotXR&nbsp;settings, under&nbsp;<em>Render &gt;<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>Advanced.<\/em><\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var rotationDamping = 0.96;<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-MouseSensitivity\"><span class=\"ez-toc-section\" id=\"Mouse_Sensitivity\"><\/span>Mouse Sensitivity<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Horizontal-uMouseSensitivity\">Horizontal &#8211;&nbsp;<em>uMouseSensitivity<\/em><\/h6>\n\n\n\n<p>This controls the horizontal mouse\/touch sensitivity for the KeyShotXR. Changing the value to\/from a negative value will change the direction of the KeyShotXR rotation. This is set under&nbsp;<em>Render &gt;<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>Advanced<\/em>.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var uMouseSensitivity = -0.0055;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Vertical-vMouseSensitivity\">Vertical &#8211;&nbsp;<em>vMouseSensitivity<\/em><\/h6>\n\n\n\n<p>This controls the vertical mouse\/touch sensitivity for the KeyShotXR. Changing the value to\/from a negative value will change the direction of the KeyShotXR rotation. This is set under&nbsp;<em>Render<\/em> &gt;&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>Advanced<\/em>.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var vMouseSensitivity = 1;<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Zoomlevels\"><span class=\"ez-toc-section\" id=\"Zoom_levels\"><\/span>Zoom levels<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Minimum-minZoom\">Minimum &#8211;&nbsp;<em>minZoom<\/em><\/h6>\n\n\n\n<p>This controls the minimum zoom level for the KeyShotXR. Setting to a negative value will allow Zoom out capability. Increasing the value above 1 will change the zoom level of the KeyShotXR&nbsp;when loaded. This is set in the KeyShotXR&nbsp;settings, under&nbsp;<em>Render<\/em> &gt;&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>Advanced&nbsp;<\/em>by checking the&nbsp;<em>Zoom-In<\/em>&nbsp;checkbox.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var minZoom = 1;<\/code><\/pre>\n\n\n\n<div class=\"wp-block-genesis-blocks-gb-columns gb-layout-columns-1 one-column\"><div class=\"gb-layout-column-wrap gb-block-layout-column-gap-2 gb-is-responsive-column\">\n<div class=\"wp-block-genesis-blocks-gb-column warning-box gb-block-layout-column\"><div class=\"gb-block-layout-column-inner\">\n<h6 class=\"wp-block-heading\" id=\"note\">Note<\/h6>\n\n\n\n<p>KeyShot automatically calculates the resolution when rendering the KeyShotXR&nbsp;based on this setting&nbsp;when &#8216;Preserve image quality&#8217; option is enabled. If changed afterward, grainy images may be experienced.<\/p>\n<\/div><\/div>\n<\/div><\/div>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Maximum-maxZoom\">Maximum &#8211;&nbsp;<em>maxZoom<\/em><\/h6>\n\n\n\n<p>This controls the maximum zoom level for the KeyShotXR. Increasing this number, increases the amount a KeyShotXR can be zoomed in. This is set in the KeyShotXR settings, under&nbsp;<em>Render &gt;<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>Advanced&nbsp;<\/em>by checking the&nbsp;<em>Zoom-In<\/em>&nbsp;checkbox.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var maxZoom = 1;<\/code><\/pre>\n\n\n\n<div class=\"wp-block-genesis-blocks-gb-columns gb-layout-columns-1 one-column\"><div class=\"gb-layout-column-wrap gb-block-layout-column-gap-2 gb-is-responsive-column\">\n<div class=\"wp-block-genesis-blocks-gb-column warning-box gb-block-layout-column\"><div class=\"gb-block-layout-column-inner\">\n<h6 class=\"wp-block-heading\" id=\"note\">Note<\/h6>\n\n\n\n<p>KeyShot automatically calculates the resolution when rendering the KeyShotXR based on this setting when &#8216;Preserve image quailty&#8217; option is enabled. If changed afterward, grainy images may be experienced.<\/p>\n<\/div><\/div>\n<\/div><\/div>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Loadingicon\"><span class=\"ez-toc-section\" id=\"Loading_icon\"><\/span>Loading icon<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Showloadingicon-showLoading\">Show loading icon &#8211;&nbsp;<em>showLoading<\/em><\/h6>\n\n\n\n<p>If this variable is set to&nbsp;<em>true<\/em>, the loading icon will be shown. If set to&nbsp;<em>false<\/em>, it will not be shown.&nbsp;This option is set in the KeyShotXR&nbsp;settings, under&nbsp;<em>Render,<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>Advanced<\/em>&nbsp; by selecting the&nbsp;<em>Show Loading Screen<\/em>&nbsp;option.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var showLoading = true;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Setloadingicon-loadingIcon\">Set loading icon &#8211;&nbsp;<em>loadingIcon<\/em><\/h6>\n\n\n\n<p>This allows a different loading icon to be used. The variable is the filename of the icon located in the the KeyShotXR&nbsp;<em>files<\/em>&nbsp;folder.&nbsp;This option is set in the KeyShotXR&nbsp;settings, under&nbsp;<em>Render<\/em> &gt;&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>Advanced,<\/em>&nbsp;by selecting the&nbsp;<em>Default loading icon.<\/em><\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var loadingIcon = \"ks_logo.png\";<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Screensize\"><span class=\"ez-toc-section\" id=\"Screen_size\"><\/span>Screen size<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Automaticresizing(responsivesize)-downScaleToBrowser\">Automatic resizing (responsive size) &#8211;&nbsp;<em>downScaleToBrowser<\/em><\/h6>\n\n\n\n<p>This variable controls the automatic resizing of a KeyShotXR&nbsp;when a browser is resized; it allows a KeyShotXR&nbsp;to be responsive. This is set to true by default and can only be changed in the&nbsp;<em>.html<\/em>&nbsp;file.&nbsp;<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var downScaleToBrowser = true;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Allowfullscreen-allowFullscreen\">Allow full screen &#8211;&nbsp;<em>allowFullscreen<\/em><\/h6>\n\n\n\n<p>This variable allows a KeyShotXR to be viewed fullscreen when it is double-clicked in desktop browsers.&nbsp;This option is set in the KeyShotXR settings, under&nbsp;<em>Render,<\/em>&nbsp;<em>Output<\/em>&nbsp;options in the&nbsp;<em>KeyShotXR<\/em>&nbsp;tab, under&nbsp;<em>Advanced,<\/em>&nbsp;by selecting&nbsp;<em>Allow Fullscreen Mode by Double-Click.<\/em><\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var allowFullscreen = true;<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-MoveDirection\"><span class=\"ez-toc-section\" id=\"Move_Direction\"><\/span>Move Direction<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Reversehorizontaldirection-uReverse\">Reverse horizontal direction &#8211;&nbsp;<em>uReverse<\/em><\/h6>\n\n\n\n<p>This variable will reverse the horizontal direction of rotation when set to&nbsp;<em>true<\/em>.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var uReverse = false;<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Reverseverticaldirection-vReverse\">Reverse vertical direction &#8211;&nbsp;<em>vReverse<\/em><\/h6>\n\n\n\n<p>This variable will reverse the vertical direction of rotation when set to&nbsp;<em>true<\/em>.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var vReverse = false;<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"KeyShotXRVariables-Deprecatedvariables\"><span class=\"ez-toc-section\" id=\"Deprecated_variables\"><\/span>Deprecated variables<span class=\"ez-toc-section-end\"><\/span><\/h2>\n\n\n\n<h6 class=\"wp-block-heading\" id=\"KeyShotXRVariables-addDownScaleGUIButton\"><em>addDownScaleGUIButton<\/em><\/h6>\n\n\n\n<p>With KeyShot 6 this option has been deprecated. The option is still available for legacy KeyShotXRs&nbsp;that require this from in the&nbsp;<em>.html<\/em>&nbsp;file.<\/p>\n\n\n\n<p><strong>Usage Example:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code class=\"\">var addDownScaleGUIButton = false;<\/code><\/pre>\n","protected":false},"author":29916,"featured_media":0,"parent":6312,"menu_order":3,"template":"","manualdocumentationcategory":[13],"manual_doc_tag":[],"class_list":["post-6348","manual_documentation","type-manual_documentation","status-publish","hentry","manualdocumentationcategory-keyshot"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.6 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>KeyShotXR Variables - KeyShot 10 Manual<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"KeyShotXR Variables - KeyShot 10 Manual\" \/>\n<meta property=\"og:description\" content=\"Below is a list of KeyShotXR&nbsp;variables. these variables are set in the&nbsp;.html&nbsp;file created by KeyShot when the KeyShotXR&nbsp;is rendered. These variables can be edited after the KeyShotXR&nbsp;is created if minor edits are needed, rather than recreating the KeyShotXR&nbsp;over again. The&nbsp;.html&nbsp;file can be edited using a standard text editor. Variable Location All KeyShot variables are located [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/\" \/>\n<meta property=\"og:site_name\" content=\"KeyShot 10 Manual\" \/>\n<meta property=\"article:modified_time\" content=\"2022-02-10T10:46:52+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"6 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/manual\\\/keyshotweb\\\/keyshotxr\\\/keyshotxr-variables\\\/\",\"url\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/manual\\\/keyshotweb\\\/keyshotxr\\\/keyshotxr-variables\\\/\",\"name\":\"KeyShotXR Variables - KeyShot 10 Manual\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/#website\"},\"datePublished\":\"2020-07-20T11:03:49+00:00\",\"dateModified\":\"2022-02-10T10:46:52+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/manual\\\/keyshotweb\\\/keyshotxr\\\/keyshotxr-variables\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/manual\\\/keyshotweb\\\/keyshotxr\\\/keyshotxr-variables\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/manual\\\/keyshotweb\\\/keyshotxr\\\/keyshotxr-variables\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"KeyShotWeb\",\"item\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/manual\\\/keyshotweb\\\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"KeyShotXR\",\"item\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/manual\\\/keyshotweb\\\/keyshotxr\\\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"KeyShotXR Variables\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/#website\",\"url\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/\",\"name\":\"KeyShot 10 Manual\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/manual.keyshot.com\\\/keyshot10\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"KeyShotXR Variables - KeyShot 10 Manual","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/","og_locale":"en_US","og_type":"article","og_title":"KeyShotXR Variables - KeyShot 10 Manual","og_description":"Below is a list of KeyShotXR&nbsp;variables. these variables are set in the&nbsp;.html&nbsp;file created by KeyShot when the KeyShotXR&nbsp;is rendered. These variables can be edited after the KeyShotXR&nbsp;is created if minor edits are needed, rather than recreating the KeyShotXR&nbsp;over again. The&nbsp;.html&nbsp;file can be edited using a standard text editor. Variable Location All KeyShot variables are located [&hellip;]","og_url":"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/","og_site_name":"KeyShot 10 Manual","article_modified_time":"2022-02-10T10:46:52+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"6 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/","url":"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/","name":"KeyShotXR Variables - KeyShot 10 Manual","isPartOf":{"@id":"https:\/\/manual.keyshot.com\/keyshot10\/#website"},"datePublished":"2020-07-20T11:03:49+00:00","dateModified":"2022-02-10T10:46:52+00:00","breadcrumb":{"@id":"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/keyshotxr-variables\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/manual.keyshot.com\/keyshot10\/"},{"@type":"ListItem","position":2,"name":"KeyShotWeb","item":"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/"},{"@type":"ListItem","position":3,"name":"KeyShotXR","item":"https:\/\/manual.keyshot.com\/keyshot10\/manual\/keyshotweb\/keyshotxr\/"},{"@type":"ListItem","position":4,"name":"KeyShotXR Variables"}]},{"@type":"WebSite","@id":"https:\/\/manual.keyshot.com\/keyshot10\/#website","url":"https:\/\/manual.keyshot.com\/keyshot10\/","name":"KeyShot 10 Manual","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/manual.keyshot.com\/keyshot10\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/manual.keyshot.com\/keyshot10\/wp-json\/wp\/v2\/manual_documentation\/6348","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/manual.keyshot.com\/keyshot10\/wp-json\/wp\/v2\/manual_documentation"}],"about":[{"href":"https:\/\/manual.keyshot.com\/keyshot10\/wp-json\/wp\/v2\/types\/manual_documentation"}],"author":[{"embeddable":true,"href":"https:\/\/manual.keyshot.com\/keyshot10\/wp-json\/wp\/v2\/users\/29916"}],"version-history":[{"count":0,"href":"https:\/\/manual.keyshot.com\/keyshot10\/wp-json\/wp\/v2\/manual_documentation\/6348\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/manual.keyshot.com\/keyshot10\/wp-json\/wp\/v2\/manual_documentation\/6312"}],"wp:attachment":[{"href":"https:\/\/manual.keyshot.com\/keyshot10\/wp-json\/wp\/v2\/media?parent=6348"}],"wp:term":[{"taxonomy":"manualdocumentationcategory","embeddable":true,"href":"https:\/\/manual.keyshot.com\/keyshot10\/wp-json\/wp\/v2\/manualdocumentationcategory?post=6348"},{"taxonomy":"manual_doc_tag","embeddable":true,"href":"https:\/\/manual.keyshot.com\/keyshot10\/wp-json\/wp\/v2\/manual_doc_tag?post=6348"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}