Skip to content

Commit

Permalink
Further options- and constructor documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
javagl committed Sep 28, 2024
1 parent 9bfe61a commit 9805652
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
import Check from "../../../../Core/Check.js";

/**
* @typedef {object} AnchorPointDirect.ConstructorOptions
*
* Initialization options for the AnchorPointDirect constructor
*
* @property {Cartesian3} position Anchor point geographic coordinates
* @property {Cartesian3} adjustmentParams The adjustment values in meters
*/

/**
* Metadata for one stored anchor point using direct storage.
*
* This reflects the `anchronPointDirect` definition of the
* {@link https://nsgreg.nga.mil/csmwg.jsp|NGA_gpm_local} glTF extension.
*
* @constructor
* @param {AnchorPointDirect.ConstructorOptions} options An object describing initialization options
* @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
*/
function AnchorPointDirect(options) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
import Check from "../../../../Core/Check.js";

/**
* @typedef {object} AnchorPointIndirect.ConstructorOptions
*
* Initialization options for the AnchorPointIndirect constructor
*
* @property {Cartesian3} position Anchor point geographic coordinates
* @property {Cartesian3} adjustmentParams The adjustment values in meters
* @property {Matrix3} covarianceMatrix The 3x3 covariance matrix
*/

/**
* Metadata for one stored anchor point.
*
* This reflects the `anchronPointIndirect` definition of the
* {@link https://nsgreg.nga.mil/csmwg.jsp|NGA_gpm_local} glTF extension.
*
* @constructor
* @param {AnchorPointIndirect.ConstructorOptions} options An object describing initialization options
* @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
*/
function AnchorPointIndirect(options) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,27 @@
import Check from "../../../../Core/Check.js";

/**
* @typedef {object} CorrelationGroup.ConstructorOptions
*
* Initialization options for the CorrelationGroup constructor
*
* @property {boolean[]} groupFlags Array of 3 booleans indicating if
* parameters delta-x delta-y delta-z used in the correlation group
* @property {Cartesian3} rotationThetas Rotations in milliradians
* about X, Y, Z axes, respectively
* @property {Spdcf[]} params Array of `Spdcf` (Strictly Positive-Definite
* Correlation Function) parameters, for the U, V, W directions, respectively
*/

/**
* Metadata identifying parameters using same correlation modeling and
* associated correlation parameters.
*
* This reflects the `correlationGroup` definition of the
* {@link https://nsgreg.nga.mil/csmwg.jsp|NGA_gpm_local} glTF extension.
*
* @constructor
* @param {CorrelationGroup.ConstructorOptions} options An object describing initialization options
* @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
*/
function CorrelationGroup(options) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ import StorageType from "./StorageType.js";
* </li>
* </ul>
*
* @constructor
* @param {GltfGpmLocal.ConstructorOptions} options An object describing initialization options
*
* @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
*
* @param {PpeTexture[]} ppeTextures The Per-Point Error textures
*
* @constructor
* @private
*/
function MeshPrimitiveGpmLocal(ppeTextures) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import Check from "../../../../Core/Check.js";
* This reflects the `ppeMetadata` definition of the
* {@link https://nsgreg.nga.mil/csmwg.jsp|NGA_gpm_local} glTF extension.
*
* @constructor
* @param {PpeMetadata.ConstructorOptions} options An object describing initialization options
*
* @private
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import Check from "../../../../Core/Check.js";
* and an optional `texCoord)`, with additional properties that
* describe the structure of the metdata that is stored in the texture.
*
* @constructor
* @param {PpeTexture.ConstructorOptions} options An object describing initialization options
*
* @private
Expand Down
13 changes: 13 additions & 0 deletions packages/engine/Source/Scene/Model/Extensions/Gpm/Spdcf.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
import Check from "../../../../Core/Check.js";

/**
* @typedef {object} Spdcf.ConstructorOptions
*
* Initialization options for the Spdcf constructor
*
* @property {number} A The factor A, in (0, 1]
* @property {number} alpha The alpha value, in [0, 1)
* @property {number} beta The beta value, in [0, 10]
* @property {number} T the tau value, in (0, +inf)
*/

/**
* Variables for a Strictly Positive-Definite Correlation Function.
*
Expand All @@ -14,6 +25,8 @@ import Check from "../../../../Core/Check.js";
* spdcf(delta_t) = A_t * (alpha_t + ((1 - alpha_t)(1 + beta_t)) / (beta_t + e^(delta_t/T_t)))
* ```
*
* @constructor
* @param {Spdcf.ConstructorOptions} options An object describing initialization options
* @experimental This feature is not final and is subject to change without Cesium's standard deprecation policy.
*/
function Spdcf(options) {
Expand Down

0 comments on commit 9805652

Please sign in to comment.