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

Improve reference doc for options parameters #1777

Merged
merged 1 commit into from
Jun 3, 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
1 change: 1 addition & 0 deletions Source/Core/ArcGisImageServerTerrainProvider.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ define([
* @alias ArcGisImageServerTerrainProvider
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {String} options.url The URL of the ArcGIS ImageServer service.
* @param {String} [options.token] The authorization token to use to connect to the service.
* @param {Object} [options.proxy] A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/BoxGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ define([
* @alias BoxGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3} options.minimumCorner The minimum x, y, and z coordinates of the box.
* @param {Cartesian3} options.maximumCorner The maximum x, y, and z coordinates of the box.
* @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/CatmullRomSpline.js
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ define([
* @alias CatmullRomSpline
* @constructor
*
* @param {Object} options Object with the following properties:
* @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 {Cartesian3[]} options.points The array of {@link Cartesian3} control points.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/CesiumTerrainProvider.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ define([
* @alias CesiumTerrainProvider
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {String} options.url The URL of the Cesium terrain server.
* @param {Proxy} [options.proxy] A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
* @param {Credit|String} [options.credit] A credit for the data source, which is displayed on the canvas.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/CircleGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ define([
* @alias CircleGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3} options.center The circle's center point in the fixed frame.
* @param {Number} options.radius The radius in meters.
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid the circle will be on.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/CircleOutlineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ define([
* @alias CircleOutlineGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3} options.center The circle's center point in the fixed frame.
* @param {Number} options.radius The radius in meters.
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid the circle will be on.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/Clock.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ define([
* @alias Clock
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {JulianDate} [options.startTime] The start time of the clock.
* @param {JulianDate} [options.stopTime] The stop time of the clock.
* @param {JulianDate} [options.currentTime] The current time.
Expand Down
2 changes: 1 addition & 1 deletion Source/Core/Color.js
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ define([
* call {@link CesiumMath#setRandomNumberSeed} once at the beginning of your application.
* @memberof Color
*
* @param {Object} [options] Object containing the options.
* @param {Object} [options] Object with the following properties:
* @param {Number} [options.red] If specified, the red component to use instead of a randomized value.
* @param {Number} [options.minimumRed=0.0] The maximum red value to generate if none was specified.
* @param {Number} [options.maximumRed=1.0] The minimum red value to generate if none was specified.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/CorridorGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,7 @@ define([
* @alias CorridorGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3[]} options.positions An array of 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.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/CorridorOutlineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,7 @@ define([
* @alias CorridorOutlineGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3[]} options.positions An array of 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.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/CylinderGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ define([
* @alias CylinderGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Number} options.length The length of the cylinder.
* @param {Number} options.topRadius The radius of the top of the cylinder.
* @param {Number} options.bottomRadius The radius of the bottom of the cylinder.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/CylinderOutlineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ define([
* @alias CylinderOutlineGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Number} options.length The length of the cylinder.
* @param {Number} options.topRadius The radius of the top of the cylinder.
* @param {Number} options.bottomRadius The radius of the bottom of the cylinder.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/EarthOrientationParameters.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ define([
* @alias EarthOrientationParameters
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {String} [options.url] The URL from which to obtain EOP data. If neither this
* parameter nor options.data is specified, all EOP values are assumed
* to be 0.0. If options.data is specified, this parameter is
Expand Down
1 change: 1 addition & 0 deletions Source/Core/EllipseGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -571,6 +571,7 @@ define([
* @alias EllipseGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3} options.center The ellipse's center point in the fixed frame.
* @param {Number} options.semiMajorAxis The length of the ellipse's semi-major axis in meters.
* @param {Number} options.semiMinorAxis The length of the ellipse's semi-minor axis in meters.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/EllipseOutlineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ define([
* @alias EllipseOutlineGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3} options.center The ellipse's center point in the fixed frame.
* @param {Number} options.semiMajorAxis The length of the ellipse's semi-major axis in meters.
* @param {Number} options.semiMinorAxis The length of the ellipse's semi-minor axis in meters.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/EllipsoidGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ define([
* @alias EllipsoidGeometry
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {Cartesian3} [options.radii=Cartesian3(1.0, 1.0, 1.0)] The radii of the ellipsoid in the x, y, and z directions.
* @param {Number} [options.stackPartitions=64] The number of times to partition the ellipsoid into stacks.
* @param {Number} [options.slicePartitions=64] The number of times to partition the ellipsoid into radial slices.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/EllipsoidOutlineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ define([
* @alias EllipsoidOutlineGeometry
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {Cartesian3} [options.radii=Cartesian3(1.0, 1.0, 1.0)] The radii of the ellipsoid in the x, y, and z directions.
* @param {Number} [options.stackPartitions=10] The count of stacks for the ellipsoid (1 greater than the number of parallel lines).
* @param {Number} [options.slicePartitions=8] The count of slices for the ellipsoid (Equal to the number of radial lines).
Expand Down
1 change: 1 addition & 0 deletions Source/Core/EllipsoidTerrainProvider.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ define([
* @alias EllipsoidTerrainProvider
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {TilingScheme} [options.tilingScheme] The tiling scheme specifying how the ellipsoidal
* surface is broken into tiles. If this parameter is not provided, a {@link GeographicTilingScheme}
* is used.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/GeographicTilingScheme.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ define([
* @alias GeographicTilingScheme
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid whose surface is being tiled. Defaults to
* the WGS84 ellipsoid.
* @param {Rectangle} [options.rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the tiling scheme.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/Geometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ define([
* @alias Geometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {GeometryAttributes} options.attributes Attributes, which make up the geometry's vertices.
* @param {PrimitiveType} options.primitiveType The type of primitives in the geometry.
* @param {Uint16Array|Uint32Array} [options.indices] Optional index data that determines the primitives in the geometry.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/GeometryAttribute.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ define([
* @alias GeometryAttribute
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {ComponentDatatype} [options.componentDatatype] The datatype of each component in the attribute, e.g., individual elements in values.
* @param {Number} [options.componentsPerAttribute] A number between 1 and 4 that defines the number of components in an attributes.
* @param {Boolean} [options.normalize=false] When <code>true</code> and <code>componentDatatype</code> is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/GeometryInstance.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ define([
* @alias GeometryInstance
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Geometry} options.geometry The geometry to instance.
* @param {Matrix4} [options.modelMatrix=Matrix4.IDENTITY] The model matrix that transforms to transform the geometry from model to world coordinates.
* @param {Object} [options.id] A user-defined object to return when the instance is picked with {@link Scene#pick} or get/set per-instance attributes with {@link Primitive#getGeometryInstanceAttributes}.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/GeometryInstanceAttribute.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ define([
* @alias GeometryInstanceAttribute
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {ComponentDatatype} [options.componentDatatype] The datatype of each component in the attribute, e.g., individual elements in values.
* @param {Number} [options.componentsPerAttribute] A number between 1 and 4 that defines the number of components in an attributes.
* @param {Boolean} [options.normalize=false] When <code>true</code> and <code>componentDatatype</code> is an integer format, indicate that the components should be mapped to the range [0, 1] (unsigned) or [-1, 1] (signed) when they are accessed as floating-point for rendering.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/HeightmapTerrainData.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ define([
* @alias HeightmapTerrainData
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {TypedArray} options.buffer The buffer containing height data.
* @param {Number} options.width The width (longitude direction) of the heightmap, in samples.
* @param {Number} options.height The height (latitude direction) of the heightmap, in samples.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/HeightmapTessellator.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ define([
*
* @memberof HeightmapTessellator
*
* @param {Object} options Object with the following properties:
* @param {Array|Float32Array} options.vertices The array to use to store computed vertices.
* If options.skirtHeight is 0.0, the array should have
* options.width * options.height * 6 elements. If
Expand Down
1 change: 1 addition & 0 deletions Source/Core/HermiteSpline.js
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ define([
* @alias HermiteSpline
* @constructor
*
* @param {Object} options Object with the following properties:
* @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 {Cartesian3[]} options.points The array of {@link Cartesian3} control points.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/Iau2006XysData.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ define([
* @alias Iau2006XysData
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {String} [options.xysFileUrlTemplate='Assets/IAU2006_XYS/IAU2006_XYS_{0}.json'] A template URL for obtaining the XYS data. In the template,
* `{0}` will be replaced with the file index.
* @param {Number} [options.interpolationOrder=9] The order of interpolation to perform on the XYS data.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/PolygonGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,7 @@ define([
* @alias PolygonGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Object} options.polygonHierarchy A polygon hierarchy that can include holes.
* @param {Number} [options.height=0.0] The height of the polygon.
* @param {Number} [options.extrudedHeight] The height of the polygon.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/PolygonOutlineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ define([
* @alias PolygonOutlineGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Object} options.polygonHierarchy A polygon hierarchy that can include holes.
* @param {Number} [options.height=0.0] The height of the polygon.
* @param {Number} [options.extrudedHeight] The height of the polygon.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/PolylineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ define([
* @alias PolylineGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3[]} options.positions An array of {@link Cartesian3} defining the positions in the polyline as a line strip.
* @param {Number} [options.width=1.0] The width in pixels.
* @param {Color[]} [options.colors] An Array of {@link Color} defining the per vertex or per segment colors.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/PolylineVolumeGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ define([
* @alias PolylineVolumeGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3[]} options.polylinePositions An array of {@link Cartesain3} positions that define the center of the polyline volume.
* @param {Number} options.shapePositions An array of {@link Cartesian2} positions that define the shape to be extruded along the polyline
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/PolylineVolumeOutlineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ define([
* @alias PolylineVolumeOutlineGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3[]} options.polylinePositions An array of positions that define the center of the polyline volume.
* @param {Number} options.shapePositions An array of positions that define the shape to be extruded along the polyline
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid to be used as a reference.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/QuantizedMeshTerrainData.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ define([
* @alias QuantizedMeshTerrainData
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Uint16Array} options.quantizedVertices The buffer containing the quantized mesh.
* @param {Uint16Array} options.indices The indices specifying how the quantized vertices are linked
* together into triangles. Each three indices specifies one triangle.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/QuaternionSpline.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ define([
* @alias QuaternionSpline
* @constructor
*
* @param {Object} options Object with the following properties:
* @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 {Quaternion[]} options.points The array of {@link Quaternion} control points.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/RectangleGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -621,6 +621,7 @@ define([
* @alias RectangleGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Rectangle} options.rectangle A cartographic rectangle with north, south, east and west properties in radians.
* @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed.
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle lies.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/RectangleOutlineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,7 @@ define([
* @alias RectangleOutlineGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Rectangle} options.rectangle A cartographic rectangle with north, south, east and west properties in radians.
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid on which the rectangle lies.
* @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
1 change: 1 addition & 0 deletions Source/Core/SimplePolylineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ define([
* @alias SimplePolylineGeometry
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {Cartesian3[]} options.positions An array of {@link Cartesian3} defining the positions in the polyline as a line strip.
* @param {Color[]} [options.colors] An Array of {@link Color} defining the per vertex or per segment colors.
* @param {Boolean} [options.colorsPerVertex=false] A boolean that determines whether the colors will be flat across each segment of the line or interpolated across the vertices.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/SphereGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ define([
* @alias SphereGeometry
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {Number} [options.radius=1.0] The radius of the sphere.
* @param {Number} [options.stackPartitions=64] The number of times to partition the ellipsoid into stacks.
* @param {Number} [options.slicePartitions=64] The number of times to partition the ellipsoid into radial slices.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/SphereOutlineGeometry.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ define([
* @alias SphereOutlineGeometry
* @constructor
*
* @param {Object} [options] Object with the following properties:
* @param {Number} [options.radius=1.0] The radius of the sphere.
* @param {Number} [options.stackPartitions=10] The count of stacks for the sphere (1 greater than the number of parallel lines).
* @param {Number} [options.slicePartitions=8] The count of slices for the sphere (Equal to the number of radial lines).
Expand Down
1 change: 1 addition & 0 deletions Source/Core/Tipsify.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ define([
/**
* Calculates the average cache miss ratio (ACMR) for a given set of indices.
*
* @param {Object} options Object with the following properties:
* @param {Number[]} options.indices Lists triads of numbers corresponding to the indices of the vertices
* in the vertex buffer that define the geometry's triangles.
* @param {Number} [options.maximumIndex] The maximum value of the elements in <code>args.indices</code>.
Expand Down
1 change: 1 addition & 0 deletions Source/Core/VRTheWorldTerrainProvider.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ define([
* @alias VRTheWorldTerrainProvider
* @constructor
*
* @param {Object} options Object with the following properties:
* @param {String} options.url The URL of the VR-TheWorld TileMap.
* @param {Object} [options.proxy] A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
* @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid. If this parameter is not
Expand Down
Loading