Skip to content

Commit

Permalink
Documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
VCity Github Action committed Aug 29, 2024
1 parent a66a453 commit 9ee2421
Show file tree
Hide file tree
Showing 1,405 changed files with 325,969 additions and 0 deletions.
171 changes: 171 additions & 0 deletions docs/html/backEnd.js.html

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions docs/html/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.method-member-container {
overflow: auto;
}

div.member-item-container {
display: none;
}

.navbar-left-items {
overflow-y: hidden;
overflow-x: scroll !important;
}

.navbar-item {
align-self: center;
overflow: initial !important;
}

.navbar-item a {
text-align: center;
}
1 change: 1 addition & 0 deletions docs/html/data/search.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"list":[{"title":"NODE_ENV","link":"<a href=\"global.html#NODE_ENV\">NODE_ENV</a>","description":"<p>The environment mode.</p>"},{"title":"PORT","link":"<a href=\"global.html#PORT\">PORT</a>"},{"title":"app","link":"<a href=\"global.html#app\">app</a>","description":"<p>Express application instance.</p>"},{"title":"backEnd.js","link":"<a href=\"backEnd.js.html\">backEnd.js</a>","description":"<p>Sets up an Express backend server for examples, serving static files,\nreplacing HTML strings, and enabling a game socket service.\nThe behavior adapts based on the environment mode (NODE_ENV) inject in process.env with cross-env package.\nSee {@link https://nodejs.org/api/process.html#processenv-env}, {@link https://www.npmjs.com/package/cross-env}</p>\n<p>requires {@link https://www.npmjs.com/package/@ud-viz/game_node}\nrequires {@link https://www.npmjs.com/package/@ud-viz/utils_shared}\nrequires {@link https://www.npmjs.com/package/reload}\nrequires {@link https://www.npmjs.com/package/string-replace-middleware}</p>"},{"title":"changeVersionPackageJSON","link":"<a href=\"global.html#changeVersionPackageJSON\">changeVersionPackageJSON</a>","description":"<p>Updates the version number in a package.json file and updates the dependencies\nthat start with &quot;@ud-viz/&quot; to the same version number.</p>"},{"title":"devExamples.js","link":"<a href=\"devExamples.js.html\">devExamples.js</a>","description":"<p>This script executes build and runs the backend script.</p>\n<p>requires {@link https://www.npmjs.com/package/child-process-promise}\nrequires {@link https://nodejs.org/api/child_process.html}</p>"},{"title":"httpServer","link":"<a href=\"global.html#httpServer\">httpServer</a>","description":"<p>The HTTP server instance.</p>"},{"title":"prePublish.js","link":"<a href=\"prePublish.js.html\">prePublish.js</a>","description":"<p>Performs version management tasks within a monorepo:</p>\n<ul>\n<li>Updates package.json files and dependencies to the provided version</li>\n<li>Formats code with prettier</li>\n<li>Executes reset and generates changelog diffs</li>\n</ul>"},{"title":"printExec","link":"<a href=\"global.html#printExec\">printExec</a>","description":"<p>Prints the stdout and stderr of a command execution result.</p>"},{"title":"printExec","link":"<a href=\"global.html#printExec\">printExec</a>","description":"<p>Prints the stdout and stderr of a command execution result.</p>"},{"title":"runBackEnd~child","link":"<a href=\"runBackEnd.html#~child\">child</a>","description":"<p>Spawn a child process to run the 'backEnd.js' script with specific settings.</p>"},{"title":"subStringVersion","link":"<a href=\"global.html#subStringVersion\">subStringVersion</a>","description":"<p>The version split into segments.</p>"},{"title":"version","link":"<a href=\"global.html#version\">version</a>","description":"<p>The version argument provided from the command line.</p>"}]}
61 changes: 61 additions & 0 deletions docs/html/devExamples.js.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

31 changes: 31 additions & 0 deletions docs/html/extensions_3d_tiles_temporal/STLayer.js.html

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/html/extensions_3d_tiles_temporal/STLayer_STLayer.html

Large diffs are not rendered by default.

225 changes: 225 additions & 0 deletions docs/html/extensions_3d_tiles_temporal/STSCircle.js.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

140 changes: 140 additions & 0 deletions docs/html/extensions_3d_tiles_temporal/STSHelix.js.html

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/html/extensions_3d_tiles_temporal/STSHelix_STSHelix.html

Large diffs are not rendered by default.

184 changes: 184 additions & 0 deletions docs/html/extensions_3d_tiles_temporal/STSParabola.js.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

120 changes: 120 additions & 0 deletions docs/html/extensions_3d_tiles_temporal/STSVector.js.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

74 changes: 74 additions & 0 deletions docs/html/extensions_3d_tiles_temporal/STShape.js.html

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/html/extensions_3d_tiles_temporal/STShape_STShape.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions docs/html/extensions_3d_tiles_temporal/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.method-member-container {
overflow: auto;
}

div.member-item-container {
display: none;
}

.navbar-left-items {
overflow-y: hidden;
overflow-x: scroll !important;
}

.navbar-item {
align-self: center;
overflow: initial !important;
}

.navbar-item a {
text-align: center;
}
1 change: 1 addition & 0 deletions docs/html/extensions_3d_tiles_temporal/data/search.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"list":[{"title":"C3DTTemporalBatchTable","link":"<a href=\"C3DTTemporalBatchTable.html\">C3DTTemporalBatchTable</a>","description":"<p>Verifies the integrity and stores the data corresponding to the\nbatch table part of the 3DTiles_temporal extension.</p>"},{"title":"C3DTTemporalBatchTable#getInfoById","link":"<a href=\"C3DTTemporalBatchTable.html#getInfoById\">getInfoById</a>","description":"<p>Returns information for the given batchId.\nCan be used to display information associated with an object\npicked with the mouse for instance.</p>"},{"title":"C3DTTemporalBatchTable#hasInfoForId","link":"<a href=\"C3DTTemporalBatchTable.html#hasInfoForId\">hasInfoForId</a>","description":"<p>Checks that the batch table temporal extension has values for a given\nidentifier.</p>"},{"title":"C3DTTemporalBoundingVolume","link":"<a href=\"C3DTTemporalBoundingVolume.html\">C3DTTemporalBoundingVolume</a>","description":"<p>Verifies the integrity and stores the data corresponding to the\nbounding volume part of the 3DTiles_temporal extension.</p>"},{"title":"C3DTTemporalBoundingVolume#endDate","link":"<a href=\"C3DTTemporalBoundingVolume.html#endDate\">endDate</a>"},{"title":"C3DTTemporalBoundingVolume#startDate","link":"<a href=\"C3DTTemporalBoundingVolume.html#startDate\">startDate</a>"},{"title":"C3DTTemporalPrimaryTransaction","link":"<a href=\"C3DTTemporalPrimaryTransaction.html\">C3DTTemporalPrimaryTransaction</a>"},{"title":"C3DTTemporalPrimaryTransaction#isPrimary","link":"<a href=\"C3DTTemporalPrimaryTransaction.html#isPrimary\">isPrimary</a>","description":"<p>booleans to do so...</p>"},{"title":"C3DTTemporalPrimaryTransaction#type","link":"<a href=\"C3DTTemporalPrimaryTransaction.html#type\">type</a>","description":"<p>Type testing is not reliable in javascript therefore we have to use`</p>"},{"title":"C3DTTemporalTileset","link":"<a href=\"C3DTTemporalTileset.html\">C3DTTemporalTileset</a>","description":"<p>A constructor function that creates a new object.</p>"},{"title":"C3DTTemporalTileset#endDate","link":"<a href=\"C3DTTemporalTileset.html#endDate\">endDate</a>"},{"title":"C3DTTemporalTileset#parseTransactions","link":"<a href=\"C3DTTemporalTileset.html#parseTransactions\">parseTransactions</a>","description":"<p>Parses transactions from a json file and creates primary and aggregated\ntransactions.</p>"},{"title":"C3DTTemporalTileset#startDate","link":"<a href=\"C3DTTemporalTileset.html#startDate\">startDate</a>"},{"title":"C3DTTemporalTileset#temporalVersions","link":"<a href=\"C3DTTemporalTileset.html#temporalVersions\">temporalVersions</a>"},{"title":"C3DTTemporalTileset#transactions","link":"<a href=\"C3DTTemporalTileset.html#transactions\">transactions</a>"},{"title":"C3DTTemporalTileset#versionTransitions","link":"<a href=\"C3DTTemporalTileset.html#versionTransitions\">versionTransitions</a>"},{"title":"C3DTTemporalTransaction","link":"<a href=\"C3DTTemporalTransaction.html\">C3DTTemporalTransaction</a>","description":"<p>The constructor function is a special function that is called when an object is created from a\nclass</p>"},{"title":"C3DTTemporalTransaction#destination","link":"<a href=\"C3DTTemporalTransaction.html#destination\">destination</a>"},{"title":"C3DTTemporalTransaction#endDate","link":"<a href=\"C3DTTemporalTransaction.html#endDate\">endDate</a>"},{"title":"C3DTTemporalTransaction#id","link":"<a href=\"C3DTTemporalTransaction.html#id\">id</a>"},{"title":"C3DTTemporalTransaction#source","link":"<a href=\"C3DTTemporalTransaction.html#source\">source</a>"},{"title":"C3DTTemporalTransaction#startDate","link":"<a href=\"C3DTTemporalTransaction.html#startDate\">startDate</a>"},{"title":"C3DTTemporalTransaction#tags","link":"<a href=\"C3DTTemporalTransaction.html#tags\">tags</a>"},{"title":"C3DTTemporalTransactionAggregate","link":"<a href=\"C3DTTemporalTransactionAggregate.html\">C3DTTemporalTransactionAggregate</a>","description":"<p>It's a constructor for the Aggregate class</p>"},{"title":"C3DTTemporalTransactionAggregate#isAggregate","link":"<a href=\"C3DTTemporalTransactionAggregate.html#isAggregate\">isAggregate</a>","description":"<p>A boolean flag that is used to check if the object is an aggregate.</p>"},{"title":"C3DTTemporalTransactionAggregate#transactions","link":"<a href=\"C3DTTemporalTransactionAggregate.html#transactions\">transactions</a>","description":"<p>Creating an empty object.</p>"},{"title":"C3DTTemporalVersion","link":"<a href=\"C3DTTemporalVersion.html\">C3DTTemporalVersion</a>","description":"<p>It takes a JSON object as input, and returns a JSON object that can be used by the graph window</p>"},{"title":"C3DTTemporalVersion#versions","link":"<a href=\"C3DTTemporalVersion.html#versions\">versions</a>","description":"<p>Assigning the value of the parameter <code>json</code> to the property <code>versions</code> of the object.</p>"},{"title":"STLayer#STLayer","link":"<a href=\"STLayer_STLayer.html\">STLayer</a>"},{"title":"STLayer#dateInterval","link":"<a href=\"STLayer.html#dateInterval\">dateInterval</a>"},{"title":"STLayer#rootObject3D","link":"<a href=\"STLayer.html#rootObject3D\">rootObject3D</a>"},{"title":"STLayer#versions","link":"<a href=\"STLayer.html#versions\">versions</a>"},{"title":"STLayer#view","link":"<a href=\"STLayer.html#view\">view</a>"},{"title":"STSCircle#STSCircle","link":"<a href=\"STSCircle_STSCircle.html\">STSCircle</a>"},{"title":"STSCircle#circleLine","link":"<a href=\"STSCircle.html#circleLine\">circleLine</a>"},{"title":"STSCircle#dashedLine","link":"<a href=\"STSCircle.html#dashedLine\">dashedLine</a>"},{"title":"STSCircle#height","link":"<a href=\"STSCircle.html#height\">height</a>"},{"title":"STSCircle#objectCopies","link":"<a href=\"STSCircle.html#objectCopies\">objectCopies</a>"},{"title":"STSCircle#pause","link":"<a href=\"STSCircle.html#pause\">pause</a>"},{"title":"STSCircle#radius","link":"<a href=\"STSCircle.html#radius\">radius</a>"},{"title":"STSCircle#selectedDate","link":"<a href=\"STSCircle.html#selectedDate\">selectedDate</a>"},{"title":"STSHelix#STSHelix","link":"<a href=\"STSHelix_STSHelix.html\">STSHelix</a>"},{"title":"STSHelix#delta","link":"<a href=\"STSHelix.html#delta\">delta</a>"},{"title":"STSHelix#radius","link":"<a href=\"STSHelix.html#radius\">radius</a>"},{"title":"STSParabola#STSParabola","link":"<a href=\"STSParabola_STSParabola.html\">STSParabola</a>"},{"title":"STSParabola#dashedLine","link":"<a href=\"STSParabola.html#dashedLine\">dashedLine</a>"},{"title":"STSParabola#distAxisX","link":"<a href=\"STSParabola.html#distAxisX\">distAxisX</a>"},{"title":"STSParabola#distAxisY","link":"<a href=\"STSParabola.html#distAxisY\">distAxisY</a>"},{"title":"STSParabola#height","link":"<a href=\"STSParabola.html#height\">height</a>"},{"title":"STSParabola#middleDate","link":"<a href=\"STSParabola.html#middleDate\">middleDate</a>"},{"title":"STSParabola#setSTLayer","link":"<a href=\"STSParabola.html#setSTLayer\">setSTLayer</a>"},{"title":"STSVector#STSVector","link":"<a href=\"STSVector_STSVector.html\">STSVector</a>"},{"title":"STSVector#alpha","link":"<a href=\"STSVector.html#alpha\">alpha</a>"},{"title":"STSVector#delta","link":"<a href=\"STSVector.html#delta\">delta</a>"},{"title":"STShape#STShape","link":"<a href=\"STShape_STShape.html\">STShape</a>"},{"title":"STShape#displayed","link":"<a href=\"STShape.html#displayed\">displayed</a>"},{"title":"STShape#layerCentroid","link":"<a href=\"STShape.html#layerCentroid\">layerCentroid</a>"},{"title":"STShape#setSTLayer","link":"<a href=\"STShape.html#setSTLayer\">setSTLayer</a>"},{"title":"STShape#stLayer","link":"<a href=\"STShape.html#stLayer\">stLayer</a>"},{"title":"Temporal3DTilesLayerWrapper#Temporal3DTilesLayerWrapper","link":"<a href=\"Temporal3DTilesLayerWrapper_Temporal3DTilesLayerWrapper.html\">Temporal3DTilesLayerWrapper</a>","description":"<p>A constructor that initializes a temporal style for a C3DTilesLayer by\ncomputing tile maps based on the <code>3DTILES_temporal</code> batch table hierarchy content found in\nthe tile content.</p>"},{"title":"Temporal3DTilesLayerWrapper#_styleDate","link":"<a href=\"Temporal3DTilesLayerWrapper.html#_styleDate\">_styleDate</a>","description":"<p>date selected TODO: use a Date Object</p>"},{"title":"Temporal3DTilesLayerWrapper#knownDatesForAllTiles","link":"<a href=\"Temporal3DTilesLayerWrapper.html#knownDatesForAllTiles\">knownDatesForAllTiles</a>","description":"<p>all date possible to update style with (ascending order)</p>"},{"title":"Temporal3DTilesLayerWrapper#styleDate","link":"<a href=\"Temporal3DTilesLayerWrapper.html#styleDate\">styleDate</a>","description":"<p>Update temporal 3DTiles layer style with a date</p>"},{"title":"Temporal3DTilesLayerWrapper#temporalC3DTilesLayer","link":"<a href=\"Temporal3DTilesLayerWrapper.html#temporalC3DTilesLayer\">temporalC3DTilesLayer</a>","description":"<p>the layer wrapped</p>"}]}
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading

0 comments on commit 9ee2421

Please sign in to comment.