Type alias Settings

Type declaration

• axes: Partial<GizmoOptions>

  Axes gizmo options

• background: {
      color: Color;
  }

  Rendering background options

  • color: Color

• camera: {
      allowedMovement: THREE.Vector3;
      allowedRotation: THREE.Vector2;
      controls: {
          moveSpeed: number;
          orbit: boolean;
          orbitSpeed: number;
          rotateSpeed: number;
      };
      far: number;
      forward: THREE.Vector3;
      fov: number;
      gizmo: {
          color: Color;
          enable: boolean;
          opacity: number;
          opacityAlways: number;
          size: number;
      };
      near: number;
      orthographic: boolean;
      zoom: number;
  }

  Three.js camera related options

  • allowedMovement: THREE.Vector3

    Vector3 of 0 or 1 to enable/disable movement along each axis

  • allowedRotation: THREE.Vector2

    Vector2 of 0 or 1 to enable/disable rotation around x or y.

  • controls: {
        moveSpeed: number;
        orbit: boolean;
        orbitSpeed: number;
        rotateSpeed: number;
    }

    Camera controls related options

    • moveSpeed: number

      Camera movement speed factor

    • orbit: boolean

      Set true to start in orbit mode.

      Camera has two modes: First person and orbit

      First person allows to moves the camera around freely

      Orbit rotates the camera around a focus point

    • orbitSpeed: number

    • rotateSpeed: number

      Camera rotation speed factor

  • far: number

    Far clipping plane distance

  • forward: THREE.Vector3

    Initial forward of the camera

  • fov: number

    Fov angle in degrees

  • gizmo: {
        color: Color;
        enable: boolean;
        opacity: number;
        opacityAlways: number;
        size: number;
    }

    Camera gizmo related options

    • color: Color

    • enable: boolean

    • opacity: number

    • opacityAlways: number

    • size: number

  • near: number

    Near clipping plane distance

  • orthographic: boolean

    Start with orthographic camera

  • zoom: number

    Zoom level

• canvas: {
      id: string | undefined;
      resizeDelay: number;
  }

  Webgl canvas related options

  • id: string | undefined

    Canvas dom model id. If none provided a new canvas will be created

  • resizeDelay: number

    Limits how often canvas will be resized if window is resized.

• groundPlane: {
      color: Color;
      encoding: TextureEncoding;
      opacity: number;
      size: number;
      texture: string;
      visible: boolean;
  }

  Plane under scene related options

  • color: Color

    Color of the plane

  • encoding: TextureEncoding

  • opacity: number

    Opacity of the plane

  • size: number

    Actual size is SceneRadius*size

  • texture: string

    Local or remote texture url for plane

  • visible: boolean

    Enables/Disables plane under scene

• materials: MaterialSettings

• rendering: {
      onDemand: boolean;
  }

  • onDemand: boolean

• skylight: {
      groundColor: Color;
      intensity: number;
      skyColor: Color;
  }

  Skylight (hemisphere light) options

  • groundColor: Color

  • intensity: number

  • skyColor: Color

• sunLights: {
      color: Color;
      intensity: number;
      position: THREE.Vector3;
  }[]

  Sunlight (directional light) options