Source: objects/lights/LightShadow.js

  1. import { Camera } from '../camera/Camera.js';
  2. import { Matrix4 } from '../../math/Matrix4.js';
  3. import { Vector2 } from '../../math/Vector2.js';
  5. /**
  6.  * Serves as a base class for the other shadow classes.
  7.  * @constructor
  8.  * @hideconstructor
  9.  * @abstract
  10.  * @memberof zen3d
  11.  */
  12. function LightShadow() {
  13. 	/**
  14.       * The light's view of the world.
  15.       * This is used to generate a depth map of the scene; objects behind other objects from the light's perspective will be in shadow.
  16.       * @type {zen3d.Camera}
  17.       */
  18. 	this.camera = new Camera();
  20. 	/**
  21.       * Model to shadow camera space, to compute location and depth in shadow map. Stored in a {@link zen3d.Matrix4}.
  22.       * This is computed internally during rendering.
  23.       * @type {zen3d.Matrix4}
  24.       */
  25. 	this.matrix = new Matrix4();
  27. 	/**
  28.       * Shadow map bias, how much to add or subtract from the normalized depth when deciding whether a surface is in shadow.
  29.       * Very tiny adjustments here (in the order of 0.0001) may help reduce artefacts in shadows.
  30.       * @type {number}
  31.       * @default 0
  32.       */
  33. 	this.bias = 0;
  35. 	/**
  36.       * Setting this to values greater than 1 will blur the edges of the shadow.
  37.       * High values will cause unwanted banding effects in the shadows - a greater mapSize will allow for a higher value to be used here before these effects become visible.
  38.       * Note that this has no effect if the {@link @zen3d.Object3D#shadowType} is set to PCF or PCSS.
  39.       * @type {number}
  40.       * @default 2
  41.       */
  42. 	this.radius = 2;
  44. 	/**
  45.       * Shadow camera near.
  46.       * @type {number}
  47.       * @default 1
  48.       */
  49. 	this.cameraNear = 1;
  51. 	/**
  52.       * Shadow camera far.
  53.       * @type {number}
  54.       * @default 500
  55.       */
  56. 	this.cameraFar = 500;
  58. 	/**
  59.       * A {@link zen3d.Vector2} defining the width and height of the shadow map.
  60.       * Higher values give better quality shadows at the cost of computation time.
  61.       * Values must be powers of 2.
  62.       * @type {zen3d.Vector2}
  63.       * @default zen3d.Vector2(512, 512)
  64.       */
  65. 	this.mapSize = new Vector2(512, 512);
  67. 	/**
  68.       * Enables automatic updates of the light's shadow.
  69.       * If you do not require dynamic lighting / shadows, you may set this to false.
  70.       * @type {boolean}
  71.       * @default true
  72.       */
  73. 	this.autoUpdate = true;
  75. 	/**
  76.       * When set to true, shadow maps will be updated in the next ShadowMapPass.render call.
  77.       * If you have set .autoUpdate to false, you will need to set this property to true and then make a ShadowMapPass.render call to update the light's shadow.
  78.       * @type {boolean}
  79.       * @default false
  80.       */
  81. 	this.needsUpdate = false;
  83. 	this.renderTarget = null;
  84. 	this.map = null;
  85. }
  87. Object.assign(LightShadow.prototype, /** @lends zen3d.LightShadow.prototype */{
  89. 	update: function(light, face) {
  91. 	},
  93. 	copy: function(source) {
  94. 		this.camera.copy(source.camera);
  95. 		this.matrix.copy(source.matrix);
  97. 		this.bias = source.bias;
  98. 		this.radius = source.radius;
  100. 		this.cameraNear = source.cameraNear;
  101. 		this.cameraFar = source.cameraFar;
  103. 		this.mapSize.copy(source.mapSize);
  105. 		return this;
  106. 	},
  108. 	clone: function() {
  109. 		return new this.constructor().copy(this);
  110. 	}
  112. });
  114. export { LightShadow };