From 1950e3619e6c0b4956d89d7763f8398149c4b557 Mon Sep 17 00:00:00 2001 From: kovacsv Date: Sat, 14 Jan 2023 22:11:46 +0100 Subject: [PATCH] Update documentation. --- docs/Class_Camera.html | 3 +- docs/Class_EdgeSettings.html | 3 +- docs/Class_EmbeddedViewer.html | 3 +- docs/Class_EnvironmentSettings.html | 3 +- docs/Class_InputFile.html | 3 +- docs/Class_RGBAColor.html | 3 +- docs/Class_RGBColor.html | 3 +- docs/Enum_CameraMode.html | 3 +- docs/Enum_FileSource.html | 3 +- ...ction_Init3DViewerElementFromFileList.html | 98 +++++++++++++++++++ ...ction_Init3DViewerElementFromUrlList.html} | 11 ++- docs/Function_Init3DViewerElements.html | 3 +- docs/Function_SetExternalLibLocation.html | 3 +- docs/Page_ContributionGuidelines.html | 3 +- docs/Page_EnvironmentSetup.html | 3 +- docs/Page_Installation.html | 3 +- docs/Page_Usage.html | 3 +- docs/index.html | 3 +- docs/static/script.js | 2 +- source/engine/main.js | 3 +- source/engine/viewer/embeddedviewer.js | 2 +- 21 files changed, 140 insertions(+), 24 deletions(-) create mode 100644 docs/Function_Init3DViewerElementFromFileList.html rename docs/{Function_Init3DViewerElement.html => Function_Init3DViewerElementFromUrlList.html} (86%) diff --git a/docs/Class_Camera.html b/docs/Class_Camera.html index e69ae86..ad365b9 100644 --- a/docs/Class_Camera.html +++ b/docs/Class_Camera.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Class_EdgeSettings.html b/docs/Class_EdgeSettings.html index 2d6442f..0e7bffe 100644 --- a/docs/Class_EdgeSettings.html +++ b/docs/Class_EdgeSettings.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Class_EmbeddedViewer.html b/docs/Class_EmbeddedViewer.html index 4364739..377274b 100644 --- a/docs/Class_EmbeddedViewer.html +++ b/docs/Class_EmbeddedViewer.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Class_EnvironmentSettings.html b/docs/Class_EnvironmentSettings.html index 36f84c4..060781d 100644 --- a/docs/Class_EnvironmentSettings.html +++ b/docs/Class_EnvironmentSettings.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Class_InputFile.html b/docs/Class_InputFile.html index e0b7241..087f75c 100644 --- a/docs/Class_InputFile.html +++ b/docs/Class_InputFile.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Class_RGBAColor.html b/docs/Class_RGBAColor.html index 0ca4835..b160ec5 100644 --- a/docs/Class_RGBAColor.html +++ b/docs/Class_RGBAColor.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Class_RGBColor.html b/docs/Class_RGBColor.html index 10abb96..c245daa 100644 --- a/docs/Class_RGBColor.html +++ b/docs/Class_RGBColor.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Enum_CameraMode.html b/docs/Enum_CameraMode.html index dcdf375..290b67e 100644 --- a/docs/Enum_CameraMode.html +++ b/docs/Enum_CameraMode.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Enum_FileSource.html b/docs/Enum_FileSource.html index 34f2fab..5d2f727 100644 --- a/docs/Enum_FileSource.html +++ b/docs/Enum_FileSource.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Function_Init3DViewerElementFromFileList.html b/docs/Function_Init3DViewerElementFromFileList.html new file mode 100644 index 0000000..da53321 --- /dev/null +++ b/docs/Function_Init3DViewerElementFromFileList.html @@ -0,0 +1,98 @@ + + + + + + + + + Online 3D Viewer - Init3DViewerElementFromFileList + + + + + + + + + + + +
+

Init3DViewerElementFromFileList

+
+
Init3DViewerElementFromFileList (parentElement, models, parameters)
+
Description
+
Loads the model specified by File objects.
+
Parameters
+
+parentElement +Element +
+
+
The parent element for the viewer canvas.
+
+
+models +File[] +
+
+
File object list of model files.
+
+
+parameters +object +
+
+
See EmbeddedViewer constructor for details.
+
+
Returns
+
+EmbeddedViewer +
+
+ +
+ + + + diff --git a/docs/Function_Init3DViewerElement.html b/docs/Function_Init3DViewerElementFromUrlList.html similarity index 86% rename from docs/Function_Init3DViewerElement.html rename to docs/Function_Init3DViewerElementFromUrlList.html index 48ad5a0..3d4b1fe 100644 --- a/docs/Function_Init3DViewerElement.html +++ b/docs/Function_Init3DViewerElementFromUrlList.html @@ -6,7 +6,7 @@ - Online 3D Viewer - Init3DViewerElement + Online 3D Viewer - Init3DViewerElementFromUrlList @@ -46,7 +46,8 @@
Functions
- + +
@@ -57,9 +58,9 @@
-

Init3DViewerElement

+

Init3DViewerElementFromUrlList

-
Init3DViewerElement (parentElement, modelUrls, parameters)
+
Init3DViewerElementFromUrlList (parentElement, modelUrls, parameters)
Description
Loads the model specified by urls.
Parameters
@@ -91,7 +92,7 @@
- + diff --git a/docs/Function_Init3DViewerElements.html b/docs/Function_Init3DViewerElements.html index 86ecd82..2689fe6 100644 --- a/docs/Function_Init3DViewerElements.html +++ b/docs/Function_Init3DViewerElements.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Function_SetExternalLibLocation.html b/docs/Function_SetExternalLibLocation.html index c5a16e4..1d3c035 100644 --- a/docs/Function_SetExternalLibLocation.html +++ b/docs/Function_SetExternalLibLocation.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Page_ContributionGuidelines.html b/docs/Page_ContributionGuidelines.html index 748ce0f..ec0a374 100644 --- a/docs/Page_ContributionGuidelines.html +++ b/docs/Page_ContributionGuidelines.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Page_EnvironmentSetup.html b/docs/Page_EnvironmentSetup.html index c5ff100..478d918 100644 --- a/docs/Page_EnvironmentSetup.html +++ b/docs/Page_EnvironmentSetup.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Page_Installation.html b/docs/Page_Installation.html index 8048daa..db40ff7 100644 --- a/docs/Page_Installation.html +++ b/docs/Page_Installation.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/Page_Usage.html b/docs/Page_Usage.html index fd0d6bd..5f028de 100644 --- a/docs/Page_Usage.html +++ b/docs/Page_Usage.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/index.html b/docs/index.html index ef00c3f..9d66006 100644 --- a/docs/index.html +++ b/docs/index.html @@ -46,7 +46,8 @@
Functions
- + +
diff --git a/docs/static/script.js b/docs/static/script.js index f4dbd7d..18a005c 100644 --- a/docs/static/script.js +++ b/docs/static/script.js @@ -12,7 +12,7 @@ function Resize () navToggleDiv.style.display = 'block'; navDiv.style.display = 'none'; } else { - let navWidth = '280px'; + let navWidth = '300px'; navDiv.style.width = navWidth; mainDiv.style.marginLeft = navWidth; diff --git a/source/engine/main.js b/source/engine/main.js index 5c6697f..d970355 100644 --- a/source/engine/main.js +++ b/source/engine/main.js @@ -66,7 +66,7 @@ import { ThreeModelLoader } from './threejs/threemodelloader.js'; import { HasHighpDriverIssue, GetShadingType, ConvertThreeColorToColor, ConvertColorToThreeColor, ConvertThreeGeometryToMesh, DisposeThreeObjects, ShadingType } from './threejs/threeutils.js'; import { Camera, CameraIsEqual3D, CameraMode } from './viewer/camera.js'; import { GetIntegerFromStyle, GetDomElementExternalWidth, GetDomElementExternalHeight, GetDomElementInnerDimensions, GetDomElementClientCoordinates, CreateDomElement, AddDomElement, AddDiv, ClearDomElement, InsertDomElementBefore, InsertDomElementAfter, ShowDomElement, IsDomElementVisible, SetDomElementWidth, SetDomElementHeight, GetDomElementOuterWidth, GetDomElementOuterHeight, SetDomElementOuterWidth, SetDomElementOuterHeight, CreateDiv } from './viewer/domutils.js'; -import { EmbeddedViewer, Init3DViewerElementFromUrlList, Init3DViewerElements } from './viewer/embeddedviewer.js'; +import { EmbeddedViewer, Init3DViewerElementFromUrlList, Init3DViewerElementFromFileList, Init3DViewerElements } from './viewer/embeddedviewer.js'; import { MouseInteraction, TouchInteraction, ClickDetector, Navigation, NavigationType } from './viewer/navigation.js'; import { EnvironmentSettings, ShadingModel } from './viewer/shadingmodel.js'; import { CameraValidator, UpVector, Viewer, GetDefaultCamera, TraverseThreeObject, GetShadingTypeOfObject } from './viewer/viewer.js'; @@ -313,6 +313,7 @@ export { CreateDiv, EmbeddedViewer, Init3DViewerElementFromUrlList, + Init3DViewerElementFromFileList, Init3DViewerElements, MouseInteraction, TouchInteraction, diff --git a/source/engine/viewer/embeddedviewer.js b/source/engine/viewer/embeddedviewer.js index a94ae8a..8555459 100644 --- a/source/engine/viewer/embeddedviewer.js +++ b/source/engine/viewer/embeddedviewer.js @@ -230,7 +230,7 @@ export function Init3DViewerElementFromUrlList (parentElement, modelUrls, parame /** * Loads the model specified by File objects. * @param {Element} parentElement The parent element for the viewer canvas. - * @param {File[]} models Model files. + * @param {File[]} models File object list of model files. * @param {object} parameters See {@link EmbeddedViewer} constructor for details. * @returns {EmbeddedViewer} */