{"type":"doc","content":[{"type":"paragraph","content":[{"text":"A built out unity project (that includes Igloo’s UnityToolkit will determine its behaviour from the IglooSettings.xml file (located in ./Data/streamingAssets by default).","type":"text"}]},{"type":"paragraph","content":[{"text":"Here is a description of the file contents:","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"System Settings","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph"},{"type":"codeBlock","content":[{"text":"","type":"text"}]},{"type":"paragraph","content":[{"text":"System settings are optional","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"vSync Mode: ","type":"text","marks":[{"type":"strong"}]},{"text":"takes an int value to set the application vertical sync setting ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://docs.unity3d.com/ScriptReference/QualitySettings-vSyncCount.html"}},{"text":" :","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"strong"}]},{"text":" - ignores your monitor refresh and outputs the frames as fast as possible.","type":"text"}]},{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"strong"}]},{"text":" - will output one frame update for every screen update.","type":"text"}]},{"type":"paragraph","content":[{"text":"2","type":"text","marks":[{"type":"strong"}]},{"text":" - will output one frame update every second screen update","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"targetFPS: ","type":"text","marks":[{"type":"strong"}]},{"text":"takes an int value to set the target framerate of the application","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Player Settings","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"}]},{"type":"paragraph"},{"type":"codeBlock","content":[{"text":" \n true\n false\n 0\n 0\n 0\n 0\n 10\n 5\n 10\n 0\n ","type":"text"}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name:","type":"text","marks":[{"type":"strong"}]},{"text":" string value to specify name of the player","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"usePlayer:","type":"text","marks":[{"type":"strong"}]},{"text":" takes an bool value to set player system enabled state","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"headTracking","type":"text","marks":[{"type":"strong"}]},{"text":": not yet implemented","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rotationInput: ","type":"text","marks":[{"type":"strong"}]},{"text":"takes an int value to set the player rotation input method:","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"strong"}]},{"text":" - Standard: player rotation is controlled using the default Unity input settings ","type":"text"}]},{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"strong"}]},{"text":" - Warper: player rotation is controlled via OSC network message from IglooWarper application - this is the default behaviour","type":"text"}]},{"type":"paragraph","content":[{"text":"2","type":"text","marks":[{"type":"strong"}]},{"text":" - GyroOSC: OSC Messages relayed from GyroOSC iPhone/Android application","type":"text"}]},{"type":"paragraph","content":[{"text":"3","type":"text","marks":[{"type":"strong"}]},{"text":" - VR Controller: OSC Messages relayed from Igloo OpenVR","type":"text"}]},{"type":"paragraph","content":[{"text":"4","type":"text","marks":[{"type":"strong"}]},{"text":" - Optitrack: Optitrack client sends messages to Unity via Optitrack Plugin","type":"text"}]},{"type":"paragraph","content":[{"text":"5","type":"text","marks":[{"type":"strong"}]},{"text":" - VRPN: OSC Messages received from the Unity VRPN Server","type":"text"}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"rotationMode : ","type":"text","marks":[{"type":"strong"}]},{"text":"takes an int value to set the rotation mode of the displays assigned to the player:","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"strong"}]},{"text":" - Igloo 360: display rotation is static and does not follow the player's rotation, optimal settings for a standard 360-degree Igloo structure","type":"text"}]},{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"strong"}]},{"text":" - Igloo Non-360: display follows the rotation of the player in the y-axis but is static in the x-axis. (Rotates left and right, instead of just moving the cursor)","type":"text"}]},{"type":"paragraph","content":[{"text":"2","type":"text","marks":[{"type":"strong"}]},{"text":" - Game: display follows the rotation of the player in both x and y-axis. (Rotates left and right, up and down, instead of just moving the cursor)","type":"text"}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"movementInput:","type":"text","marks":[{"type":"strong"}]},{"text":" takes an int value to set the player rotation input method:","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"strong"}]},{"text":" - Standard: player movement is controlled using the default Unity input settings","type":"text"}]},{"type":"paragraph","content":[{"text":"1 ","type":"text","marks":[{"type":"strong"}]},{"text":"- GyroOSC: player movement is controlled via OSC networks messaging from GyrOSC app ","type":"text"},{"type":"inlineCard","attrs":{"url":"http://www.bitshapesoftware.com/instruments/gyrosc/"}},{"text":" ","type":"text"}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"movementMode:","type":"text","marks":[{"type":"strong"}]},{"text":" takes an int value to set the player rotation input method:","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"0","type":"text","marks":[{"type":"strong"}]},{"text":" - standard: player movement is affected by gravity and the player will clip with walls","type":"text"}]},{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"strong"}]},{"text":"- noGrav: player movement unaffected by gravity. Will clip with walls","type":"text"}]},{"type":"paragraph","content":[{"text":"2 ","type":"text","marks":[{"type":"strong"}]},{"text":"- noClip: player movement unaffected by gravity, can move through walls at will","type":"text"}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"runSpeed: ","type":"text","marks":[{"type":"strong"}]},{"text":"takes a float value to set the player speed while running","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"walkSpeed: ","type":"text","marks":[{"type":"strong"}]},{"text":"takes a float value to set the player speed while walking","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"smoothTime: ","type":"text","marks":[{"type":"strong"}]},{"text":"takes a float value to set the rotation smoothing amount. 1 is much smoothing, 10 - is no smoothing","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"crosshairMode:","type":"text","marks":[{"type":"strong"}]},{"text":" takes an int value to set the player rotation input method:","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"0 - ","type":"text","marks":[{"type":"strong"}]},{"text":"show: crosshair visible","type":"text"}]},{"type":"paragraph","content":[{"text":"1 - ","type":"text","marks":[{"type":"strong"}]},{"text":"show on move: crosshair visible when player is moving","type":"text"}]},{"type":"paragraph","content":[{"text":"2 ","type":"text","marks":[{"type":"strong"}]},{"text":"- hide: crosshair not visible","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Network Settings","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph"},{"type":"codeBlock","content":[{"text":" \n 9007\n 9001\n 127.0.0.1\n ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"inPort: ","type":"text","marks":[{"type":"strong"}]},{"text":"takes an int value to set the input port for network messages","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"outPort: ","type":"text","marks":[{"type":"strong"}]},{"text":"takes an int value to set the output port for network messages ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"outIP: ","type":"text","marks":[{"type":"strong"}]},{"text":"takes a string value to set the output IP address for network messages","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Display Settings","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The Display Settings can be used to define any number of ","type":"text"},{"text":"Displays","type":"text","marks":[{"type":"strong"}]},{"text":" , which positioned and oriented to support any Igloo structure. The outputs of these displays can be shared separately via the ","type":"text"},{"text":"textureShareMode","type":"text","marks":[{"type":"strong"}]},{"text":" options, alternatively, they can be processed into a single output using either ","type":"text"},{"text":"useCubemapToEquirectangular","type":"text","marks":[{"type":"strong"}]},{"text":" or ","type":"text"},{"text":"useCompositeTexture","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph"},{"type":"codeBlock","content":[{"text":" \n 1\n true\n \n 360\n 70\n false\n false\n \n \n \n \n \n \n ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name: ","type":"text","marks":[{"type":"strong"}]},{"text":"sharing name if ","type":"text"},{"text":"textureShareMode","type":"text","marks":[{"type":"strong"}]},{"text":" is enabled","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"textureShareMode: ","type":"text","marks":[{"type":"strong"}]},{"text":"when either useCubemapToEquirectangular or useCompositeTexture are enabled, multiple Display textures are composited into a single texture, the method for sharing the resulting texture is specified using an int value:","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"0 ","type":"text","marks":[{"type":"strong"}]},{"text":"-","type":"text"},{"text":" ","type":"text","marks":[{"type":"strong"}]},{"text":"do not share","type":"text"}]},{"type":"paragraph","content":[{"text":"1","type":"text","marks":[{"type":"strong"}]},{"text":" - share texture via Spout","type":"text"}]},{"type":"paragraph","content":[{"text":"2","type":"text","marks":[{"type":"strong"}]},{"text":" - share texture via NDI","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"useCubemapToEquirectangular: ","type":"text","marks":[{"type":"strong"}]},{"text":"enables Cubemap to Equirectangular system, assumes ","type":"text"},{"text":"Displays ","type":"text","marks":[{"type":"strong"}]},{"text":"have been configured appropriately with Cubemap faces assigned. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"equirectangularTexureRes: ","type":"text","marks":[{"type":"strong"}]},{"text":"output resolution of Cubemap to Equirectangular conversion, supports any aspect ratio","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"horizontalFOV: ","type":"text","marks":[{"type":"strong"}]},{"text":"Range of angles covered by the render on the horizontal axis. Use 360° for a full render, 180° for a half","type":"text"},{"text":"-","type":"text","marks":[{"type":"strong"}]},{"text":"sphere, and so on.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"verticalFOV: ","type":"text","marks":[{"type":"strong"}]},{"text":"Range of angles covered by the render on the horizontal axis. Use 360° for a full render, 180° for a half-sphere, and so on.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"useCompositeTexture: ","type":"text","marks":[{"type":"strong"}]},{"text":"when enabled a single render texture will be created, it’s resolution will be the combined resolution of cameras defined in ","type":"text"},{"text":"Displays","type":"text","marks":[{"type":"strong"}]},{"text":". This texture will be assigned as the target texture for every camera with appropriate viewport settings. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Note ","type":"text","marks":[{"type":"strong"}]},{"text":"- the setting is ignored if ","type":"text"},{"text":"useCubemapToEquirectangular","type":"text","marks":[{"type":"strong"}]},{"text":" is enabled","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"useFramepackTopBottom3D: ","type":"text","marks":[{"type":"strong"}]},{"text":"when either useCubemapToEquirectangular or useCompositeTexture are enabled ","type":"text"},{"text":"and ","type":"text","marks":[{"type":"strong"}]},{"text":"the 3D is being used, the resulting textures for the left and right eyes can be combined into a single texture, left on top, right on the bottom. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"HeadSettings: ","type":"text","marks":[{"type":"strong"}]},{"text":"position and rotation of the Head game object, part of the Igloo Prefab, cameras are parented to this.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"DisplayItem","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph"},{"type":"codeBlock","content":[{"text":" \n true\n 90\n false\n true\n 0\n \n 0\n \n 0.01\n 1000\n false\n \n false\n \n \n \n ","type":"text"}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Name: ","type":"text","marks":[{"type":"strong"}]},{"text":"sharing name if textureShareMode is enabled","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"isRendering","type":"text","marks":[{"type":"strong"}]},{"text":": camera component enabled state","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fov: ","type":"text","marks":[{"type":"strong"}]},{"text":"camera vertical field of view","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"is3D: ","type":"text","marks":[{"type":"strong"}]},{"text":"if enabled a 3D camera pair is created for the Display","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"isRenderTextures: ","type":"text","marks":[{"type":"strong"}]},{"text":"camera is rendered to a target texture, must be enabled to use texture sharing","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cubemapFace: ","type":"text","marks":[{"type":"strong"}]},{"text":"should be set if using ","type":"text"},{"text":"useCubemapToEquirectangular","type":"text","marks":[{"type":"strong"}]},{"text":", specifies which face of the Cubemap the camera is. ","type":"text"},{"text":"0","type":"text","marks":[{"type":"strong"}]},{"text":" - left, ","type":"text"},{"text":"1 ","type":"text","marks":[{"type":"strong"}]},{"text":"- front, ","type":"text"},{"text":"2","type":"text","marks":[{"type":"strong"}]},{"text":" - right, ","type":"text"},{"text":"3","type":"text","marks":[{"type":"strong"}]},{"text":" - back, ","type":"text"},{"text":"4","type":"text","marks":[{"type":"strong"}]},{"text":" - down, ","type":"text"},{"text":"5","type":"text","marks":[{"type":"strong"}]},{"text":" - up","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"renderTextureSize: ","type":"text","marks":[{"type":"strong"}]},{"text":"resolution of the camera target texture. if using ","type":"text"},{"text":"useCubemapToEquirectangular ","type":"text","marks":[{"type":"strong"}]},{"text":"resolution x and y must be equal. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"textureShareMode: ","type":"text","marks":[{"type":"strong"}]},{"text":"when either useCubemapToEquirectangular or useCompositeTexture are enabled, multiple Display textures are composited into a single texture, the method for sharing the resulting texture is specified using an int value","type":"text"},{"text":":","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"0 ","type":"text","marks":[{"type":"strong"}]},{"text":"- do not share","type":"text"}]},{"type":"paragraph","content":[{"text":"1 ","type":"text","marks":[{"type":"strong"}]},{"text":"- share texture via Spout","type":"text"}]},{"type":"paragraph","content":[{"text":"2 ","type":"text","marks":[{"type":"strong"}]},{"text":"- share texture via NDI","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cameraRotation","type":"text","marks":[{"type":"strong"}]},{"text":": rotation of the camera","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"nearClipPlane","type":"text","marks":[{"type":"strong"}]},{"text":": camera near clipping plane distance","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"farClipPlane: ","type":"text","marks":[{"type":"strong"}]},{"text":"camera near clipping plane distance","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"isFisheye: ","type":"text","marks":[{"type":"strong"}]},{"text":"when enabled, a fisheye shader is applied to the camera. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Note - should be disabled when using ","type":"text"},{"text":"useCubemapToEquirectangular ","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"fisheyeStrength: ","type":"text","marks":[{"type":"strong"}]},{"text":"amount of fisheye distortion to apply to each axis","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"isOffAxis: ","type":"text","marks":[{"type":"strong"}]},{"text":"when enabled, a custom off-axis projection matrix can be used by configuring the following viewport settings. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Note - when offAxis is used the ","type":"text"},{"text":"cameraRotation","type":"text","marks":[{"type":"strong"}]},{"text":" setting is ignored as the custom viewport dictates what the camera will render. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"viewportRotation: ","type":"text","marks":[{"type":"strong"}]},{"text":"the rotation of the viewport relative to the Igloo game object","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"viewportSize: ","type":"text","marks":[{"type":"strong"}]},{"text":"the size of the viewport, units are in meters","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"viewportPosition: ","type":"text","marks":[{"type":"strong"}]},{"text":"the position of the viewport relative to the Igloo game object, units are in meters","type":"text"}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported