whs/src/components/cameras/PerspectiveCamera.js

Super-fast 3D framework for Web Applications & Games. Based on Three.js

import {PerspectiveCamera as PerspectiveCameraNative} from 'three';
import {CameraComponent} from '../../core/CameraComponent';
import {system} from '../../polyfill';

/**
 * @class PerspectiveCamera
 * @description Camera with perspective projection.
 * @category components/cameras
 * @param {Object} [params] - The parameters object.
 * @memberof module:components/cameras
 * @extends module:core.CameraComponent
 * @example <caption>Create an PerspectiveCamera and set it as app's camera</caption>
 * const camera = new PerspectiveCamera({
 *   fov: 75,
 *   aspect: window.innerWidth / window.innerHeight,
 *
 *   position: {
 *     x: 0,
 *     y: 100,
 *     z: 0
 *   }
 * });
 *
 * app.camera = camera;
 */
class PerspectiveCamera extends CameraComponent {
  /**
   * Default values for parameters
   * @member {Object} module:components/cameras.PerspectiveCamera#defaults
   * @static
   * @default <pre>
   * {
   *   near: 1,
   *   far: 1000,
   *   fov: 75,
   *   aspect: system.window.innerWidth / system.window.innerHeight
   * }</pre>
   */
  static defaults = {
    ...CameraComponent.defaults,

    near: 1,
    far: 1000,
    fov: 75,
    aspect: system.window.innerWidth / system.window.innerHeight
  };

  constructor(params = {}) {
    super(params, PerspectiveCamera.defaults);
  }

  build(params = {}) {
    return this.applyBridge({camera: new PerspectiveCameraNative(
      params.fov,
      params.aspect,
      params.near,
      params.far
    )}).camera;
  }
}

export {
  PerspectiveCamera
};