Skip to content

Commit

Permalink
Added metadata json table back to the format spec. unsure of reason f… (
Browse files Browse the repository at this point in the history
#95)

* Added metadata json table back to the format spec.
* Update Indexed 3d Scene Layer Format Specification.md

Changed the folderPattern default to basic.

Co-authored-by: Richard Vargas <ric10786@esri.com>
Co-authored-by: Tamrat Belayneh <Tamrat-B@esri.com>
  • Loading branch information
3 people authored Aug 26, 2020
1 parent 8ae1479 commit 8799ca1
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion format/Indexed 3d Scene Layer Format Specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ The Indexed 3D Scene Layer (I3S) format is an open 3D content delivery format us
&emsp;[Scene Layer Packages](#SLPK) <br />
&emsp;&emsp;[1.7 SLPK Structure](#1.7-SLPK-Structure) <br />
&emsp;&emsp;[1.6 SLPK Structure](#1.6-SLPK-Structure) <br />
&emsp;&emsp;[Metadata](#metadata)<br />

# Introduction to Scene Layers <a name="introduction"></a>

Expand Down Expand Up @@ -257,7 +258,6 @@ Here are a few examples of SLPK file extensions:

In I3S verison 1.7, an [MD5](https://en.wikipedia.org/wiki/MD5) [hash](../docs/1.7/slpk_hashtable.cmn.md) is used to improve loading time. The hash must be the last item at the end of the central directory and named `@specialIndexFileHASH128@`.


#### Example 1.7 SLPK Structure Summary for 3D Objects <a name="1.7-SLPK-Structure"></a>

```
Expand Down Expand Up @@ -347,7 +347,41 @@ Paths are the same as in the API, but without the `layers/0` prefix. Exceptions
+--metadata.json
```

**Metadata**<a name="metadata"></a>

Scene layer packages (SLPK) contain metadata information regarding its content in the metadata.json file. The following entries are required and must be of the specified type.

|Property|Details|
|--------|-------|
|<b>folderPattern</b> | One of {BASIC, EXTENDED},<br> Default is {BASIC} |
|<b>archiveCompressionType</b> | One of {STORE, DEFLATE64, [DEFLATE]},<br>Default is {STORE} |
|<b>resourceCompressionType</b> | One of {GZIP, NONE}, Default is {GZIP} |
|<b>I3SVersion</b> | One of {1.2, 1.3, 1.4, 1.6, 1.7, 2.0},<br>Default is {1.7} (Point cloud is {2.0}) |
|<b>nodeCount</b> | Total number of nodes in the SLPK |

<br />

**Example of 1.7 Metadata json**
```
.\metadata.json
{
"folderPattern":"BASIC",
"archiveCompressionType":"STORE",
"resourceCompressionType":"GZIP",
"I3SVersion":"1.7",
"nodeCount":62
}
```

**Example of 2.0 Metadata json**
```
.\metadata.json
{
"folderPattern":"BASIC",
"archiveCompressionType":"STORE",
"resourceCompressionType":"GZIP",
"I3SVersion":"2.0",
"nodeCount":1156
}
```

0 comments on commit 8799ca1

Please sign in to comment.