cesium
Version:
CesiumJS is a JavaScript library for creating 3D globes and 2D maps in a web browser without a plugin.
1,153 lines (1,012 loc) • 96.2 kB
JavaScript
/* This file is automatically rebuilt by the Cesium build process. */
define(['exports', './when-e6e3e713', './Check-1df6b9a0', './Math-c5f6c994', './Cartesian2-1d7364fa', './Transforms-943e8463', './ComponentDatatype-2b8834a4', './GeometryAttribute-3a303898', './GeometryAttributes-6cf4559b', './Plane-2e419ea5', './VertexFormat-3b318cdc'], function (exports, when, Check, _Math, Cartesian2, Transforms, ComponentDatatype, GeometryAttribute, GeometryAttributes, Plane, VertexFormat) { 'use strict';
/**
* The culling volume defined by planes.
*
* @alias CullingVolume
* @constructor
*
* @param {Cartesian4[]} [planes] An array of clipping planes.
*/
function CullingVolume(planes) {
/**
* Each plane is represented by a Cartesian4 object, where the x, y, and z components
* define the unit vector normal to the plane, and the w component is the distance of the
* plane from the origin.
* @type {Cartesian4[]}
* @default []
*/
this.planes = when.defaultValue(planes, []);
}
var faces = [new Cartesian2.Cartesian3(), new Cartesian2.Cartesian3(), new Cartesian2.Cartesian3()];
Cartesian2.Cartesian3.clone(Cartesian2.Cartesian3.UNIT_X, faces[0]);
Cartesian2.Cartesian3.clone(Cartesian2.Cartesian3.UNIT_Y, faces[1]);
Cartesian2.Cartesian3.clone(Cartesian2.Cartesian3.UNIT_Z, faces[2]);
var scratchPlaneCenter = new Cartesian2.Cartesian3();
var scratchPlaneNormal = new Cartesian2.Cartesian3();
var scratchPlane = new Plane.Plane(new Cartesian2.Cartesian3(1.0, 0.0, 0.0), 0.0);
/**
* Constructs a culling volume from a bounding sphere. Creates six planes that create a box containing the sphere.
* The planes are aligned to the x, y, and z axes in world coordinates.
*
* @param {BoundingSphere} boundingSphere The bounding sphere used to create the culling volume.
* @param {CullingVolume} [result] The object onto which to store the result.
* @returns {CullingVolume} The culling volume created from the bounding sphere.
*/
CullingVolume.fromBoundingSphere = function(boundingSphere, result) {
//>>includeStart('debug', pragmas.debug);
if (!when.defined(boundingSphere)) {
throw new Check.DeveloperError('boundingSphere is required.');
}
//>>includeEnd('debug');
if (!when.defined(result)) {
result = new CullingVolume();
}
var length = faces.length;
var planes = result.planes;
planes.length = 2 * length;
var center = boundingSphere.center;
var radius = boundingSphere.radius;
var planeIndex = 0;
for (var i = 0; i < length; ++i) {
var faceNormal = faces[i];
var plane0 = planes[planeIndex];
var plane1 = planes[planeIndex + 1];
if (!when.defined(plane0)) {
plane0 = planes[planeIndex] = new Transforms.Cartesian4();
}
if (!when.defined(plane1)) {
plane1 = planes[planeIndex + 1] = new Transforms.Cartesian4();
}
Cartesian2.Cartesian3.multiplyByScalar(faceNormal, -radius, scratchPlaneCenter);
Cartesian2.Cartesian3.add(center, scratchPlaneCenter, scratchPlaneCenter);
plane0.x = faceNormal.x;
plane0.y = faceNormal.y;
plane0.z = faceNormal.z;
plane0.w = -Cartesian2.Cartesian3.dot(faceNormal, scratchPlaneCenter);
Cartesian2.Cartesian3.multiplyByScalar(faceNormal, radius, scratchPlaneCenter);
Cartesian2.Cartesian3.add(center, scratchPlaneCenter, scratchPlaneCenter);
plane1.x = -faceNormal.x;
plane1.y = -faceNormal.y;
plane1.z = -faceNormal.z;
plane1.w = -Cartesian2.Cartesian3.dot(Cartesian2.Cartesian3.negate(faceNormal, scratchPlaneNormal), scratchPlaneCenter);
planeIndex += 2;
}
return result;
};
/**
* Determines whether a bounding volume intersects the culling volume.
*
* @param {Object} boundingVolume The bounding volume whose intersection with the culling volume is to be tested.
* @returns {Intersect} Intersect.OUTSIDE, Intersect.INTERSECTING, or Intersect.INSIDE.
*/
CullingVolume.prototype.computeVisibility = function(boundingVolume) {
//>>includeStart('debug', pragmas.debug);
if (!when.defined(boundingVolume)) {
throw new Check.DeveloperError('boundingVolume is required.');
}
//>>includeEnd('debug');
var planes = this.planes;
var intersecting = false;
for (var k = 0, len = planes.length; k < len; ++k) {
var result = boundingVolume.intersectPlane(Plane.Plane.fromCartesian4(planes[k], scratchPlane));
if (result === Transforms.Intersect.OUTSIDE) {
return Transforms.Intersect.OUTSIDE;
} else if (result === Transforms.Intersect.INTERSECTING) {
intersecting = true;
}
}
return intersecting ? Transforms.Intersect.INTERSECTING : Transforms.Intersect.INSIDE;
};
/**
* Determines whether a bounding volume intersects the culling volume.
*
* @param {Object} boundingVolume The bounding volume whose intersection with the culling volume is to be tested.
* @param {Number} parentPlaneMask A bit mask from the boundingVolume's parent's check against the same culling
* volume, such that if (planeMask & (1 << planeIndex) === 0), for k < 31, then
* the parent (and therefore this) volume is completely inside plane[planeIndex]
* and that plane check can be skipped.
* @returns {Number} A plane mask as described above (which can be applied to this boundingVolume's children).
*
* @private
*/
CullingVolume.prototype.computeVisibilityWithPlaneMask = function(boundingVolume, parentPlaneMask) {
//>>includeStart('debug', pragmas.debug);
if (!when.defined(boundingVolume)) {
throw new Check.DeveloperError('boundingVolume is required.');
}
if (!when.defined(parentPlaneMask)) {
throw new Check.DeveloperError('parentPlaneMask is required.');
}
//>>includeEnd('debug');
if (parentPlaneMask === CullingVolume.MASK_OUTSIDE || parentPlaneMask === CullingVolume.MASK_INSIDE) {
// parent is completely outside or completely inside, so this child is as well.
return parentPlaneMask;
}
// Start with MASK_INSIDE (all zeros) so that after the loop, the return value can be compared with MASK_INSIDE.
// (Because if there are fewer than 31 planes, the upper bits wont be changed.)
var mask = CullingVolume.MASK_INSIDE;
var planes = this.planes;
for (var k = 0, len = planes.length; k < len; ++k) {
// For k greater than 31 (since 31 is the maximum number of INSIDE/INTERSECTING bits we can store), skip the optimization.
var flag = (k < 31) ? (1 << k) : 0;
if (k < 31 && (parentPlaneMask & flag) === 0) {
// boundingVolume is known to be INSIDE this plane.
continue;
}
var result = boundingVolume.intersectPlane(Plane.Plane.fromCartesian4(planes[k], scratchPlane));
if (result === Transforms.Intersect.OUTSIDE) {
return CullingVolume.MASK_OUTSIDE;
} else if (result === Transforms.Intersect.INTERSECTING) {
mask |= flag;
}
}
return mask;
};
/**
* For plane masks (as used in {@link CullingVolume#computeVisibilityWithPlaneMask}), this special value
* represents the case where the object bounding volume is entirely outside the culling volume.
*
* @type {Number}
* @private
*/
CullingVolume.MASK_OUTSIDE = 0xffffffff;
/**
* For plane masks (as used in {@link CullingVolume.prototype.computeVisibilityWithPlaneMask}), this value
* represents the case where the object bounding volume is entirely inside the culling volume.
*
* @type {Number}
* @private
*/
CullingVolume.MASK_INSIDE = 0x00000000;
/**
* For plane masks (as used in {@link CullingVolume.prototype.computeVisibilityWithPlaneMask}), this value
* represents the case where the object bounding volume (may) intersect all planes of the culling volume.
*
* @type {Number}
* @private
*/
CullingVolume.MASK_INDETERMINATE = 0x7fffffff;
/**
* The viewing frustum is defined by 6 planes.
* Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components
* define the unit vector normal to the plane, and the w component is the distance of the
* plane from the origin/camera position.
*
* @alias OrthographicOffCenterFrustum
* @constructor
*
* @param {Object} [options] An object with the following properties:
* @param {Number} [options.left] The left clipping plane distance.
* @param {Number} [options.right] The right clipping plane distance.
* @param {Number} [options.top] The top clipping plane distance.
* @param {Number} [options.bottom] The bottom clipping plane distance.
* @param {Number} [options.near=1.0] The near clipping plane distance.
* @param {Number} [options.far=500000000.0] The far clipping plane distance.
*
* @example
* var maxRadii = ellipsoid.maximumRadius;
*
* var frustum = new Cesium.OrthographicOffCenterFrustum();
* frustum.right = maxRadii * Cesium.Math.PI;
* frustum.left = -c.frustum.right;
* frustum.top = c.frustum.right * (canvas.clientHeight / canvas.clientWidth);
* frustum.bottom = -c.frustum.top;
* frustum.near = 0.01 * maxRadii;
* frustum.far = 50.0 * maxRadii;
*/
function OrthographicOffCenterFrustum(options) {
options = when.defaultValue(options, when.defaultValue.EMPTY_OBJECT);
/**
* The left clipping plane.
* @type {Number}
* @default undefined
*/
this.left = options.left;
this._left = undefined;
/**
* The right clipping plane.
* @type {Number}
* @default undefined
*/
this.right = options.right;
this._right = undefined;
/**
* The top clipping plane.
* @type {Number}
* @default undefined
*/
this.top = options.top;
this._top = undefined;
/**
* The bottom clipping plane.
* @type {Number}
* @default undefined
*/
this.bottom = options.bottom;
this._bottom = undefined;
/**
* The distance of the near plane.
* @type {Number}
* @default 1.0
*/
this.near = when.defaultValue(options.near, 1.0);
this._near = this.near;
/**
* The distance of the far plane.
* @type {Number}
* @default 500000000.0;
*/
this.far = when.defaultValue(options.far, 500000000.0);
this._far = this.far;
this._cullingVolume = new CullingVolume();
this._orthographicMatrix = new Transforms.Matrix4();
}
function update(frustum) {
//>>includeStart('debug', pragmas.debug);
if (!when.defined(frustum.right) || !when.defined(frustum.left) ||
!when.defined(frustum.top) || !when.defined(frustum.bottom) ||
!when.defined(frustum.near) || !when.defined(frustum.far)) {
throw new Check.DeveloperError('right, left, top, bottom, near, or far parameters are not set.');
}
//>>includeEnd('debug');
if (frustum.top !== frustum._top || frustum.bottom !== frustum._bottom ||
frustum.left !== frustum._left || frustum.right !== frustum._right ||
frustum.near !== frustum._near || frustum.far !== frustum._far) {
//>>includeStart('debug', pragmas.debug);
if (frustum.left > frustum.right) {
throw new Check.DeveloperError('right must be greater than left.');
}
if (frustum.bottom > frustum.top) {
throw new Check.DeveloperError('top must be greater than bottom.');
}
if (frustum.near <= 0 || frustum.near > frustum.far) {
throw new Check.DeveloperError('near must be greater than zero and less than far.');
}
//>>includeEnd('debug');
frustum._left = frustum.left;
frustum._right = frustum.right;
frustum._top = frustum.top;
frustum._bottom = frustum.bottom;
frustum._near = frustum.near;
frustum._far = frustum.far;
frustum._orthographicMatrix = Transforms.Matrix4.computeOrthographicOffCenter(frustum.left, frustum.right, frustum.bottom, frustum.top, frustum.near, frustum.far, frustum._orthographicMatrix);
}
}
Object.defineProperties(OrthographicOffCenterFrustum.prototype, {
/**
* Gets the orthographic projection matrix computed from the view frustum.
* @memberof OrthographicOffCenterFrustum.prototype
* @type {Matrix4}
* @readonly
*/
projectionMatrix : {
get : function() {
update(this);
return this._orthographicMatrix;
}
}
});
var getPlanesRight = new Cartesian2.Cartesian3();
var getPlanesNearCenter = new Cartesian2.Cartesian3();
var getPlanesPoint = new Cartesian2.Cartesian3();
var negateScratch = new Cartesian2.Cartesian3();
/**
* Creates a culling volume for this frustum.
*
* @param {Cartesian3} position The eye position.
* @param {Cartesian3} direction The view direction.
* @param {Cartesian3} up The up direction.
* @returns {CullingVolume} A culling volume at the given position and orientation.
*
* @example
* // Check if a bounding volume intersects the frustum.
* var cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
* var intersect = cullingVolume.computeVisibility(boundingVolume);
*/
OrthographicOffCenterFrustum.prototype.computeCullingVolume = function(position, direction, up) {
//>>includeStart('debug', pragmas.debug);
if (!when.defined(position)) {
throw new Check.DeveloperError('position is required.');
}
if (!when.defined(direction)) {
throw new Check.DeveloperError('direction is required.');
}
if (!when.defined(up)) {
throw new Check.DeveloperError('up is required.');
}
//>>includeEnd('debug');
var planes = this._cullingVolume.planes;
var t = this.top;
var b = this.bottom;
var r = this.right;
var l = this.left;
var n = this.near;
var f = this.far;
var right = Cartesian2.Cartesian3.cross(direction, up, getPlanesRight);
Cartesian2.Cartesian3.normalize(right, right);
var nearCenter = getPlanesNearCenter;
Cartesian2.Cartesian3.multiplyByScalar(direction, n, nearCenter);
Cartesian2.Cartesian3.add(position, nearCenter, nearCenter);
var point = getPlanesPoint;
// Left plane
Cartesian2.Cartesian3.multiplyByScalar(right, l, point);
Cartesian2.Cartesian3.add(nearCenter, point, point);
var plane = planes[0];
if (!when.defined(plane)) {
plane = planes[0] = new Transforms.Cartesian4();
}
plane.x = right.x;
plane.y = right.y;
plane.z = right.z;
plane.w = -Cartesian2.Cartesian3.dot(right, point);
// Right plane
Cartesian2.Cartesian3.multiplyByScalar(right, r, point);
Cartesian2.Cartesian3.add(nearCenter, point, point);
plane = planes[1];
if (!when.defined(plane)) {
plane = planes[1] = new Transforms.Cartesian4();
}
plane.x = -right.x;
plane.y = -right.y;
plane.z = -right.z;
plane.w = -Cartesian2.Cartesian3.dot(Cartesian2.Cartesian3.negate(right, negateScratch), point);
// Bottom plane
Cartesian2.Cartesian3.multiplyByScalar(up, b, point);
Cartesian2.Cartesian3.add(nearCenter, point, point);
plane = planes[2];
if (!when.defined(plane)) {
plane = planes[2] = new Transforms.Cartesian4();
}
plane.x = up.x;
plane.y = up.y;
plane.z = up.z;
plane.w = -Cartesian2.Cartesian3.dot(up, point);
// Top plane
Cartesian2.Cartesian3.multiplyByScalar(up, t, point);
Cartesian2.Cartesian3.add(nearCenter, point, point);
plane = planes[3];
if (!when.defined(plane)) {
plane = planes[3] = new Transforms.Cartesian4();
}
plane.x = -up.x;
plane.y = -up.y;
plane.z = -up.z;
plane.w = -Cartesian2.Cartesian3.dot(Cartesian2.Cartesian3.negate(up, negateScratch), point);
// Near plane
plane = planes[4];
if (!when.defined(plane)) {
plane = planes[4] = new Transforms.Cartesian4();
}
plane.x = direction.x;
plane.y = direction.y;
plane.z = direction.z;
plane.w = -Cartesian2.Cartesian3.dot(direction, nearCenter);
// Far plane
Cartesian2.Cartesian3.multiplyByScalar(direction, f, point);
Cartesian2.Cartesian3.add(position, point, point);
plane = planes[5];
if (!when.defined(plane)) {
plane = planes[5] = new Transforms.Cartesian4();
}
plane.x = -direction.x;
plane.y = -direction.y;
plane.z = -direction.z;
plane.w = -Cartesian2.Cartesian3.dot(Cartesian2.Cartesian3.negate(direction, negateScratch), point);
return this._cullingVolume;
};
/**
* Returns the pixel's width and height in meters.
*
* @param {Number} drawingBufferWidth The width of the drawing buffer.
* @param {Number} drawingBufferHeight The height of the drawing buffer.
* @param {Number} distance The distance to the near plane in meters.
* @param {Number} pixelRatio The scaling factor from pixel space to coordinate space.
* @param {Cartesian2} result The object onto which to store the result.
* @returns {Cartesian2} The modified result parameter or a new instance of {@link Cartesian2} with the pixel's width and height in the x and y properties, respectively.
*
* @exception {DeveloperError} drawingBufferWidth must be greater than zero.
* @exception {DeveloperError} drawingBufferHeight must be greater than zero.
* @exception {DeveloperError} pixelRatio must be greater than zero.
*
* @example
* // Example 1
* // Get the width and height of a pixel.
* var pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, 0.0, scene.pixelRatio, new Cesium.Cartesian2());
*/
OrthographicOffCenterFrustum.prototype.getPixelDimensions = function(drawingBufferWidth, drawingBufferHeight, distance, pixelRatio, result) {
update(this);
//>>includeStart('debug', pragmas.debug);
if (!when.defined(drawingBufferWidth) || !when.defined(drawingBufferHeight)) {
throw new Check.DeveloperError('Both drawingBufferWidth and drawingBufferHeight are required.');
}
if (drawingBufferWidth <= 0) {
throw new Check.DeveloperError('drawingBufferWidth must be greater than zero.');
}
if (drawingBufferHeight <= 0) {
throw new Check.DeveloperError('drawingBufferHeight must be greater than zero.');
}
if (!when.defined(distance)) {
throw new Check.DeveloperError('distance is required.');
}
if (!when.defined(pixelRatio)) {
throw new Check.DeveloperError('pixelRatio is required.');
}
if (pixelRatio <= 0) {
throw new Check.DeveloperError('pixelRatio must be greater than zero.');
}
if (!when.defined(result)) {
throw new Check.DeveloperError('A result object is required.');
}
//>>includeEnd('debug');
var frustumWidth = this.right - this.left;
var frustumHeight = this.top - this.bottom;
var pixelWidth = pixelRatio * frustumWidth / drawingBufferWidth;
var pixelHeight = pixelRatio * frustumHeight / drawingBufferHeight;
result.x = pixelWidth;
result.y = pixelHeight;
return result;
};
/**
* Returns a duplicate of a OrthographicOffCenterFrustum instance.
*
* @param {OrthographicOffCenterFrustum} [result] The object onto which to store the result.
* @returns {OrthographicOffCenterFrustum} The modified result parameter or a new OrthographicOffCenterFrustum instance if one was not provided.
*/
OrthographicOffCenterFrustum.prototype.clone = function(result) {
if (!when.defined(result)) {
result = new OrthographicOffCenterFrustum();
}
result.left = this.left;
result.right = this.right;
result.top = this.top;
result.bottom = this.bottom;
result.near = this.near;
result.far = this.far;
// force update of clone to compute matrices
result._left = undefined;
result._right = undefined;
result._top = undefined;
result._bottom = undefined;
result._near = undefined;
result._far = undefined;
return result;
};
/**
* Compares the provided OrthographicOffCenterFrustum componentwise and returns
* <code>true</code> if they are equal, <code>false</code> otherwise.
*
* @param {OrthographicOffCenterFrustum} [other] The right hand side OrthographicOffCenterFrustum.
* @returns {Boolean} <code>true</code> if they are equal, <code>false</code> otherwise.
*/
OrthographicOffCenterFrustum.prototype.equals = function(other) {
return (when.defined(other) && other instanceof OrthographicOffCenterFrustum &&
this.right === other.right &&
this.left === other.left &&
this.top === other.top &&
this.bottom === other.bottom &&
this.near === other.near &&
this.far === other.far);
};
/**
* Compares the provided OrthographicOffCenterFrustum componentwise and returns
* <code>true</code> if they pass an absolute or relative tolerance test,
* <code>false</code> otherwise.
*
* @param {OrthographicOffCenterFrustum} other The right hand side OrthographicOffCenterFrustum.
* @param {Number} relativeEpsilon The relative epsilon tolerance to use for equality testing.
* @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing.
* @returns {Boolean} <code>true</code> if this and other are within the provided epsilon, <code>false</code> otherwise.
*/
OrthographicOffCenterFrustum.prototype.equalsEpsilon = function(other, relativeEpsilon, absoluteEpsilon) {
return (other === this) ||
(when.defined(other) &&
other instanceof OrthographicOffCenterFrustum &&
_Math.CesiumMath.equalsEpsilon(this.right, other.right, relativeEpsilon, absoluteEpsilon) &&
_Math.CesiumMath.equalsEpsilon(this.left, other.left, relativeEpsilon, absoluteEpsilon) &&
_Math.CesiumMath.equalsEpsilon(this.top, other.top, relativeEpsilon, absoluteEpsilon) &&
_Math.CesiumMath.equalsEpsilon(this.bottom, other.bottom, relativeEpsilon, absoluteEpsilon) &&
_Math.CesiumMath.equalsEpsilon(this.near, other.near, relativeEpsilon, absoluteEpsilon) &&
_Math.CesiumMath.equalsEpsilon(this.far, other.far, relativeEpsilon, absoluteEpsilon));
};
/**
* The viewing frustum is defined by 6 planes.
* Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components
* define the unit vector normal to the plane, and the w component is the distance of the
* plane from the origin/camera position.
*
* @alias OrthographicFrustum
* @constructor
*
* @param {Object} [options] An object with the following properties:
* @param {Number} [options.width] The width of the frustum in meters.
* @param {Number} [options.aspectRatio] The aspect ratio of the frustum's width to it's height.
* @param {Number} [options.near=1.0] The distance of the near plane.
* @param {Number} [options.far=500000000.0] The distance of the far plane.
*
* @example
* var maxRadii = ellipsoid.maximumRadius;
*
* var frustum = new Cesium.OrthographicFrustum();
* frustum.near = 0.01 * maxRadii;
* frustum.far = 50.0 * maxRadii;
*/
function OrthographicFrustum(options) {
options = when.defaultValue(options, when.defaultValue.EMPTY_OBJECT);
this._offCenterFrustum = new OrthographicOffCenterFrustum();
/**
* The horizontal width of the frustum in meters.
* @type {Number}
* @default undefined
*/
this.width = options.width;
this._width = undefined;
/**
* The aspect ratio of the frustum's width to it's height.
* @type {Number}
* @default undefined
*/
this.aspectRatio = options.aspectRatio;
this._aspectRatio = undefined;
/**
* The distance of the near plane.
* @type {Number}
* @default 1.0
*/
this.near = when.defaultValue(options.near, 1.0);
this._near = this.near;
/**
* The distance of the far plane.
* @type {Number}
* @default 500000000.0;
*/
this.far = when.defaultValue(options.far, 500000000.0);
this._far = this.far;
}
/**
* The number of elements used to pack the object into an array.
* @type {Number}
*/
OrthographicFrustum.packedLength = 4;
/**
* Stores the provided instance into the provided array.
*
* @param {OrthographicFrustum} value The value to pack.
* @param {Number[]} array The array to pack into.
* @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
*
* @returns {Number[]} The array that was packed into
*/
OrthographicFrustum.pack = function(value, array, startingIndex) {
//>>includeStart('debug', pragmas.debug);
Check.Check.typeOf.object('value', value);
Check.Check.defined('array', array);
//>>includeEnd('debug');
startingIndex = when.defaultValue(startingIndex, 0);
array[startingIndex++] = value.width;
array[startingIndex++] = value.aspectRatio;
array[startingIndex++] = value.near;
array[startingIndex] = value.far;
return array;
};
/**
* Retrieves an instance from a packed array.
*
* @param {Number[]} array The packed array.
* @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
* @param {OrthographicFrustum} [result] The object into which to store the result.
* @returns {OrthographicFrustum} The modified result parameter or a new OrthographicFrustum instance if one was not provided.
*/
OrthographicFrustum.unpack = function(array, startingIndex, result) {
//>>includeStart('debug', pragmas.debug);
Check.Check.defined('array', array);
//>>includeEnd('debug');
startingIndex = when.defaultValue(startingIndex, 0);
if (!when.defined(result)) {
result = new OrthographicFrustum();
}
result.width = array[startingIndex++];
result.aspectRatio = array[startingIndex++];
result.near = array[startingIndex++];
result.far = array[startingIndex];
return result;
};
function update$1(frustum) {
//>>includeStart('debug', pragmas.debug);
if (!when.defined(frustum.width) || !when.defined(frustum.aspectRatio) || !when.defined(frustum.near) || !when.defined(frustum.far)) {
throw new Check.DeveloperError('width, aspectRatio, near, or far parameters are not set.');
}
//>>includeEnd('debug');
var f = frustum._offCenterFrustum;
if (frustum.width !== frustum._width || frustum.aspectRatio !== frustum._aspectRatio ||
frustum.near !== frustum._near || frustum.far !== frustum._far) {
//>>includeStart('debug', pragmas.debug);
if (frustum.aspectRatio < 0) {
throw new Check.DeveloperError('aspectRatio must be positive.');
}
if (frustum.near < 0 || frustum.near > frustum.far) {
throw new Check.DeveloperError('near must be greater than zero and less than far.');
}
//>>includeEnd('debug');
frustum._aspectRatio = frustum.aspectRatio;
frustum._width = frustum.width;
frustum._near = frustum.near;
frustum._far = frustum.far;
var ratio = 1.0 / frustum.aspectRatio;
f.right = frustum.width * 0.5;
f.left = -f.right;
f.top = ratio * f.right;
f.bottom = -f.top;
f.near = frustum.near;
f.far = frustum.far;
}
}
Object.defineProperties(OrthographicFrustum.prototype, {
/**
* Gets the orthographic projection matrix computed from the view frustum.
* @memberof OrthographicFrustum.prototype
* @type {Matrix4}
* @readonly
*/
projectionMatrix : {
get : function() {
update$1(this);
return this._offCenterFrustum.projectionMatrix;
}
}
});
/**
* Creates a culling volume for this frustum.
*
* @param {Cartesian3} position The eye position.
* @param {Cartesian3} direction The view direction.
* @param {Cartesian3} up The up direction.
* @returns {CullingVolume} A culling volume at the given position and orientation.
*
* @example
* // Check if a bounding volume intersects the frustum.
* var cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
* var intersect = cullingVolume.computeVisibility(boundingVolume);
*/
OrthographicFrustum.prototype.computeCullingVolume = function(position, direction, up) {
update$1(this);
return this._offCenterFrustum.computeCullingVolume(position, direction, up);
};
/**
* Returns the pixel's width and height in meters.
*
* @param {Number} drawingBufferWidth The width of the drawing buffer.
* @param {Number} drawingBufferHeight The height of the drawing buffer.
* @param {Number} distance The distance to the near plane in meters.
* @param {Number} pixelRatio The scaling factor from pixel space to coordinate space.
* @param {Cartesian2} result The object onto which to store the result.
* @returns {Cartesian2} The modified result parameter or a new instance of {@link Cartesian2} with the pixel's width and height in the x and y properties, respectively.
*
* @exception {DeveloperError} drawingBufferWidth must be greater than zero.
* @exception {DeveloperError} drawingBufferHeight must be greater than zero.
* @exception {DeveloperError} pixelRatio must be greater than zero.
*
* @example
* // Example 1
* // Get the width and height of a pixel.
* var pixelSize = camera.frustum.getPixelDimensions(scene.drawingBufferWidth, scene.drawingBufferHeight, 0.0, scene.pixelRatio, new Cesium.Cartesian2());
*/
OrthographicFrustum.prototype.getPixelDimensions = function(drawingBufferWidth, drawingBufferHeight, distance, pixelRatio, result) {
update$1(this);
return this._offCenterFrustum.getPixelDimensions(drawingBufferWidth, drawingBufferHeight, distance, pixelRatio, result);
};
/**
* Returns a duplicate of a OrthographicFrustum instance.
*
* @param {OrthographicFrustum} [result] The object onto which to store the result.
* @returns {OrthographicFrustum} The modified result parameter or a new OrthographicFrustum instance if one was not provided.
*/
OrthographicFrustum.prototype.clone = function(result) {
if (!when.defined(result)) {
result = new OrthographicFrustum();
}
result.aspectRatio = this.aspectRatio;
result.width = this.width;
result.near = this.near;
result.far = this.far;
// force update of clone to compute matrices
result._aspectRatio = undefined;
result._width = undefined;
result._near = undefined;
result._far = undefined;
this._offCenterFrustum.clone(result._offCenterFrustum);
return result;
};
/**
* Compares the provided OrthographicFrustum componentwise and returns
* <code>true</code> if they are equal, <code>false</code> otherwise.
*
* @param {OrthographicFrustum} [other] The right hand side OrthographicFrustum.
* @returns {Boolean} <code>true</code> if they are equal, <code>false</code> otherwise.
*/
OrthographicFrustum.prototype.equals = function(other) {
if (!when.defined(other) || !(other instanceof OrthographicFrustum)) {
return false;
}
update$1(this);
update$1(other);
return (this.width === other.width &&
this.aspectRatio === other.aspectRatio &&
this._offCenterFrustum.equals(other._offCenterFrustum));
};
/**
* Compares the provided OrthographicFrustum componentwise and returns
* <code>true</code> if they pass an absolute or relative tolerance test,
* <code>false</code> otherwise.
*
* @param {OrthographicFrustum} other The right hand side OrthographicFrustum.
* @param {Number} relativeEpsilon The relative epsilon tolerance to use for equality testing.
* @param {Number} [absoluteEpsilon=relativeEpsilon] The absolute epsilon tolerance to use for equality testing.
* @returns {Boolean} <code>true</code> if this and other are within the provided epsilon, <code>false</code> otherwise.
*/
OrthographicFrustum.prototype.equalsEpsilon = function(other, relativeEpsilon, absoluteEpsilon) {
if (!when.defined(other) || !(other instanceof OrthographicFrustum)) {
return false;
}
update$1(this);
update$1(other);
return (_Math.CesiumMath.equalsEpsilon(this.width, other.width, relativeEpsilon, absoluteEpsilon) &&
_Math.CesiumMath.equalsEpsilon(this.aspectRatio, other.aspectRatio, relativeEpsilon, absoluteEpsilon) &&
this._offCenterFrustum.equalsEpsilon(other._offCenterFrustum, relativeEpsilon, absoluteEpsilon));
};
/**
* The viewing frustum is defined by 6 planes.
* Each plane is represented by a {@link Cartesian4} object, where the x, y, and z components
* define the unit vector normal to the plane, and the w component is the distance of the
* plane from the origin/camera position.
*
* @alias PerspectiveOffCenterFrustum
* @constructor
*
* @param {Object} [options] An object with the following properties:
* @param {Number} [options.left] The left clipping plane distance.
* @param {Number} [options.right] The right clipping plane distance.
* @param {Number} [options.top] The top clipping plane distance.
* @param {Number} [options.bottom] The bottom clipping plane distance.
* @param {Number} [options.near=1.0] The near clipping plane distance.
* @param {Number} [options.far=500000000.0] The far clipping plane distance.
*
* @example
* var frustum = new Cesium.PerspectiveOffCenterFrustum({
* left : -1.0,
* right : 1.0,
* top : 1.0,
* bottom : -1.0,
* near : 1.0,
* far : 100.0
* });
*
* @see PerspectiveFrustum
*/
function PerspectiveOffCenterFrustum(options) {
options = when.defaultValue(options, when.defaultValue.EMPTY_OBJECT);
/**
* Defines the left clipping plane.
* @type {Number}
* @default undefined
*/
this.left = options.left;
this._left = undefined;
/**
* Defines the right clipping plane.
* @type {Number}
* @default undefined
*/
this.right = options.right;
this._right = undefined;
/**
* Defines the top clipping plane.
* @type {Number}
* @default undefined
*/
this.top = options.top;
this._top = undefined;
/**
* Defines the bottom clipping plane.
* @type {Number}
* @default undefined
*/
this.bottom = options.bottom;
this._bottom = undefined;
/**
* The distance of the near plane.
* @type {Number}
* @default 1.0
*/
this.near = when.defaultValue(options.near, 1.0);
this._near = this.near;
/**
* The distance of the far plane.
* @type {Number}
* @default 500000000.0
*/
this.far = when.defaultValue(options.far, 500000000.0);
this._far = this.far;
this._cullingVolume = new CullingVolume();
this._perspectiveMatrix = new Transforms.Matrix4();
this._infinitePerspective = new Transforms.Matrix4();
}
function update$2(frustum) {
//>>includeStart('debug', pragmas.debug);
if (!when.defined(frustum.right) || !when.defined(frustum.left) ||
!when.defined(frustum.top) || !when.defined(frustum.bottom) ||
!when.defined(frustum.near) || !when.defined(frustum.far)) {
throw new Check.DeveloperError('right, left, top, bottom, near, or far parameters are not set.');
}
//>>includeEnd('debug');
var t = frustum.top;
var b = frustum.bottom;
var r = frustum.right;
var l = frustum.left;
var n = frustum.near;
var f = frustum.far;
if (t !== frustum._top || b !== frustum._bottom ||
l !== frustum._left || r !== frustum._right ||
n !== frustum._near || f !== frustum._far) {
//>>includeStart('debug', pragmas.debug);
if (frustum.near <= 0 || frustum.near > frustum.far) {
throw new Check.DeveloperError('near must be greater than zero and less than far.');
}
//>>includeEnd('debug');
frustum._left = l;
frustum._right = r;
frustum._top = t;
frustum._bottom = b;
frustum._near = n;
frustum._far = f;
frustum._perspectiveMatrix = Transforms.Matrix4.computePerspectiveOffCenter(l, r, b, t, n, f, frustum._perspectiveMatrix);
frustum._infinitePerspective = Transforms.Matrix4.computeInfinitePerspectiveOffCenter(l, r, b, t, n, frustum._infinitePerspective);
}
}
Object.defineProperties(PerspectiveOffCenterFrustum.prototype, {
/**
* Gets the perspective projection matrix computed from the view frustum.
* @memberof PerspectiveOffCenterFrustum.prototype
* @type {Matrix4}
* @readonly
*
* @see PerspectiveOffCenterFrustum#infiniteProjectionMatrix
*/
projectionMatrix : {
get : function() {
update$2(this);
return this._perspectiveMatrix;
}
},
/**
* Gets the perspective projection matrix computed from the view frustum with an infinite far plane.
* @memberof PerspectiveOffCenterFrustum.prototype
* @type {Matrix4}
* @readonly
*
* @see PerspectiveOffCenterFrustum#projectionMatrix
*/
infiniteProjectionMatrix : {
get : function() {
update$2(this);
return this._infinitePerspective;
}
}
});
var getPlanesRight$1 = new Cartesian2.Cartesian3();
var getPlanesNearCenter$1 = new Cartesian2.Cartesian3();
var getPlanesFarCenter = new Cartesian2.Cartesian3();
var getPlanesNormal = new Cartesian2.Cartesian3();
/**
* Creates a culling volume for this frustum.
*
* @param {Cartesian3} position The eye position.
* @param {Cartesian3} direction The view direction.
* @param {Cartesian3} up The up direction.
* @returns {CullingVolume} A culling volume at the given position and orientation.
*
* @example
* // Check if a bounding volume intersects the frustum.
* var cullingVolume = frustum.computeCullingVolume(cameraPosition, cameraDirection, cameraUp);
* var intersect = cullingVolume.computeVisibility(boundingVolume);
*/
PerspectiveOffCenterFrustum.prototype.computeCullingVolume = function(position, direction, up) {
//>>includeStart('debug', pragmas.debug);
if (!when.defined(position)) {
throw new Check.DeveloperError('position is required.');
}
if (!when.defined(direction)) {
throw new Check.DeveloperError('direction is required.');
}
if (!when.defined(up)) {
throw new Check.DeveloperError('up is required.');
}
//>>includeEnd('debug');
var planes = this._cullingVolume.planes;
var t = this.top;
var b = this.bottom;
var r = this.right;
var l = this.left;
var n = this.near;
var f = this.far;
var right = Cartesian2.Cartesian3.cross(direction, up, getPlanesRight$1);
var nearCenter = getPlanesNearCenter$1;
Cartesian2.Cartesian3.multiplyByScalar(direction, n, nearCenter);
Cartesian2.Cartesian3.add(position, nearCenter, nearCenter);
var farCenter = getPlanesFarCenter;
Cartesian2.Cartesian3.multiplyByScalar(direction, f, farCenter);
Cartesian2.Cartesian3.add(position, farCenter, farCenter);
var normal = getPlanesNormal;
//Left plane computation
Cartesian2.Cartesian3.multiplyByScalar(right, l, normal);
Cartesian2.Cartesian3.add(nearCenter, normal, normal);
Cartesian2.Cartesian3.subtract(normal, position, normal);
Cartesian2.Cartesian3.normalize(normal, normal);
Cartesian2.Cartesian3.cross(normal, up, normal);
Cartesian2.Cartesian3.normalize(normal, normal);
var plane = planes[0];
if (!when.defined(plane)) {
plane = planes[0] = new Transforms.Cartesian4();
}
plane.x = normal.x;
plane.y = normal.y;
plane.z = normal.z;
plane.w = -Cartesian2.Cartesian3.dot(normal, position);
//Right plane computation
Cartesian2.Cartesian3.multiplyByScalar(right, r, normal);
Cartesian2.Cartesian3.add(nearCenter, normal, normal);
Cartesian2.Cartesian3.subtract(normal, position, normal);
Cartesian2.Cartesian3.cross(up, normal, normal);
Cartesian2.Cartesian3.normalize(normal, normal);
plane = planes[1];
if (!when.defined(plane)) {
plane = planes[1] = new Transforms.Cartesian4();
}
plane.x = normal.x;
plane.y = normal.y;
plane.z = normal.z;
plane.w = -Cartesian2.Cartesian3.dot(normal, position);
//Bottom plane computation
Cartesian2.Cartesian3.multiplyByScalar(up, b, normal);
Cartesian2.Cartesian3.add(nearCenter, normal, normal);
Cartesian2.Cartesian3.subtract(normal, position, normal);
Cartesian2.Cartesian3.cross(right, normal, normal);
Cartesian2.Cartesian3.normalize(normal, normal);
plane = planes[2];
if (!when.defined(plane)) {
plane = planes[2] = new Transforms.Cartesian4();
}
plane.x = normal.x;
plane.y = normal.y;
plane.z = normal.z;
plane.w = -Cartesian2.Cartesian3.dot(normal, position);
//Top plane computation
Cartesian2.Cartesian3.multiplyByScalar(up, t, normal);
Cartesian2.Cartesian3.add(nearCenter, normal, normal);
Cartesian2.Cartesian3.subtract(normal, position, normal);
Cartesian2.Cartesian3.cross(normal, right, normal);
Cartesian2.Cartesian3.normalize(normal, normal);
plane = planes[3];
if (!when.defined(plane)) {
plane = planes[3] = new Transforms.Cartesian4();
}
plane.x = normal.x;
plane.y = normal.y;
plane.z = normal.z;
plane.w = -Cartesian2.Cartesian3.dot(normal, position);
//Near plane computation
plane = planes[4];
if (!when.defined(plane)) {
plane = planes[4] = new Transforms.Cartesian4();
}
plane.x = direction.x;
plane.y = direction.y;
plane.z = direction.z;
plane.w = -Cartesian2.Cartesian3.dot(direction, nearCenter);
//Far plane computation
Cartesian2.Cartesian3.negate(direction, normal);
plane = planes[5];
if (!when.defined(plane)) {
plane = planes[5] = new Transforms.Cartesian4();
}
plane.