Components Documentation

How to use this document

The best way to use this document is like a reference guide, searching by component or setting that you wish to learn more about.
To learn the basics of how to use the template check the Getting Started Page which will provide a good foundation of the main two components.

We will continue to highlight Important terms and concepts with links if you would like to find out more information about them.

Igloo 360 Camera Rig Prefabs

Cylinder, Cube, and Cylinder 6 Camera Rigs

These camera systems are very closely related. Having all the same components with the varibles of those components seperating them.

It creates:

• n Cameras (n2 for 3D)
• Rotated at n/360 degrees from eachother.
• Emitting n seperate streams of content. One per camera.

It contains the following components:

Igloo Camera 3D

This is the main camera creation C# script we have developed. In inherits IglooCamera.cs, which contains the basic definitons but only generates a 2D camera system.

Igloo Settings

• Number of Cameras:
  Type: Integer | Default Setting: (4,5,6)
  The amount of cameras that will be created by this camera system (doubles this amount for 3D)
  
  
• Camera Name:
  Type: String | Default Setting: UnityCam
  Prefix of the NDI/Spout stream when it is created.
  
  
• Render Width:
  Type: Integer | Default Setting: 8000
  The width in pixels of the stream output. 8000 is standard for Igloos.
• Player:
  Type: Game Object | Default Setting: null
  - Depricated - Will be removed in a future release
  
  
• Third Person Camera:
  Type: Game Object | Default Setting: null
  - Depricated - Will be removed in a future release
  
• Camera Prefab:
  Type: Game Object | Default Setting: null
  This allows you to define a camera that contains extra components or variables that you would like to use for all Igloo Cameras that are created by this script.
  This is very useful for camera based effects, as most are only applied to the main camera and not globally to all cameras in the scene.
  
  
• Use Camera Prefab:
  Type: Boolean | Default Setting: false
  Should the camera prefab defined in Camera Prefab be used as the base for creating the camera system.

Camera Settings

• Clear Flags:
  Type: Enumeration | Default Setting: Skybox
  This enum specifies what clear flags the cameras will have when they are created. This is not used if you have useCameraPrefab set to true.
  
  1. Skybox
  2. Color
  3. Solid Color
  4. Depth
  5. Nothing
     
• Clipping Planes:
  Type: Vector2 | Default Setting: x=0.1 y=100
  The minimum and maximum clipping range of the created cameras. The camera will not render outside of these distance values.
  
  
• Igloo Field of View:
  Type: Enumeration | Default Setting: Standard
  This enum specifies the FOV of the entire camera system
  
  1. STANDARD:
     FOV is defined by the amount of cameras, using a 8:1 aspect ratio for 99% of igloo installations, this is correct.
  2. WIDE:
     Sets the FOV and output to reflect a verticle pixel output of 1200. Used when you're using projectors with a 1920x1200 resolution
  3. SUPERWIDE:
     - Depricated - Will be replaced in a future release.
  4. UHD:
     Sets the FOV and output to reflect a verticle pixel output of 2000. Used when you're using projectors with a 3840x2160 resolution
• Igloo Stream Sender:
  Type: Enumeration | Default Setting: Standard
  This enum specifies how the cameras will emit their texture stream:
  
  1. Spout:
     A Local machine only based texture streaming service.
     Use this if you are running your application on the same computer as the Igloo software, which for most projects is applicable.
  2. NDI:
     A Local area network based texture streaming service. Use this if your project meets or exceeds the following conditions:
     • It's extremely detailed, in excess of 5 million polygons in the scene.
     • You're using a VR Headset device as the main source of input and control.
     • You want a high framerate output, and therefore as much of the graphics card as possible (First person shooter, or racing game, for example) and the 360 output is used as a spectator device.

• Rotation Offset:
  Type: Float | Default Setting: -144
  The amount the camera system will rotate itself on creation. This makes sure that one camera is pointing directly forward in an Igloo.
  
  
• Background Colour:
  Type: Color | Default Setting: Black
  The background the camera's will draw if they are set to Color or Solid Color(no alpha) within the Clear Flags variable.
  
  
• Culling Mask:
  Type: Mask | Default Setting: Everything
  This defines what will be culled or not by the cameras when they draw. For more information on this please visit this link.
  
  
• Auto Start:
  Type: Boolean | Default Setting: false
  If this is enabled the camera system will start up by itself. This is set to true by the IglooCameraCreator if you are using the Igloo prefab.
  
  
• Culling Mask 3D:
  Type: Mask | Default Setting: Mixed
  This defines what will be culled or not by the 3D cameras when they draw. We choose to not make the UI layer 3D by selecting this to not get drawn.