Doni/ModelHandle
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor documentation generation.

Browse Source
This commit is contained in:
kovacsv 2023-01-14 21:58:59 +01:00
parent 126efef9fe
commit b9d8122525
29 changed files with 812 additions and 747 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/Camera.html → docs/Class_Camera.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
@ -60,9 +60,9 @@
<h1>Camera</h1>
<div class="description">Camera object.</div>
<h2>Constructor</h2>
<div class="method_container">
<div id="Camera" class="method_signature">new Camera (eye, center, up, fov)</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="Camera" class="function_signature">new Camera (eye, center, up, fov)</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">eye</span>
<span class="type parameter_type">Coord3D</span>
@ -93,13 +93,13 @@
</div>
</div>
<h2>Methods</h2>
<div class="method_container">
<div id="Clone" class="method_signature">Clone ()</div>
<div class="method_title">Description</div>
<div class="method_description">Creates a clone of the object.</div>
<div class="method_title">Returns</div>
<div class="method_returns">
<span class="type parameter_type"><a href="Camera.html" target="_self">Camera</a></span>
<div class="function_container">
<div id="Clone" class="function_signature">Clone ()</div>
<div class="function_title">Description</div>
<div class="function_description">Creates a clone of the object.</div>
<div class="function_title">Returns</div>
<div class="function_returns">
<span class="type parameter_type"><a href="Class_Camera.html" target="_self">Camera</a></span>
</div>
</div>

54
docs/EdgeSettings.html → docs/Class_EdgeSettings.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
@ -60,9 +60,9 @@
<h1>EdgeSettings</h1>
<div class="description">Edge settings object.</div>
<h2>Constructor</h2>
<div class="method_container">
<div id="EdgeSettings" class="method_signature">new EdgeSettings (showEdges, edgeColor, edgeThreshold)</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="EdgeSettings" class="function_signature">new EdgeSettings (showEdges, edgeColor, edgeThreshold)</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">showEdges</span>
<span class="type parameter_type">boolean</span>
@ -72,7 +72,7 @@
</div>
<div class="parameter_header">
<span class="parameter_name">edgeColor</span>
<span class="type parameter_type"><a href="RGBColor.html" target="_self">RGBColor</a></span>
<span class="type parameter_type"><a href="Class_RGBColor.html" target="_self">RGBColor</a></span>
</div>
<div class="parameter_main">
<div class="parameter_description">Color of the edges.</div>
@ -86,13 +86,13 @@
</div>
</div>
<h2>Methods</h2>
<div class="method_container">
<div id="Clone" class="method_signature">Clone ()</div>
<div class="method_title">Description</div>
<div class="method_description">Creates a clone of the object.</div>
<div class="method_title">Returns</div>
<div class="method_returns">
<span class="type parameter_type"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></span>
<div class="function_container">
<div id="Clone" class="function_signature">Clone ()</div>
<div class="function_title">Description</div>
<div class="function_description">Creates a clone of the object.</div>
<div class="function_title">Returns</div>
<div class="function_returns">
<span class="type parameter_type"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></span>
</div>
</div>

122
docs/EmbeddedViewer.html → docs/Class_EmbeddedViewer.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
@ -60,9 +60,9 @@
<h1>EmbeddedViewer</h1>
<div class="description">This is the main object for embedding the viewer on a website.</div>
<h2>Constructor</h2>
<div class="method_container">
<div id="EmbeddedViewer" class="method_signature">new EmbeddedViewer (parentElement, parameters)</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="EmbeddedViewer" class="function_signature">new EmbeddedViewer (parentElement, parameters)</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">parentElement</span>
<span class="type parameter_type">Element</span>
@ -78,7 +78,7 @@
<div class="parameter_description">Parameters for embedding.</div>
<div class="parameter_header">
<span class="parameter_name">camera</span>
<span class="type parameter_type"><a href="Camera.html" target="_self">Camera</a></span>
<span class="type parameter_type"><a href="Class_Camera.html" target="_self">Camera</a></span>
<span class="parameter_attributes">(optional)</span>
</div>
<div class="parameter_main">
@ -86,7 +86,7 @@
</div>
<div class="parameter_header">
<span class="parameter_name">cameraMode</span>
<span class="type parameter_type"><a href="CameraMode.html" target="_self">CameraMode</a></span>
<span class="type parameter_type"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></span>
<span class="parameter_attributes">(optional)</span>
</div>
<div class="parameter_main">
@ -94,7 +94,7 @@
</div>
<div class="parameter_header">
<span class="parameter_name">backgroundColor</span>
<span class="type parameter_type"><a href="RGBAColor.html" target="_self">RGBAColor</a></span>
<span class="type parameter_type"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></span>
<span class="parameter_attributes">(optional)</span>
</div>
<div class="parameter_main">
@ -102,7 +102,7 @@
</div>
<div class="parameter_header">
<span class="parameter_name">defaultColor</span>
<span class="type parameter_type"><a href="RGBColor.html" target="_self">RGBColor</a></span>
<span class="type parameter_type"><a href="Class_RGBColor.html" target="_self">RGBColor</a></span>
<span class="parameter_attributes">(optional)</span>
</div>
<div class="parameter_main">
@ -110,7 +110,7 @@
</div>
<div class="parameter_header">
<span class="parameter_name">edgeSettings</span>
<span class="type parameter_type"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></span>
<span class="type parameter_type"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></span>
<span class="parameter_attributes">(optional)</span>
</div>
<div class="parameter_main">
@ -118,7 +118,7 @@
</div>
<div class="parameter_header">
<span class="parameter_name">environmentSettings</span>
<span class="type parameter_type"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></span>
<span class="type parameter_type"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></span>
<span class="parameter_attributes">(optional)</span>
</div>
<div class="parameter_main">
@ -135,11 +135,11 @@
</div>
</div>
<h2>Methods</h2>
<div class="method_container">
<div id="LoadModelFromUrlList" class="method_signature">LoadModelFromUrlList (modelUrls)</div>
<div class="method_title">Description</div>
<div class="method_description">Loads the model based on a list of urls. The list must contain the main model file and all of the referenced files. For example in case of an obj file the list must contain the corresponding mtl and texture files, too.</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="LoadModelFromUrlList" class="function_signature">LoadModelFromUrlList (modelUrls)</div>
<div class="function_title">Description</div>
<div class="function_description">Loads the model based on a list of urls. The list must contain the main model file and all of the referenced files. For example in case of an obj file the list must contain the corresponding mtl and texture files, too.</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">modelUrls</span>
<span class="type parameter_type">string[]</span>
@ -148,11 +148,11 @@
<div class="parameter_description">Url list of model files.</div>
</div>
</div>
<div class="method_container">
<div id="LoadModelFromFileList" class="method_signature">LoadModelFromFileList (fileList)</div>
<div class="method_title">Description</div>
<div class="method_description">Loads the model based on a list of <a href="https://developer.mozilla.org/en-US/docs/Web/API/File" target="_blank">File</a> objects. The list must contain the main model file and all of the referenced files. You must use this method when you are using a file picker or drag and drop to select files from a computer.</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="LoadModelFromFileList" class="function_signature">LoadModelFromFileList (fileList)</div>
<div class="function_title">Description</div>
<div class="function_description">Loads the model based on a list of <a href="https://developer.mozilla.org/en-US/docs/Web/API/File" target="_blank">File</a> objects. The list must contain the main model file and all of the referenced files. You must use this method when you are using a file picker or drag and drop to select files from a computer.</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">fileList</span>
<span class="type parameter_type"><a href="https://developer.mozilla.org/en-US/docs/Web/API/File" target="_blank">File</a>[]</span>
@ -161,46 +161,46 @@
<div class="parameter_description">File object list of model files.</div>
</div>
</div>
<div class="method_container">
<div id="LoadModelFromInputFiles" class="method_signature">LoadModelFromInputFiles (inputFiles)</div>
<div class="method_title">Description</div>
<div class="method_description">Loads the model based on a list of <a href="InputFile.html" target="_self">InputFile</a> objects. This method is used internally, you should use LoadModelFromUrlList or LoadModelFromFileList instead.</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="LoadModelFromInputFiles" class="function_signature">LoadModelFromInputFiles (inputFiles)</div>
<div class="function_title">Description</div>
<div class="function_description">Loads the model based on a list of <a href="Class_InputFile.html" target="_self">InputFile</a> objects. This method is used internally, you should use LoadModelFromUrlList or LoadModelFromFileList instead.</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">inputFiles</span>
<span class="type parameter_type"><a href="InputFile.html" target="_self">InputFile</a>[]</span>
<span class="type parameter_type"><a href="Class_InputFile.html" target="_self">InputFile</a>[]</span>
</div>
<div class="parameter_main">
<div class="parameter_description">List of model files.</div>
</div>
</div>
<div class="method_container">
<div id="GetViewer" class="method_signature">GetViewer ()</div>
<div class="method_title">Description</div>
<div class="method_description">Returns the underlying Viewer object.</div>
<div class="method_title">Returns</div>
<div class="method_returns">
<div class="function_container">
<div id="GetViewer" class="function_signature">GetViewer ()</div>
<div class="function_title">Description</div>
<div class="function_description">Returns the underlying Viewer object.</div>
<div class="function_title">Returns</div>
<div class="function_returns">
<span class="type parameter_type">Viewer</span>
</div>
</div>
<div class="method_container">
<div id="GetModel" class="method_signature">GetModel ()</div>
<div class="method_title">Description</div>
<div class="method_description">Returns the underlying Model object.</div>
<div class="method_title">Returns</div>
<div class="method_returns">
<div class="function_container">
<div id="GetModel" class="function_signature">GetModel ()</div>
<div class="function_title">Description</div>
<div class="function_description">Returns the underlying Model object.</div>
<div class="function_title">Returns</div>
<div class="function_returns">
<span class="type parameter_type">Model</span>
</div>
</div>
<div class="method_container">
<div id="Resize" class="method_signature">Resize ()</div>
<div class="method_title">Description</div>
<div class="method_description">This method must be called when the size of the parent element changes to make sure that the context has the same dimensions as the parent element.</div>
<div class="function_container">
<div id="Resize" class="function_signature">Resize ()</div>
<div class="function_title">Description</div>
<div class="function_description">This method must be called when the size of the parent element changes to make sure that the context has the same dimensions as the parent element.</div>
</div>
<div class="method_container">
<div id="Destroy" class="method_signature">Destroy ()</div>
<div class="method_title">Description</div>
<div class="method_description">Frees up all the memory that is allocated by the viewer. You should call this function if yo don&#x27;t need the viewer anymore.</div>
<div class="function_container">
<div id="Destroy" class="function_signature">Destroy ()</div>
<div class="function_title">Description</div>
<div class="function_description">Frees up all the memory that is allocated by the viewer. You should call this function if yo don&#x27;t need the viewer anymore.</div>
</div>
</div>

52
docs/EnvironmentSettings.html → docs/Class_EnvironmentSettings.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
@ -60,9 +60,9 @@
<h1>EnvironmentSettings</h1>
<div class="description">Environment settings object.</div>
<h2>Constructor</h2>
<div class="method_container">
<div id="EnvironmentSettings" class="method_signature">new EnvironmentSettings (textureNames, backgroundIsEnvMap)</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="EnvironmentSettings" class="function_signature">new EnvironmentSettings (textureNames, backgroundIsEnvMap)</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">textureNames</span>
<span class="type parameter_type">string[]</span>
@ -79,13 +79,13 @@
</div>
</div>
<h2>Methods</h2>
<div class="method_container">
<div id="Clone" class="method_signature">Clone ()</div>
<div class="method_title">Description</div>
<div class="method_description">Creates a clone of the object.</div>
<div class="method_title">Returns</div>
<div class="method_returns">
<span class="type parameter_type"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></span>
<div class="function_container">
<div id="Clone" class="function_signature">Clone ()</div>
<div class="function_title">Description</div>
<div class="function_description">Creates a clone of the object.</div>
<div class="function_title">Returns</div>
<div class="function_returns">
<span class="type parameter_type"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></span>
</div>
</div>

40
docs/InputFile.html → docs/Class_InputFile.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
@ -60,9 +60,9 @@
<h1>InputFile</h1>
<div class="description">File representation class for importers.</div>
<h2>Constructor</h2>
<div class="method_container">
<div id="InputFile" class="method_signature">new InputFile (name, source, data)</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="InputFile" class="function_signature">new InputFile (name, source, data)</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">name</span>
<span class="type parameter_type">string</span>
@ -72,7 +72,7 @@
</div>
<div class="parameter_header">
<span class="parameter_name">source</span>
<span class="type parameter_type"><a href="FileSource.html" target="_self">FileSource</a></span>
<span class="type parameter_type"><a href="Enum_FileSource.html" target="_self">FileSource</a></span>
</div>
<div class="parameter_main">
<div class="parameter_description">Source of the file.</div>

62
docs/RGBAColor.html → docs/Class_RGBAColor.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
@ -60,9 +60,9 @@
<h1>RGBAColor</h1>
<div class="description">RGBA color object. Components are integers in the range of 0..255.</div>
<h2>Constructor</h2>
<div class="method_container">
<div id="RGBAColor" class="method_signature">new RGBAColor (r, g, b, a)</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="RGBAColor" class="function_signature">new RGBAColor (r, g, b, a)</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">r</span>
<span class="type parameter_type">integer</span>
@ -93,11 +93,11 @@
</div>
</div>
<h2>Methods</h2>
<div class="method_container">
<div id="Set" class="method_signature">Set (r, g, b, a)</div>
<div class="method_title">Description</div>
<div class="method_description">Sets the value of all components.</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="Set" class="function_signature">Set (r, g, b, a)</div>
<div class="function_title">Description</div>
<div class="function_description">Sets the value of all components.</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">r</span>
<span class="type parameter_type">integer</span>
@ -127,13 +127,13 @@
<div class="parameter_description">Alpha component.</div>
</div>
</div>
<div class="method_container">
<div id="Clone" class="method_signature">Clone ()</div>
<div class="method_title">Description</div>
<div class="method_description">Creates a clone of the object.</div>
<div class="method_title">Returns</div>
<div class="method_returns">
<span class="type parameter_type"><a href="RGBAColor.html" target="_self">RGBAColor</a></span>
<div class="function_container">
<div id="Clone" class="function_signature">Clone ()</div>
<div class="function_title">Description</div>
<div class="function_description">Creates a clone of the object.</div>
<div class="function_title">Returns</div>
<div class="function_returns">
<span class="type parameter_type"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></span>
</div>
</div>

62
docs/RGBColor.html → docs/Class_RGBColor.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
@ -60,9 +60,9 @@
<h1>RGBColor</h1>
<div class="description">RGB color object. Components are integers in the range of 0..255.</div>
<h2>Constructor</h2>
<div class="method_container">
<div id="RGBColor" class="method_signature">new RGBColor (r, g, b)</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="RGBColor" class="function_signature">new RGBColor (r, g, b)</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">r</span>
<span class="type parameter_type">integer</span>
@ -86,11 +86,11 @@
</div>
</div>
<h2>Methods</h2>
<div class="method_container">
<div id="Set" class="method_signature">Set (r, g, b)</div>
<div class="method_title">Description</div>
<div class="method_description">Sets the value of all components.</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="Set" class="function_signature">Set (r, g, b)</div>
<div class="function_title">Description</div>
<div class="function_description">Sets the value of all components.</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">r</span>
<span class="type parameter_type">integer</span>
@ -113,13 +113,13 @@
<div class="parameter_description">Blue component.</div>
</div>
</div>
<div class="method_container">
<div id="Clone" class="method_signature">Clone ()</div>
<div class="method_title">Description</div>
<div class="method_description">Creates a clone of the object.</div>
<div class="method_title">Returns</div>
<div class="method_returns">
<span class="type parameter_type"><a href="RGBColor.html" target="_self">RGBColor</a></span>
<div class="function_container">
<div id="Clone" class="function_signature">Clone ()</div>
<div class="function_title">Description</div>
<div class="function_description">Creates a clone of the object.</div>
<div class="function_title">Returns</div>
<div class="function_returns">
<span class="type parameter_type"><a href="Class_RGBColor.html" target="_self">RGBColor</a></span>
</div>
</div>

32
docs/CameraMode.html → docs/Enum_CameraMode.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>

32
docs/FileSource.html → docs/Enum_FileSource.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>

50
docs/Init3DViewerElement.html → docs/Function_Init3DViewerElement.html
View File

@ -25,44 +25,44 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
<div id="main" class="main">
<h1>Init3DViewerElement</h1>
<div class="method_container">
<div id="Init3DViewerElement" class="method_signature">Init3DViewerElement (parentElement, modelUrls, parameters)</div>
<div class="method_title">Description</div>
<div class="method_description">Loads the model specified by urls.</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="Init3DViewerElement" class="function_signature">Init3DViewerElement (parentElement, modelUrls, parameters)</div>
<div class="function_title">Description</div>
<div class="function_description">Loads the model specified by urls.</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">parentElement</span>
<span class="type parameter_type">Element</span>
@ -82,11 +82,11 @@
<span class="type parameter_type">object</span>
</div>
<div class="parameter_main">
<div class="parameter_description">See <a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a> constructor for details.</div>
<div class="parameter_description">See <a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a> constructor for details.</div>
</div>
<div class="method_title">Returns</div>
<div class="method_returns">
<span class="type parameter_type"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></span>
<div class="function_title">Returns</div>
<div class="function_returns">
<span class="type parameter_type"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></span>
</div>
</div>

44
docs/Init3DViewerElements.html → docs/Function_Init3DViewerElements.html
View File

@ -25,50 +25,50 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
<div id="main" class="main">
<h1>Init3DViewerElements</h1>
<div class="method_container">
<div id="Init3DViewerElements" class="method_signature">Init3DViewerElements (onReady)</div>
<div class="method_title">Description</div>
<div class="method_description">Loads all the models on the page. This function looks for all the elements with online_3d_viewer class name, and loads the model according to the tag&#x27;s parameters.</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="Init3DViewerElements" class="function_signature">Init3DViewerElements (onReady)</div>
<div class="function_title">Description</div>
<div class="function_description">Loads all the models on the page. This function looks for all the elements with online_3d_viewer class name, and loads the model according to the tag&#x27;s parameters.</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">onReady</span>
<span class="type parameter_type">function</span>
</div>
<div class="parameter_main">
<div class="parameter_description">Callback that called when all models are loaded. It has one parameter that is an array of the created <a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a> objects.</div>
<div class="parameter_description">Callback that called when all models are loaded. It has one parameter that is an array of the created <a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a> objects.</div>
</div>
</div>

42
docs/SetExternalLibLocation.html → docs/Function_SetExternalLibLocation.html
View File

@ -25,44 +25,44 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
<div id="main" class="main">
<h1>SetExternalLibLocation</h1>
<div class="method_container">
<div id="SetExternalLibLocation" class="method_signature">SetExternalLibLocation (newExternalLibLocation)</div>
<div class="method_title">Description</div>
<div class="method_description">Sets the location of the external libraries used by the engine. This is the content of the libs folder in the package. The location must be relative to the main file.</div>
<div class="method_title">Parameters</div>
<div class="function_container">
<div id="SetExternalLibLocation" class="function_signature">SetExternalLibLocation (newExternalLibLocation)</div>
<div class="function_title">Description</div>
<div class="function_description">Sets the location of the external libraries used by the engine. This is the content of the libs folder in the package. The location must be relative to the main file.</div>
<div class="function_title">Parameters</div>
<div class="parameter_header">
<span class="parameter_name">newExternalLibLocation</span>
<span class="type parameter_type">string</span>

32
docs/ContributionGuidelinesPage.html → docs/Page_ContributionGuidelines.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>

32
docs/EnvironmentSetupPage.html → docs/Page_EnvironmentSetup.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>

32
docs/InstallationPage.html → docs/Page_Installation.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>

32
docs/UsagePage.html → docs/Page_Usage.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>

39
docs/index.html
View File

@ -25,34 +25,34 @@
</div>
<div class="navigation_section">
<div class="navigation_title">Engine Usage</div>
<div id="nav-Installation" class="navigation_item"><a href="InstallationPage.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="UsagePage.html" target="_self">Usage</a></div>
<div id="nav-Installation" class="navigation_item"><a href="Page_Installation.html" target="_self">Installation</a></div>
<div id="nav-Usage" class="navigation_item"><a href="Page_Usage.html" target="_self">Usage</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Contribution</div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="ContributionGuidelinesPage.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="EnvironmentSetupPage.html" target="_self">Environment Setup</a></div>
<div id="nav-Contribution Guidelines" class="navigation_item"><a href="Page_ContributionGuidelines.html" target="_self">Contribution Guidelines</a></div>
<div id="nav-Environment Setup" class="navigation_item"><a href="Page_EnvironmentSetup.html" target="_self">Environment Setup</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Classes</div>
<div id="nav-Camera" class="navigation_item"><a href="Camera.html" target="_self">Camera</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="EdgeSettings.html" target="_self">EdgeSettings</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-InputFile" class="navigation_item"><a href="Class_InputFile.html" target="_self">InputFile</a></div>
<div id="nav-RGBColor" class="navigation_item"><a href="Class_RGBColor.html" target="_self">RGBColor</a></div>
<div id="nav-RGBAColor" class="navigation_item"><a href="Class_RGBAColor.html" target="_self">RGBAColor</a></div>
<div id="nav-Camera" class="navigation_item"><a href="Class_Camera.html" target="_self">Camera</a></div>
<div id="nav-EmbeddedViewer" class="navigation_item"><a href="Class_EmbeddedViewer.html" target="_self">EmbeddedViewer</a></div>
<div id="nav-EnvironmentSettings" class="navigation_item"><a href="Class_EnvironmentSettings.html" target="_self">EnvironmentSettings</a></div>
<div id="nav-EdgeSettings" class="navigation_item"><a href="Class_EdgeSettings.html" target="_self">EdgeSettings</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Functions</div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-SetExternalLibLocation" class="navigation_item"><a href="Function_SetExternalLibLocation.html" target="_self">SetExternalLibLocation</a></div>
<div id="nav-Init3DViewerElement" class="navigation_item"><a href="Function_Init3DViewerElement.html" target="_self">Init3DViewerElement</a></div>
<div id="nav-Init3DViewerElements" class="navigation_item"><a href="Function_Init3DViewerElements.html" target="_self">Init3DViewerElements</a></div>
</div>
<div class="navigation_section">
<div class="navigation_title">Enums</div>
<div id="nav-CameraMode" class="navigation_item"><a href="CameraMode.html" target="_self">CameraMode</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="FileSource.html" target="_self">FileSource</a></div>
<div id="nav-FileSource" class="navigation_item"><a href="Enum_FileSource.html" target="_self">FileSource</a></div>
<div id="nav-CameraMode" class="navigation_item"><a href="Enum_CameraMode.html" target="_self">CameraMode</a></div>
</div>
</div>
@ -72,8 +72,8 @@
<p>These documents help you understanding how to use the engine in your own solution.</p>
<ul>
<li><a href="InstallationPage.html">Installation</a> - How to get the package?</li>
<li><a href="UsagePage.html">Usage</a> - How to use it to embed 3D models?</li>
<li><a href="Page_Installation.html">Installation</a> - How to get the package?</li>
<li><a href="Page_Usage.html">Usage</a> - How to use it to embed 3D models?</li>
</ul>
<h2>Contribution</h2>
@ -81,7 +81,8 @@
<p>If you would like to contribute to the codebase, these documents help you to start.</p>
<ul>
<li><a href="EnvironmentSetupPage.html">Environment Setup</a> - How to set up your environment for development?</li>
<li><a href="Page_ContributionGuidelines.html">Contribution Guidelines</a> - How to contribute to the repository?</li>
<li><a href="Page_EnvironmentSetup.html">Environment Setup</a> - How to set up your environment for development?</li>
</ul>
</div>

0
docs/source/ContributionGuidelinesPage.html → docs/source/ContributionGuidelines.html
View File

0
docs/source/EnvironmentSetupPage.html → docs/source/EnvironmentSetup.html
View File

0
docs/source/InstallationPage.html → docs/source/Installation.html
View File

0
docs/source/UsagePage.html → docs/source/Usage.html
View File

8
docs/source/config.json
View File

@ -18,11 +18,11 @@
"pages" : [
{
"name" : "Installation",
"url" : "InstallationPage.html"
"url" : "Installation.html"
},
{
"name" : "Usage",
"url" : "UsagePage.html"
"url" : "Usage.html"
}
]
},
@ -31,11 +31,11 @@
"pages" : [
{
"name" : "Contribution Guidelines",
"url" : "ContributionGuidelinesPage.html"
"url" : "ContributionGuidelines.html"
},
{
"name" : "Environment Setup",
"url" : "EnvironmentSetupPage.html"
"url" : "EnvironmentSetup.html"
}
]
}

7
docs/source/index.html
View File

@ -12,8 +12,8 @@
<p>These documents help you understanding how to use the engine in your own solution.</p>
<ul>
<li><a href="InstallationPage.html">Installation</a> - How to get the package?</li>
<li><a href="UsagePage.html">Usage</a> - How to use it to embed 3D models?</li>
<li><a href="Page_Installation.html">Installation</a> - How to get the package?</li>
<li><a href="Page_Usage.html">Usage</a> - How to use it to embed 3D models?</li>
</ul>
<h2>Contribution</h2>
@ -21,5 +21,6 @@
<p>If you would like to contribute to the codebase, these documents help you to start.</p>
<ul>
<li><a href="EnvironmentSetupPage.html">Environment Setup</a> - How to set up your environment for development?</li>
<li><a href="Page_ContributionGuidelines.html">Contribution Guidelines</a> - How to contribute to the repository?</li>
<li><a href="Page_EnvironmentSetup.html">Environment Setup</a> - How to set up your environment for development?</li>
</ul>

8
docs/static/style.css vendored
View File

@ -158,12 +158,12 @@ li
overflow: auto;
}
.method_container
.function_container
{
margin-bottom: 50px;
}
.method_signature
.function_signature
{
background: #eeeeee;
font-size: 18px;
@ -173,12 +173,12 @@ li
border-left: 4px solid #bbbbbb;
}
.method_description
.function_description
{
margin: 10px 0px;
}
.method_title
.function_title
{
font-size: 16px;
font-weight: bold;

357
tools/generate_docs.py
View File

@ -8,252 +8,8 @@ import platform
import html
import re
from lib import utils as Utils
class HtmlGenerator:
def __init__ (self, eol):
self.html = ''
self.eol = eol
def AddText (self, content):
self.html += content
def AddLine (self, content):
self.AddText (content + self.eol)
def AddTag (self, tagName, content):
self.AddLine ('<{0}>{1}</{0}>'.format (tagName, content))
def AddTagWithClass (self, tagName, className, content):
self.AddLine ('<{0} class="{1}">{2}</{0}>'.format (tagName, className, content))
def AddTagWithAttributes (self, tagName, attributes, content):
line = '<{0}'.format (tagName);
if len (attributes) > 0:
attributeStrings = map (lambda x : '{0}="{1}"'.format (x[0], x[1]), attributes)
line += ' ' + ' '.join (attributeStrings)
line += '>{1}</{0}>'.format (tagName, content)
self.AddLine (line)
def BeginTag (self, tagName):
self.AddLine ('<{0}>'.format (tagName))
def BeginTagWithClass (self, tagName, className):
self.AddLine ('<{0} class="{1}">'.format (tagName, className))
def EndTag (self, tagName):
self.AddLine ('</{0}>'.format (tagName))
def GetHtml (self):
return self.html
def CleanUpText (text):
if text == None:
return ''
invalidChars = ['\r', '\n', '\t']
for invalidChar in invalidChars:
text = text.replace (invalidChar, ' ')
text = html.escape (text)
return text
def GenerateLink (entityName, entityLink):
target = '_blank' if entityLink.startswith ('http') else '_self'
return '<a href="{1}" target="{2}">{0}</a>'.format (entityName, entityLink, target)
def FinalizeType (text, entityLinks):
text = CleanUpText (text)
arrayMatch = re.match ('Array\.&lt;(.+)&gt', text)
if arrayMatch != None:
matchedName = arrayMatch.group (1)
if matchedName in entityLinks:
return GenerateLink (matchedName, entityLinks[matchedName]) + '[]'
else:
return arrayMatch.group (1) + '[]'
if text in entityLinks:
return GenerateLink (text, entityLinks[text])
return text
def FinalizeDescription (text, entityLinks):
text = CleanUpText (text)
links = re.findall ('{@link (.+)}', text)
for link in links:
if link in entityLinks:
text = text.replace ('{@link ' + link + '}', GenerateLink (link, entityLinks[link]))
else:
text = text.replace ('{@link ' + link + '}', link)
return text
class NavigationGroup:
def __init__ (self, name, sort):
self.name = name
self.sort = sort
self.links = []
def AddLink (self, name, url):
self.links.append ({
'name' : name,
'url' : url
})
class Navigation:
def __init__ (self):
self.groups = []
self.entityLinks = {}
def AddGroup (self, group):
self.groups.append (group)
def AddEntityLink (self, name, url):
self.entityLinks[name] = url
def GenerateHtml (self, eol):
generator = HtmlGenerator (eol)
for group in self.groups:
if len (group.links) == 0:
continue
generator.BeginTagWithClass ('div', 'navigation_section')
generator.AddTagWithClass ('div', 'navigation_title', group.name)
finalLinks = group.links
if group.sort:
finalLinks = sorted (group.links, key = lambda x : x['name'])
for link in finalLinks:
linkHtml = GenerateLink (link['name'], link['url'])
generator.AddTagWithAttributes ('div', [('id', 'nav-' + link['name']), ('class', 'navigation_item')], linkHtml)
generator.EndTag ('div')
return generator.GetHtml ()
class EnumMemberDoc:
def __init__ (self, name, description):
self.name = name
self.description = description
class EnumDoc:
def __init__ (self, name, description):
self.name = name
self.description = description
self.members = []
def AddMember (self, member):
self.members.append (member)
def GenerateHtml (self, navigation, eol):
generator = HtmlGenerator (eol)
generator.AddTag ('h1', self.name)
generator.AddTagWithClass ('div', 'description', FinalizeDescription (self.description, navigation.entityLinks))
if len (self.members) > 0:
generator.AddTag ('h2', 'Values')
for member in self.members:
generator.BeginTagWithClass ('div', 'parameter_header')
generator.AddTagWithClass ('span', 'parameter_name', member.name)
generator.EndTag ('div')
generator.BeginTagWithClass ('div', 'parameter_main')
generator.AddTagWithClass ('div', 'parameter_description', FinalizeDescription (member.description, navigation.entityLinks))
generator.EndTag ('div')
return generator.GetHtml ()
class ParameterDoc:
def __init__ (self, name, types, isOptional, description):
self.name = name
self.types = types
self.isOptional = isOptional
self.description = description
self.subParameters = []
def AddSubParameter (self, parameter):
self.subParameters.append (parameter)
class ReturnsDoc:
def __init__ (self, types, description):
self.types = types
self.description = description
class MethodDoc:
def __init__ (self, name, description, parameters, returns):
self.name = name
self.description = description
self.parameters = parameters
self.returns = returns
def AddParameter (self, parameter):
self.parameters.append (parameter)
def GenerateHtml (self, navigation, eol):
generator = HtmlGenerator (eol)
generator.AddTag ('h1', self.name)
GenerateMethodHtml (self, generator, navigation, False)
return generator.GetHtml ()
class ClassDoc:
def __init__ (self, name, description):
self.name = name
self.description = description
self.constructor = None
self.methods = []
def SetConstructor (self, constructor):
self.constructor = constructor
def AddMethod (self, method):
self.methods.append (method)
def GenerateHtml (self, navigation, eol):
generator = HtmlGenerator (eol)
generator.AddTag ('h1', self.name)
generator.AddTagWithClass ('div', 'description', FinalizeDescription (self.description, navigation.entityLinks))
if self.constructor != None:
generator.AddTag ('h2', 'Constructor')
GenerateMethodHtml (self.constructor, generator, navigation, True)
if len (self.methods) > 0:
generator.AddTag ('h2', 'Methods')
for method in self.methods:
GenerateMethodHtml (method, generator, navigation, False)
return generator.GetHtml ()
def GenerateParameterTypesHtml (paramTypes, generator, navigation):
for i in range (0, len (paramTypes)):
paramType = paramTypes[i]
paramTypeHtml = FinalizeType (paramType, navigation.entityLinks)
generator.AddTagWithClass ('span', 'type parameter_type', paramTypeHtml)
if (i < len (paramTypes) - 1):
generator.AddTagWithClass ('span', 'parameter_type_separator', '|')
def GenerateParameterListHtml (parameters, generator, navigation):
for param in parameters:
generator.BeginTagWithClass ('div', 'parameter_header')
generator.AddTagWithClass ('span', 'parameter_name', param.name)
GenerateParameterTypesHtml (param.types, generator, navigation)
if param.isOptional:
generator.AddTagWithClass ('span', 'parameter_attributes', '(optional)')
generator.EndTag ('div')
generator.BeginTagWithClass ('div', 'parameter_main')
generator.AddTagWithClass ('div', 'parameter_description', FinalizeDescription (param.description, navigation.entityLinks))
if len (param.subParameters) > 0:
GenerateParameterListHtml (param.subParameters, generator, navigation)
generator.EndTag ('div')
def GenerateMethodHtml (method, generator, navigation, isConstructor):
paramNames = map (lambda x : x.name, method.parameters)
methodSignature = method.name + ' (' + ', '.join (paramNames) + ')'
if isConstructor:
methodSignature = 'new ' + methodSignature
generator.BeginTagWithClass ('div', 'method_container')
generator.AddTagWithAttributes ('div', [('id', method.name), ('class', 'method_signature')], methodSignature)
if method.description != None:
generator.AddTagWithClass ('div', 'method_title', 'Description')
generator.AddTagWithClass ('div', 'method_description', FinalizeDescription (method.description, navigation.entityLinks))
if method.parameters != None and len (method.parameters) > 0:
generator.AddTagWithClass ('div', 'method_title', 'Parameters')
GenerateParameterListHtml (method.parameters, generator, navigation)
if method.returns != None:
generator.AddTagWithClass ('div', 'method_title', 'Returns')
generator.BeginTagWithClass ('div', 'method_returns')
if method.returns.types != None:
GenerateParameterTypesHtml (method.returns.types, generator, navigation)
if method.returns.description != None:
generator.AddTagWithClass ('span', 'return_description', FinalizeDescription (method.returns.description, navigation.entityLinks))
generator.EndTag ('div')
generator.EndTag ('div')
from lib.doc_entities import PageType, PageGroup, PageDoc, EnumMemberDoc, EnumDoc, ParameterDoc, ReturnsDoc, FunctionDoc, ClassDoc
from lib.doc_generator import Documentation, GenerateDocumentation
def GetDictValue (dict, key):
if not key in dict:
@ -317,12 +73,16 @@ def GetReturnsFromDoclet (doclet):
GetDictValue (returns, 'description')
)
def BuildHierarchy (doclets):
hierarchy = {
'classes' : [],
'functions' : [],
'enums' : []
}
def AddPageGroupsToDocumentation (documentation, pageGroups, sourcesFolder):
for pageGroup in pageGroups:
pageGroupDoc = PageGroup (pageGroup['name'])
for page in pageGroup['pages']:
pageType = PageType.External if page['url'].startswith ('http') else PageType.Internal
pageDoc = PageDoc (page['name'], page['url'], sourcesFolder, pageType)
pageGroupDoc.AddPage (pageDoc)
documentation.AddPageGroup (pageGroupDoc)
def AddEntitiesToDocumentation (documentation, doclets):
classNameToDoc = {}
enumNameToDoc = {}
for doclet in doclets:
@ -333,24 +93,24 @@ def BuildHierarchy (doclets):
description = GetDictValue (doclet, 'description')
if kind == 'class':
classDoc = ClassDoc (name, doclet['classdesc'])
constructorDoc = MethodDoc (name, description, parameters, returns)
constructorDoc = FunctionDoc (name, description, parameters, returns)
classDoc.SetConstructor (constructorDoc)
hierarchy['classes'].append (classDoc)
documentation.AddClass (classDoc)
classNameToDoc[name] = classDoc
elif kind == 'function':
if 'memberof' in doclet:
parentName = doclet['memberof']
if parentName in classNameToDoc:
classDoc = classNameToDoc[parentName]
methodDoc = MethodDoc (name, description, parameters, returns)
classDoc.AddMethod (methodDoc)
functionDoc = FunctionDoc (name, description, parameters, returns)
classDoc.AddFunction (functionDoc)
else:
methodDoc = MethodDoc (name, description, parameters, returns)
hierarchy['functions'].append (methodDoc)
functionDoc = FunctionDoc (name, description, parameters, returns)
documentation.AddFunction (functionDoc)
elif kind == 'constant':
if 'isEnum' in doclet and doclet['isEnum'] == True:
enumDoc = EnumDoc (name, description)
hierarchy['enums'].append (enumDoc)
documentation.AddEnum (enumDoc)
enumNameToDoc[name] = enumDoc
elif kind == 'member':
parentName = doclet['memberof']
@ -358,72 +118,6 @@ def BuildHierarchy (doclets):
enumDoc = enumNameToDoc[parentName]
memberDoc = EnumMemberDoc (name, description)
enumDoc.AddMember (memberDoc)
return hierarchy
def CreateFromTemplate (templateHtmlPath, resultHtmlPath, navigation, title, content, eol):
shutil.copy (templateHtmlPath, resultHtmlPath)
Utils.ReplaceStringsInFile (resultHtmlPath, [
('$$$TITLE$$$', title),
('$$$NAVIGATION$$$', navigation.GenerateHtml (eol)),
('$$$MAIN$$$', content)
])
def BuildNavigation (pageGroups, hierarchy):
navigation = Navigation ()
for pageGroup in pageGroups:
navGroup = NavigationGroup (pageGroup['name'], False)
for page in pageGroup['pages']:
navGroup.AddLink (page['name'], page['url'])
navigation.AddGroup (navGroup)
classesGroup = NavigationGroup ('Classes', True)
for classDoc in hierarchy['classes']:
navigation.AddEntityLink (classDoc.name, classDoc.name + '.html')
classesGroup.AddLink (classDoc.name, classDoc.name + '.html')
navigation.AddGroup (classesGroup)
functionsGroup = NavigationGroup ('Functions', True)
for methodDoc in hierarchy['functions']:
navigation.AddEntityLink (methodDoc.name, methodDoc.name + '.html')
functionsGroup.AddLink (methodDoc.name, methodDoc.name + '.html')
navigation.AddGroup (functionsGroup)
enumsGroup = NavigationGroup ('Enums', True)
for enumDoc in hierarchy['enums']:
navigation.AddEntityLink (enumDoc.name, enumDoc.name + '.html')
enumsGroup.AddLink (enumDoc.name, enumDoc.name + '.html')
navigation.AddGroup (enumsGroup)
return navigation
def BuildDocumentationFiles (navigation, pageGroups, hierarchy, sourceDir, resultDir):
templateHtmlPath = os.path.join (sourceDir, 'Template.html')
eol = Utils.GetEOLCharFromFile (templateHtmlPath)
for pageGroup in pageGroups:
for page in pageGroup['pages']:
if page['url'].startswith ('http'):
continue
sourceHtmlPath = os.path.join (sourceDir, page['url'])
pageHtmlPath = os.path.join (resultDir, page['url'])
pageContent = '<div class="page">' + eol + Utils.GetFileContent (sourceHtmlPath) + eol + '</div>'
CreateFromTemplate (templateHtmlPath, pageHtmlPath, navigation, page['name'], pageContent, eol)
for classDoc in hierarchy['classes']:
classHtmlPath = os.path.join (resultDir, classDoc.name + '.html')
docContent = classDoc.GenerateHtml (navigation, eol)
CreateFromTemplate (templateHtmlPath, classHtmlPath, navigation, classDoc.name, docContent, eol)
for methodDoc in hierarchy['functions']:
methodHtmlPath = os.path.join (resultDir, methodDoc.name + '.html')
docContent = methodDoc.GenerateHtml (navigation, eol)
CreateFromTemplate (templateHtmlPath, methodHtmlPath, navigation, methodDoc.name, docContent, eol)
for enumDoc in hierarchy['enums']:
enumHtmlPath = os.path.join (resultDir, enumDoc.name + '.html')
docContent = enumDoc.GenerateHtml (navigation, eol)
CreateFromTemplate (templateHtmlPath, enumHtmlPath, navigation, enumDoc.name, docContent, eol)
def Main (argv):
toolsDir = os.path.dirname (os.path.abspath (__file__))
@ -448,16 +142,17 @@ def Main (argv):
with open (os.path.join (sourceDir, 'config.json')) as configJson:
config = json.load (configJson)
doclets = GetDocumentedDoclets (resultJson)
documentation = Documentation ()
pageGroups = config['page_groups']
hierarchy = BuildHierarchy (doclets)
AddPageGroupsToDocumentation (documentation, pageGroups, sourceDir)
navigation = BuildNavigation (pageGroups, hierarchy)
doclets = GetDocumentedDoclets (resultJson)
AddEntitiesToDocumentation (documentation, doclets)
for name in config['external_refs']:
navigation.AddEntityLink (name, config['external_refs'][name])
BuildDocumentationFiles (navigation, pageGroups, hierarchy, sourceDir, resultDir)
documentation.AddEntityLink (name, config['external_refs'][name])
GenerateDocumentation (documentation, sourceDir, resultDir)
return 0
sys.exit (Main (sys.argv))

157
tools/lib/doc_entities.py Normal file
View File

@ -0,0 +1,157 @@
import os
from enum import Enum
from . import utils as Utils
from .html_generator import HtmlGenerator
from .doc_utils import FinalizeDescription, FunctionType, GenerateFunctionHtml
class DocEntity:
def GetName (self):
raise Exception ('Not implemented.')
def GetLocation (self):
raise Exception ('Not implemented.')
def GetHtml (self, entityLinks, eol):
raise Exception ('Not implemented.')
class PageGroup:
def __init__ (self, name):
self.name = name
self.pages = []
def AddPage (self, page):
self.pages.append (page)
class PageType (Enum):
Internal = 1
External = 2
class PageDoc (DocEntity):
def __init__ (self, name, link, folder, type):
self.name = name
self.link = link
self.folder = folder
self.type = type
def GetName (self):
return self.name
def GetLocation (self):
if self.type == PageType.Internal:
prefix = 'Page_' if self.link != 'index.html' else ''
return prefix + self.link
else:
return self.link
def GetHtml (self, entityLinks, eol):
if self.type == PageType.Internal:
pageContent = Utils.GetFileContent (os.path.join (self.folder, self.link))
return '<div class="page">' + eol + pageContent + eol + '</div>'
else:
raise Exception ('GetHtml called for external link.')
class EnumMemberDoc:
def __init__ (self, name, description):
self.name = name
self.description = description
class EnumDoc (DocEntity):
def __init__ (self, name, description):
self.name = name
self.description = description
self.members = []
def AddMember (self, member):
self.members.append (member)
def GetName (self):
return self.name
def GetLocation (self):
return 'Enum_' + self.name + '.html'
def GetHtml (self, entityLinks, eol):
generator = HtmlGenerator (eol)
generator.AddTag ('h1', self.name)
generator.AddTagWithClass ('div', 'description', FinalizeDescription (self.description, entityLinks))
if len (self.members) > 0:
generator.AddTag ('h2', 'Values')
for member in self.members:
generator.BeginTagWithClass ('div', 'parameter_header')
generator.AddTagWithClass ('span', 'parameter_name', member.name)
generator.EndTag ('div')
generator.BeginTagWithClass ('div', 'parameter_main')
generator.AddTagWithClass ('div', 'parameter_description', FinalizeDescription (member.description, entityLinks))
generator.EndTag ('div')
return generator.GetHtml ()
class ParameterDoc:
def __init__ (self, name, types, isOptional, description):
self.name = name
self.types = types
self.isOptional = isOptional
self.description = description
self.subParameters = []
def AddSubParameter (self, parameter):
self.subParameters.append (parameter)
class ReturnsDoc:
def __init__ (self, types, description):
self.types = types
self.description = description
class FunctionDoc (DocEntity):
def __init__ (self, name, description, parameters, returns):
self.name = name
self.description = description
self.parameters = parameters
self.returns = returns
def AddParameter (self, parameter):
self.parameters.append (parameter)
def GetName (self):
return self.name
def GetLocation (self):
return 'Function_' + self.name + '.html'
def GetHtml (self, navigation, eol):
generator = HtmlGenerator (eol)
generator.AddTag ('h1', self.name)
GenerateFunctionHtml (self, generator, navigation, FunctionType.Standalone)
return generator.GetHtml ()
class ClassDoc (DocEntity):
def __init__ (self, name, description):
self.name = name
self.description = description
self.constructor = None
self.functions = []
def SetConstructor (self, constructor):
self.constructor = constructor
def AddFunction (self, function):
self.functions.append (function)
def GetName (self):
return self.name
def GetLocation (self):
return 'Class_' + self.name + '.html'
def GetHtml (self, entityLinks, eol):
generator = HtmlGenerator (eol)
generator.AddTag ('h1', self.name)
generator.AddTagWithClass ('div', 'description', FinalizeDescription (self.description, entityLinks))
if self.constructor != None:
generator.AddTag ('h2', 'Constructor')
GenerateFunctionHtml (self.constructor, generator, entityLinks, FunctionType.Constructor)
if len (self.functions) > 0:
generator.AddTag ('h2', 'Methods')
for function in self.functions:
GenerateFunctionHtml (function, generator, entityLinks, FunctionType.Standalone.ClassMethod)
return generator.GetHtml ()

86
tools/lib/doc_generator.py Normal file
View File

@ -0,0 +1,86 @@
import os
import shutil
from . import utils as Utils
from .html_generator import HtmlGenerator
from .doc_entities import PageType
class Documentation:
def __init__ (self):
self.pageGroups = []
self.classes = []
self.functions = []
self.enums = []
self.entityLinks = {}
def AddPageGroup (self, pageGroup):
for page in pageGroup.pages:
self.AddEntityLink (page.name, page.GetLocation ())
self.pageGroups.append (pageGroup)
def AddClass (self, classDoc):
self.AddEntityLink (classDoc.GetName (), classDoc.GetLocation ())
self.classes.append (classDoc)
def AddFunction (self, functionDoc):
self.AddEntityLink (functionDoc.GetName (), functionDoc.GetLocation ())
self.functions.append (functionDoc)
def AddEnum (self, enumDoc):
self.AddEntityLink (enumDoc.GetName (), enumDoc.GetLocation ())
self.enums.append (enumDoc)
def AddEntityLink (self, name, url):
assert (not name in self.entityLinks)
self.entityLinks[name] = url
def GenerateDocumentationPage (documentation, templatePath, resultDirPath, navigationHtml, entity, eol):
resultPath = os.path.join (resultDirPath, entity.GetLocation ())
shutil.copy (templatePath, resultPath)
Utils.ReplaceStringsInFile (resultPath, [
('$$$TITLE$$$', entity.GetName ()),
('$$$NAVIGATION$$$', navigationHtml),
('$$$MAIN$$$', entity.GetHtml (documentation.entityLinks, eol))
])
def GenerateLinkHtml (entityName, entityLink):
target = '_blank' if entityLink.startswith ('http') else '_self'
return '<a href="{1}" target="{2}">{0}</a>'.format (entityName, entityLink, target)
def AddNavigationSection (generator, name, entities):
generator.BeginTagWithClass ('div', 'navigation_section')
generator.AddTagWithClass ('div', 'navigation_title', name)
for entity in entities:
linkHtml = GenerateLinkHtml (entity.GetName (), entity.GetLocation ())
generator.AddTagWithAttributes ('div', [('id', 'nav-' + entity.GetName ()), ('class', 'navigation_item')], linkHtml)
generator.EndTag ('div')
def GenerateNavigationHtml (documentation, eol):
generator = HtmlGenerator (eol)
for pageGroup in documentation.pageGroups:
AddNavigationSection (generator, pageGroup.name, pageGroup.pages)
AddNavigationSection (generator, 'Classes', documentation.classes)
AddNavigationSection (generator, 'Functions', documentation.functions)
AddNavigationSection (generator, 'Enums', documentation.enums)
return generator.GetHtml ()
def GenerateDocumentation (documentation, sourceFolder, targetFolder):
templateHtmlPath = os.path.join (sourceFolder, 'Template.html')
eol = Utils.GetEOLCharFromFile (templateHtmlPath)
navigationHtml = GenerateNavigationHtml (documentation, eol)
for pageGroup in documentation.pageGroups:
for page in pageGroup.pages:
if page.type == PageType.External:
continue
GenerateDocumentationPage (documentation, templateHtmlPath, targetFolder, navigationHtml, page, eol)
allEntities = [
documentation.classes,
documentation.functions,
documentation.enums
]
for entityList in allEntities:
for entity in entityList:
GenerateDocumentationPage (documentation, templateHtmlPath, targetFolder, navigationHtml, entity, eol)

89
tools/lib/doc_utils.py Normal file
View File

@ -0,0 +1,89 @@
import re
import html
from enum import Enum
def CleanUpText (text):
if text == None:
return ''
invalidChars = ['\r', '\n', '\t']
for invalidChar in invalidChars:
text = text.replace (invalidChar, ' ')
text = html.escape (text)
return text
def GenerateLink (entityName, entityLink):
target = '_blank' if entityLink.startswith ('http') else '_self'
return '<a href="{1}" target="{2}">{0}</a>'.format (entityName, entityLink, target)
def FinalizeType (text, entityLinks):
text = CleanUpText (text)
arrayMatch = re.match ('Array\.&lt;(.+)&gt', text)
if arrayMatch != None:
matchedName = arrayMatch.group (1)
if matchedName in entityLinks:
return GenerateLink (matchedName, entityLinks[matchedName]) + '[]'
else:
return arrayMatch.group (1) + '[]'
if text in entityLinks:
return GenerateLink (text, entityLinks[text])
return text
def FinalizeDescription (text, entityLinks):
text = CleanUpText (text)
links = re.findall ('{@link (.+)}', text)
for link in links:
if link in entityLinks:
text = text.replace ('{@link ' + link + '}', GenerateLink (link, entityLinks[link]))
else:
text = text.replace ('{@link ' + link + '}', link)
return text
def GenerateParameterTypesHtml (paramTypes, generator, entityLinks):
for i in range (0, len (paramTypes)):
paramType = paramTypes[i]
paramTypeHtml = FinalizeType (paramType, entityLinks)
generator.AddTagWithClass ('span', 'type parameter_type', paramTypeHtml)
if (i < len (paramTypes) - 1):
generator.AddTagWithClass ('span', 'parameter_type_separator', '|')
def GenerateParameterListHtml (parameters, generator, entityLinks):
for param in parameters:
generator.BeginTagWithClass ('div', 'parameter_header')
generator.AddTagWithClass ('span', 'parameter_name', param.name)
GenerateParameterTypesHtml (param.types, generator, entityLinks)
if param.isOptional:
generator.AddTagWithClass ('span', 'parameter_attributes', '(optional)')
generator.EndTag ('div')
generator.BeginTagWithClass ('div', 'parameter_main')
generator.AddTagWithClass ('div', 'parameter_description', FinalizeDescription (param.description, entityLinks))
if len (param.subParameters) > 0:
GenerateParameterListHtml (param.subParameters, generator, entityLinks)
generator.EndTag ('div')
class FunctionType (Enum):
Constructor = 1
ClassMethod = 2
Standalone = 3
def GenerateFunctionHtml (function, generator, entityLinks, type):
paramNames = map (lambda x : x.name, function.parameters)
functionSignature = function.name + ' (' + ', '.join (paramNames) + ')'
if type == FunctionType.Constructor:
functionSignature = 'new ' + functionSignature
generator.BeginTagWithClass ('div', 'function_container')
generator.AddTagWithAttributes ('div', [('id', function.name), ('class', 'function_signature')], functionSignature)
if function.description != None:
generator.AddTagWithClass ('div', 'function_title', 'Description')
generator.AddTagWithClass ('div', 'function_description', FinalizeDescription (function.description, entityLinks))
if function.parameters != None and len (function.parameters) > 0:
generator.AddTagWithClass ('div', 'function_title', 'Parameters')
GenerateParameterListHtml (function.parameters, generator, entityLinks)
if function.returns != None:
generator.AddTagWithClass ('div', 'function_title', 'Returns')
generator.BeginTagWithClass ('div', 'function_returns')
if function.returns.types != None:
GenerateParameterTypesHtml (function.returns.types, generator, entityLinks)
if function.returns.description != None:
generator.AddTagWithClass ('span', 'return_description', FinalizeDescription (function.returns.description, entityLinks))
generator.EndTag ('div')
generator.EndTag ('div')

36
tools/lib/html_generator.py Normal file
View File

@ -0,0 +1,36 @@
class HtmlGenerator:
def __init__ (self, eol):
self.html = ''
self.eol = eol
def AddText (self, content):
self.html += content
def AddLine (self, content):
self.AddText (content + self.eol)
def AddTag (self, tagName, content):
self.AddLine ('<{0}>{1}</{0}>'.format (tagName, content))
def AddTagWithClass (self, tagName, className, content):
self.AddLine ('<{0} class="{1}">{2}</{0}>'.format (tagName, className, content))
def AddTagWithAttributes (self, tagName, attributes, content):
line = '<{0}'.format (tagName);
if len (attributes) > 0:
attributeStrings = map (lambda x : '{0}="{1}"'.format (x[0], x[1]), attributes)
line += ' ' + ' '.join (attributeStrings)
line += '>{1}</{0}>'.format (tagName, content)
self.AddLine (line)
def BeginTag (self, tagName):
self.AddLine ('<{0}>'.format (tagName))
def BeginTagWithClass (self, tagName, className):
self.AddLine ('<{0} class="{1}">'.format (tagName, className))
def EndTag (self, tagName):
self.AddLine ('</{0}>'.format (tagName))
def GetHtml (self):
return self.html