Type alias VimSettings

Type declaration

• fileType: FileType

  Specifies the file type (vim or vimx) if it cannot or should not be inferred from the file extension.

• legacy: boolean

  Set to true to use the legacy loading pipeline.

• legacyInstances: number[]

  The instance indices of objects to load. All objects are loaded if no value is provided in the legacy pipeline.

• legacyLoadRooms: boolean

  Set to true to load and display rooms in the legacy pipeline.

• legacyNoHeader: boolean

  Set to true to prevent downloading the header in the legacy pipeline.

• legacyNoMap: boolean

  Set to true to prevent downloading the element/geometry map in the legacy pipeline.

• legacyNoStrings: boolean

  Set to true to prevent downloading strings in the legacy pipeline.

• matrix: THREE.Matrix4

  The matrix representation of the vim object's position, rotation, and scale. Setting this will override individual position, rotation, and scale properties.

• position: THREE.Vector3

  The positional offset for the vim object.

• progressive: boolean

  Set to true to stream geometry to the scene. Only supported with vimx files.

• progressiveInterval: number

  The time in milliseconds between each scene refresh during progressive loading.

• rotation: THREE.Vector3

  The XYZ rotation applied to the vim object.

• scale: number

  The scaling factor applied to the vim object.

• transparency: Mode

  Determines whether objects are drawn based on their transparency.

• verboseHttp: boolean

  Set to true to enable verbose HTTP logging.