Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue1434 #1729

Merged
merged 6 commits into from
May 21, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Source/Core/AxisAlignedBoundingBox.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ define([
* finding the points spaced the farthest apart on the x, y, and z axes.
* @memberof AxisAlignedBoundingBox
*
* @param {Array} positions List of points that the bounding box will enclose. Each point must have a <code>x</code>, <code>y</code>, and <code>z</code> properties.
* @param {Cartesian3[]} positions List of points that the bounding box will enclose. Each point must have a <code>x</code>, <code>y</code>, and <code>z</code> properties.
* @param {AxisAlignedBoundingBox} [result] The object onto which to store the result.
* @returns {AxisAlignedBoundingBox} The modified result parameter or a new AxisAlignedBoundingBox instance if one was not provided.
*
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/BoundingRectangle.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ define([
* The rectangle is oriented with the corner at the bottom left.
* @memberof BoundingRectangle
*
* @param {Array} positions List of points that the bounding rectangle will enclose. Each point must have <code>x</code> and <code>y</code> properties.
* @param {Cartesian2[]} positions List of points that the bounding rectangle will enclose. Each point must have <code>x</code> and <code>y</code> properties.
* @param {BoundingRectangle} [result] The object onto which to store the result.
* @returns {BoundingRectangle} The modified result parameter or a new BoundingRectangle instance if one was not provided.
*/
Expand Down
8 changes: 4 additions & 4 deletions Source/Core/BoundingSphere.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ define([
* Ritter's algorithm. The smaller of the two spheres is used to ensure a tight fit.
* @memberof BoundingSphere
*
* @param {Array} positions An array of points that the bounding sphere will enclose. Each point must have <code>x</code>, <code>y</code>, and <code>z</code> properties.
* @param {Cartesian3[]} positions An array of points that the bounding sphere will enclose. Each point must have <code>x</code>, <code>y</code>, and <code>z</code> properties.
* @param {BoundingSphere} [result] The object onto which to store the result.
* @returns {BoundingSphere} The modified result parameter or a new BoundingSphere instance if one was not provided.
*
Expand Down Expand Up @@ -312,7 +312,7 @@ define([
*
* @memberof BoundingSphere
*
* @param {Array} positions An array of points that the bounding sphere will enclose. Each point
* @param {Cartesian3[]} positions An array of points that the bounding sphere will enclose. Each point
* is formed from three elements in the array in the order X, Y, Z.
* @param {Cartesian3} [center=Cartesian3.ZERO] The position to which the positions are relative, which need not be the
* origin of the coordinate system. This is useful when the positions are to be used for
Expand Down Expand Up @@ -586,7 +586,7 @@ define([
* @memberof BoundingSphere
*
* @param {BoundingSphere} value The value to pack.
* @param {Array} array The array to pack into.
* @param {Number[]} array The array to pack into.
* @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
*/
BoundingSphere.pack = function(value, array, startingIndex) {
Expand All @@ -613,7 +613,7 @@ define([
* Retrieves an instance from a packed array.
* @memberof BoundingSphere
*
* @param {Array} array The packed array.
* @param {Number[]} array The packed array.
* @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
* @param {Cartesian3} [result] The object into which to store the result.
*/
Expand Down
6 changes: 3 additions & 3 deletions Source/Core/Cartesian2.js
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ define([
* @memberof Cartesian2
*
* @param {Cartesian2} value The value to pack.
* @param {Array} array The array to pack into.
* @param {Number[]} array The array to pack into.
* @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
*/
Cartesian2.pack = function(value, array, startingIndex) {
Expand All @@ -138,7 +138,7 @@ define([
* Retrieves an instance from a packed array.
* @memberof Cartesian2
*
* @param {Array} array The packed array.
* @param {Number[]} array The packed array.
* @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
* @param {Cartesian2} [result] The object into which to store the result.
*/
Expand All @@ -163,7 +163,7 @@ define([
* Creates a Cartesian2 from two consecutive elements in an array.
* @memberof Cartesian2
*
* @param {Array} array The array whose two consecutive elements correspond to the x and y components, respectively.
* @param {Number[]} array The array whose two consecutive elements correspond to the x and y components, respectively.
* @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component.
* @param {Cartesian2} [result] The object onto which to store the result.
*
Expand Down
22 changes: 11 additions & 11 deletions Source/Core/Cartesian3.js
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ define([
* @memberof Cartesian3
*
* @param {Cartesian3} value The value to pack.
* @param {Array} array The array to pack into.
* @param {Number[]} array The array to pack into.
* @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
*/
Cartesian3.pack = function(value, array, startingIndex) {
Expand All @@ -168,7 +168,7 @@ define([
* Retrieves an instance from a packed array.
* @memberof Cartesian3
*
* @param {Array} array The packed array.
* @param {Number[]} array The packed array.
* @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
* @param {Cartesian3} [result] The object into which to store the result.
*/
Expand All @@ -194,7 +194,7 @@ define([
* Creates a Cartesian3 from three consecutive elements in an array.
* @memberof Cartesian3
*
* @param {Array} array The array whose three consecutive elements correspond to the x, y, and z components, respectively.
* @param {Number[]} array The array whose three consecutive elements correspond to the x, y, and z components, respectively.
* @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component.
* @param {Cartesian3} [result] The object onto which to store the result.
*
Expand Down Expand Up @@ -846,9 +846,9 @@ define([
* Returns an array of Cartesian3 positions given an array of longitude and latitude values given in degrees.
* @memberof Cartesian3
*
* @param {Array} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...].
* @param {Number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...].
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the coordinates lie.
* @param {Array} [result] An array of Cartesian3 objects to store the result.
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
*
* @returns {Cartesian3[]} The array of positions.
*
Expand All @@ -874,9 +874,9 @@ define([
* Returns an array of Cartesian3 positions given an array of longitude and latitude values given in radians.
* @memberof Cartesian3
*
* @param {Array} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...].
* @param {Number[]} coordinates A list of longitude and latitude values. Values alternate [longitude, latitude, longitude, latitude...].
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the coordinates lie.
* @param {Array} [result] An array of Cartesian3 objects to store the result.
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
*
* @returns {Cartesian3[]} The array of positions.
*
Expand Down Expand Up @@ -916,9 +916,9 @@ define([
* Returns an array of Cartesian3 positions given an array of longitude, latitude and height values where longitude and latitude are given in degrees.
* @memberof Cartesian3
*
* @param {Array} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...].
* @param {Number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...].
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies.
* @param {Array} [result] An array of Cartesian3 objects to store the result.
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
*
* @returns {Cartesian3[]} The array of positions.
*
Expand Down Expand Up @@ -952,9 +952,9 @@ define([
* Returns an array of Cartesian3 positions given an array of longitude, latitude and height values where longitude and latitude are given in radians.
* @memberof Cartesian3
*
* @param {Array} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...].
* @param {Number[]} coordinates A list of longitude, latitude and height values. Values alternate [longitude, latitude, height,, longitude, latitude, height...].
* @param {Ellipsoid} [ellipsoid = Ellipsoid.WGS84] The ellipsoid on which the position lies.
* @param {Array} [result] An array of Cartesian3 objects to store the result.
* @param {Cartesian3[]} [result] An array of Cartesian3 objects to store the result.
*
* @returns {Cartesian3[]} The array of positions.
*
Expand Down
6 changes: 3 additions & 3 deletions Source/Core/Cartesian4.js
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ define([
* @memberof Cartesian4
*
* @param {Cartesian4} value The value to pack.
* @param {Array} array The array to pack into.
* @param {Number[]} array The array to pack into.
* @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
*/
Cartesian4.pack = function(value, array, startingIndex) {
Expand All @@ -167,7 +167,7 @@ define([
* Retrieves an instance from a packed array.
* @memberof Cartesian4
*
* @param {Array} array The packed array.
* @param {Number[]} array The packed array.
* @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
* @param {Cartesian4} [result] The object into which to store the result.
*/
Expand Down Expand Up @@ -196,7 +196,7 @@ define([
* Creates a Cartesian4 from four consecutive elements in an array.
* @memberof Cartesian4
*
* @param {Array} array The array whose four consecutive elements correspond to the x, y, z, and w components, respectively.
* @param {Number[]} array The array whose four consecutive elements correspond to the x, y, z, and w components, respectively.
* @param {Number} [startingIndex=0] The offset into the array of the first element, which corresponds to the x component.
* @param {Cartesian4} [result] The object onto which to store the result.
*
Expand Down
8 changes: 4 additions & 4 deletions Source/Core/CatmullRomSpline.js
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,9 @@ define([
* @alias CatmullRomSpline
* @constructor
*
* @param {Array} options.times An array of strictly increasing, unit-less, floating-point times at each point.
* @param {Number[]} options.times An array of strictly increasing, unit-less, floating-point times at each point.
* The values are in no way connected to the clock time. They are the parameterization for the curve.
* @param {Array} options.points The array of {@link Cartesian3} control points.
* @param {Cartesian3[]} options.points The array of {@link Cartesian3} control points.
* @param {Cartesian3} [options.firstTangent] The tangent of the curve at the first control point.
* If the tangent is not given, it will be estimated.
* @param {Cartesian3} [options.lastTangent] The tangent of the curve at the last control point.
Expand Down Expand Up @@ -191,7 +191,7 @@ define([
*
* @memberof CatmullRomSpline.prototype
*
* @type {Array}
* @type {Number[]}
* @readonly
*/
times : {
Expand All @@ -205,7 +205,7 @@ define([
*
* @memberof CatmullRomSpline.prototype
*
* @type {Array}
* @type {Cartesian3[]}
* @readonly
*/
points : {
Expand Down
8 changes: 4 additions & 4 deletions Source/Core/Color.js
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ define([
* @memberof Color
*
* @param {Color} value The value to pack.
* @param {Array} array The array to pack into.
* @param {Number[]} array The array to pack into.
* @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
*/
Color.pack = function(value, array, startingIndex) {
Expand All @@ -406,7 +406,7 @@ define([
* Retrieves an instance from a packed array.
* @memberof Color
*
* @param {Array} array The packed array.
* @param {Number[]} array The packed array.
* @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
* @param {Color} [result] The object into which to store the result.
*/
Expand Down Expand Up @@ -563,8 +563,8 @@ define([
* that are in the range of 0 to 255.
* @memberof Color
*
* @param {Array} [result] The array to store the result in, if undefined a new instance will be created.
* @returns {Array} The modified result parameter or a new instance if result was undefined.
* @param {Number[]} [result] The array to store the result in, if undefined a new instance will be created.
* @returns {Number[]} The modified result parameter or a new instance if result was undefined.
*/
Color.prototype.toBytes = function(result) {
var red = Color.floatToByte(this.red);
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/CorridorGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@ define([
* @alias CorridorGeometry
* @constructor
*
* @param {Array} options.positions An array of {Cartesain3} positions that define the center of the corridor.
* @param {Cartesian3[]} options.positions An array of {Cartesain3} positions that define the center of the corridor.
* @param {Number} options.width The distance between the edges of the corridor in meters.
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference.
* @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/CorridorOutlineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ define([
* @alias CorridorOutlineGeometry
* @constructor
*
* @param {Array} options.positions An array of {Cartesain3} positions that define the center of the corridor outline.
* @param {Cartesian3[]} options.positions An array of {Cartesain3} positions that define the center of the corridor outline.
* @param {Number} options.width The distance between the edges of the corridor outline.
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference.
* @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/CubicRealPolynomial.js
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ define([
* @param {Number} b The coefficient of the 2nd order monomial.
* @param {Number} c The coefficient of the 1st order monomial.
* @param {Number} d The coefficient of the 0th order monomial.
* @returns {Array} The real valued roots.
* @returns {Number[]} The real valued roots.
*/
CubicRealPolynomial.realRoots = function(a, b, c, d) {
//>>includeStart('debug', pragmas.debug);
Expand Down
18 changes: 9 additions & 9 deletions Source/Core/Ellipsoid.js
Original file line number Diff line number Diff line change
Expand Up @@ -319,9 +319,9 @@ define([
* Converts the provided array of cartographics to an array of Cartesians.
* @memberof Ellipsoid
*
* @param {Array} cartographics An array of cartographic positions.
* @param {Array} [result] The object onto which to store the result.
* @returns {Array} The modified result parameter or a new Array instance if none was provided.
* @param {Cartographic[]} cartographics An array of cartographic positions.
* @param {Cartesian3[]} [result] The object onto which to store the result.
* @returns {Cartesian3[]} The modified result parameter or a new Array instance if none was provided.
*
* @example
* //Convert an array of Cartographics and determine their Cartesian representation on a WGS84 ellipsoid.
Expand Down Expand Up @@ -395,15 +395,15 @@ define([
* Converts the provided array of cartesians to an array of cartographics.
* @memberof Ellipsoid
*
* @param {Array} cartesians An array of Cartesian positions.
* @param {Array} [result] The object onto which to store the result.
* @returns {Array} The modified result parameter or a new Array instance if none was provided.
* @param {Cartesian3[]} cartesians An array of Cartesian positions.
* @param {Cartographic[]} [result] The object onto which to store the result.
* @returns {Cartographic[]} The modified result parameter or a new Array instance if none was provided.
*
* @example
* //Create an array of Cartesians and determine their Cartographic representation on a WGS84 ellipsoid.
* var positions = [new Cesium.Cartesian(17832.12, 83234.52, 952313.73),
* new Cesium.Cartesian(17832.13, 83234.53, 952313.73),
* new Cesium.Cartesian(17832.14, 83234.54, 952313.73)]
* var positions = [new Cesium.Cartesian3(17832.12, 83234.52, 952313.73),
* new Cesium.Cartesian3(17832.13, 83234.53, 952313.73),
* new Cesium.Cartesian3(17832.14, 83234.54, 952313.73)]
* var cartographicPositions = Cesium.Ellipsoid.WGS84.cartesianArrayToCartographicArray(positions);
*/
Ellipsoid.prototype.cartesianArrayToCartographicArray = function(cartesians, result) {
Expand Down
12 changes: 6 additions & 6 deletions Source/Core/EllipsoidTangentPlane.js
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,9 @@ define([
* Computes the projection of the provided 3D positions onto the 2D plane.
* @memberof EllipsoidTangentPlane
*
* @param {Array} cartesians The array of points to project.
* @param {Array} [result] The array of Cartesian2 instances onto which to store results.
* @returns {Array} The modified result parameter or a new array of Cartesian2 instances if none was provided.
* @param {Cartesian3[]} cartesians The array of points to project.
* @param {Cartesian2[]} [result] The array of Cartesian2 instances onto which to store results.
* @returns {Cartesian2[]} The modified result parameter or a new array of Cartesian2 instances if none was provided.
*/
EllipsoidTangentPlane.prototype.projectPointsOntoPlane = function(cartesians, result) {
//>>includeStart('debug', pragmas.debug);
Expand Down Expand Up @@ -192,9 +192,9 @@ define([
* Computes the projection of the provided 2D positions onto the 3D ellipsoid.
* @memberof EllipsoidTangentPlane
*
* @param {Array} cartesians The array of points to project.
* @param {Array} [result] The array of Cartesian3 instances onto which to store results.
* @returns {Array} The modified result parameter or a new array of Cartesian3 instances if none was provided.
* @param {Cartesian2[]} cartesians The array of points to project.
* @param {Cartesian3[]} [result] The array of Cartesian3 instances onto which to store results.
* @returns {Cartesian3[]} The modified result parameter or a new array of Cartesian3 instances if none was provided.
*/
EllipsoidTangentPlane.prototype.projectPointsOntoEllipsoid = function(cartesians, result) {
//>>includeStart('debug', pragmas.debug);
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/EncodedCartesian3.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ define([
* </p>
*
* @param {Cartesian3} cartesian The cartesian to encode.
* @param {Array} cartesianArray The array to write to.
* @param {Number[]} cartesianArray The array to write to.
* @param {Number} index The index into the array to start writing. Six elements will be written.
*
* @exception {DeveloperError} index must be a number greater than or equal to 0.
Expand Down
Loading