Cylindrical Projection#

This projection method renders the scene into a view that can be mapped on the inside or outside of a cylinder. This projection method is support by some live media curation tools. The forward-facing direction will be at the left border of the image unless changed via the rotation option.

  • type
    string = “CylindricalProjection”

    Defines the type of this projection.

  • quality (optional)
    low, 256, medium, 512, high, 1k, 1024, 1.5k, 1536, 2k, 2048, 4k, 4096, 8k, 8192, 16k, 16384, 32k, 32768, 64k, 65536

    Determines the pixel resolution of the cube map faces that are individually rendered to create the cylindrical rendering. The higher resolution these cube map faces have, the better quality the resulting cylindrical rendering, but this comes at the expense of increased rendering times. The named values are corresponding:

    • low: 256

    • medium: 512 (the default)

    • high: 1024

    • 1k: 1024

    • 1.5k: 1536

    • 2k: 2048

    • 4k: 4096

    • 8k: 8192

    • 16k: 16384

  • rotation (optional)
    number

    Provides a rotation angle (in radians) around the z-axis around which the cylindrical projection is offset into the resulting image.

  • heightoffset (optional)
    number

    Offsets the height from which the cylindrical projection is generated. This is, in general, only necessary if the user position is offset and you want to counter that offset to continue producing a “standard” cylindrical projection.

  • radius (optional)
    number

    Sets the radius of the sphere, which is only used in the cases when stereoscopic rendering is used.

Example#

Example file (download)#
{
  "version": 1,
  "masteraddress": "localhost",
  "nodes": [
    {
      "address": "localhost",
      "port": 20400,
      "windows": [
        {
          "size": { "x": 1280, "y": 720 },
          "viewports": [
            {
              "pos": { "x": 0.0, "y": 0.0 },
              "size": { "x": 1.0, "y": 1.0 },
              "projection": {
                "type": "CylindricalProjection",
                "quality": "4k"
              }
            }
          ]
        }
      ]
    }
  ],
  "users": [
    {
      "eyeseparation": 0.06,
      "pos": { "x": 0.0, "y": 0.0, "z": 0.0 }
    }
  ]
}

image