references to external material

Adds references to external material.

* Logo and docs in the readme
* OpenVDBDocumentation[], which can open the docs in a web browser or download them locally.

Signed-off-by: ghurstunither <[email protected]>

Author: ghurstunither

openvdb_wolfram/OpenVDBLink/OpenVDBLink.m

@@ -35,10 +35,16 @@
 PackageExport["$OpenVDBInstallationDirectory"]
 
 
+PackageExport["OpenVDBDocumentation"]
+
+
 $OpenVDBLibrary::usage = "$OpenVDBLibrary is the full path to the OpenVDB Library loaded by OpenVDBLink.";
 $OpenVDBInstallationDirectory::usage = "$OpenVDBInstallationDirectory gives the top-level directory in which your OpenVDB installation resides.";
 
 
+OpenVDBDocumentation::usage = "OpenVDBDocumentation[] opens the OpenVDBLink documentation.\nOpenVDBDocumentation[\"Web\"] opens the OpenVDBLink in a web browser.";
+
+
 OpenVDBLink`Developer`Recompile::usage = "OpenVDBLink`Developer`Recompile[] recompiles the OpenVDB library and reloads the functions.";
 
 
@@ -1214,3 +1220,125 @@
 
 
 carefulPixelGridQ[vdb_] := OpenVDBGridQ[vdb] && pixelGridQ[vdb]
+
+
+(* ::Section:: *)
+(*Documentation*)
+
+
+(* ::Subsection::Closed:: *)
+(*OpenVDBDocumentation*)
+
+
+(* ::Subsubsection::Closed:: *)
+(*OpenVDBDocumentation*)
+
+
+OpenVDBDocumentation[args___] /; !CheckArgs[OpenVDBDocumentation[args], {0, 1}] = $Failed;
+
+
+OpenVDBDocumentation[args___] :=
+    With[{res = iOpenVDBDocumentation[args]},
+        res /; res =!= $Failed
+    ]
+
+
+OpenVDBDocumentation[args___] := mOpenVDBDocumentation[args]
+
+
+(* ::Subsubsection::Closed:: *)
+(*iOpenVDBDocumentation*)
+
+
+iOpenVDBDocumentation[] := iOpenVDBDocumentation["Notebook"]
+
+
+iOpenVDBDocumentation["Web"] := SystemOpen[$vdbWebDocURL]
+
+
+iOpenVDBDocumentation["Notebook"] := notebookDocumentation[]
+
+
+iOpenVDBDocumentation["Update"] := 
+	(
+		Quiet[DeleteFile[$vdbDoc]];
+		notebookDocumentation[]
+	)
+
+
+iOpenVDBDocumentation[___] = $Failed;
+
+
+(* ::Subsubsection::Closed:: *)
+(*Argument conform & completion*)
+
+
+SyntaxInformation[OpenVDBDocumentation] = {"ArgumentsPattern" -> {_.}};
+
+
+addCodeCompletion[OpenVDBDocumentation][{"Web", "Notebook", "Update"}];
+
+
+(* ::Subsubsection::Closed:: *)
+(*notebookDocumentation*)
+
+
+notebookDocumentation[] /; FileExistsQ[$vdbDoc] := NotebookOpen[$vdbDoc]
+
+
+notebookDocumentation[] := 
+	Block[{zip},
+		If[!FileExistsQ[$vdbDocDir],
+			CreateDirectory[$vdbDocDir];
+		];
+		
+		zip = URLDownload[$vdbDocURL, $vdbDocDir];
+		(
+			Quiet[
+				ExtractArchive[zip, $vdbDocDir, FileNameTake[$vdbDoc]];
+				DeleteFile[zip];
+			];
+			
+			NotebookOpen[$vdbDoc] /; FileExistsQ[$vdbDoc]
+			
+		) /; FileExistsQ[zip]
+	]
+
+
+notebookDocumentation[___] = $Failed;
+
+
+(* ::Subsubsection::Closed:: *)
+(*Documentation paths and URLs*)
+
+
+$vdbDocDir = FileNameJoin[{$UserBaseDirectory, "ApplicationData", "OpenVDBLink"}];
+
+
+$vdbDoc = FileNameJoin[{$vdbDocDir, "OpenVDBLink.nb"}];
+
+
+$vdbDocURL = "https://www.openvdb.org/download/files/OpenVDBLink.nb.zip";
+
+
+$vdbWebDocURL = "https://www.openvdb.org/documentation/wolfram";
+
+
+(* ::Subsubsection::Closed:: *)
+(*Messages*)
+
+
+mOpenVDBDocumentation[type_] :=
+    (
+        If[type =!= "Web" && type =!= "Notebook",
+            Message[OpenVDBDocumentation::type, type, 1];
+        ];
+
+        $Failed
+    )
+
+
+mOpenVDBDocumentation[___] = $Failed;
+
+
+OpenVDBDocumentation::type = "`1` at position `2` is not one of \"Web\", \"Notebook\", or \"Update\".";

openvdb_wolfram/OpenVDBLink/Readme.md

@@ -1,4 +1,4 @@
-logo?
+![OpenVDBLink](https://www.openvdb.org/images/openvdblink_logo.png)
 
 # OpenVDBLink
 OpenVDBLink provides a Mathematica interface to [OpenVDB](https://www.openvdb.org), an efficient sparse voxel data structure ubiquitous in the VFX industry. This link ports over access to various grid containers including level sets, fog volumes, vector grids, integer grids, Boolean grids, and mask grids. Construction, modification, combinations, visualisations, queries, import, export, etc. can be achieved over grids too. Any Mathematica 3D region that's ConstantRegionQ and BoundedRegionQ can be represented as a level set grid, providing a more seamless integration with OpenVDB.
@@ -13,7 +13,9 @@ OpenVDB is an Academy Award-winning open-source C++ library comprising a novel h
 
 ### Documentation
 
-* [URL to docs?](.....)
+* [Web version](https://www.openvdb.org/documentation/wolfram)
+* [Notebook version](https://www.openvdb.org/download/files/OpenVDBLink.nb.zip)
+* Access documentation in a Wolfram notebook with `OpenVDBDocumentation[]`.
 
 ### Loading