Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add 1.9 and 2.1 spec updates #158

Merged
merged 1 commit into from
Apr 13, 2023
Merged

Add 1.9 and 2.1 spec updates #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 78 additions & 55 deletions README.md
View file
Open in desktop

Large diffs are not rendered by default.

Binary file added docs/.DS_Store
View file
Open in desktop
Binary file not shown.
595 changes: 595 additions & 0 deletions docs/1.9/3DNodeIndexDocument.cmn.md
View file
Open in desktop

Large diffs are not rendered by default.

43 changes: 43 additions & 0 deletions docs/1.9/3DSceneLayer.cmn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# 3DSceneLayer [Common Profiles]

The 3DSceneLayerInfo describes the properties of a layer in a store. The store object describes the exact physical storage of a layer and enables the client to detect when multiple layers are served from the same store. Every scene layer contains 3DSceneLayerInfo. If features based scene layers, such as 3D objects or point scene layers, may include the default symbology. This is as specified in the drawingInfo, which contains styling information for a feature layer.

When generating 3D Objects or Integrated Mesh scene layers, the root node never has any geometry. Any node's children represent a higher LoD quality than an ancestor node. Nodes without geometry at the top of the tree are allowable since the lowest LoD of a feature/geometry is not to shown.

### Related:

[cmn::nodePage](nodePage.cmn.md)
### Properties

| Property | Type | Description |
| --- | --- | --- |
| **id** | integer | Unique numeric ID of the layer. |
| href | string | The relative URL to the 3DSceneLayerResource. Only present as part of the SceneServiceInfo resource. |
| **layerType** | string | The user-visible layer type<div>Possible values are:<ul><li>`3DObject`</li><li>`IntegratedMesh`</li></ul></div> |
| spatialReference | [spatialReference](spatialReference.cmn.md) | The spatialReference of the layer including the vertical coordinate reference system (CRS). Well Known Text (WKT) for CRS is included to support custom CRS. |
| heightModelInfo | [heightModelInfo](heightModelInfo.cmn.md) | Enables consuming clients to quickly determine whether this layer is compatible (with respect to its horizontal and vertical coordinate system) with existing content. |
| **version** | string | The ID of the last update session in which any resource belonging to this layer has been updated. |
| name | string | The name of this layer. |
| serviceUpdateTimeStamp | [serviceUpdateTimeStamp](serviceUpdateTimeStamp.cmn.md) | The time of the last update. |
| alias | string | The display alias to be used for this layer. |
| description | string | Description string for this layer. |
| copyrightText | string | Copyright and usage information for the data in this layer. |
| **capabilities** | string[] | Capabilities supported by this layer.<div>Possible values for each array string:<ul><li>`View`: View is supported.</li><li>`Query`: Query is supported.</li><li>`Edit`: Edit is defined.</li><li>`Extract`: Extract is defined.</li></ul></div> |
| ZFactor | number | ZFactor to define conversion factor for elevation unit. |
| cachedDrawingInfo | [cachedDrawingInfo](cachedDrawingInfo.cmn.md) | Indicates if any styling information represented as drawingInfo is captured as part of the binary mesh representation. This helps provide optimal client-side access. Currently the color component of the drawingInfo is supported. |
| drawingInfo | [drawingInfo](drawingInfo.cmn.md) | An object containing drawing information. |
| elevationInfo | [elevationInfo](elevationInfo.cmn.md) | An object containing elevation drawing information. If absent, any content of the scene layer is drawn at its z coordinate. |
| popupInfo | [popupInfo](popupInfo.cmn.md) | PopupInfo of the scene layer. |
| disablePopup | boolean | Indicates if client application will show the popup information. Default is FALSE. |
| **store** | [store](store.cmn.md) | The store object describes the exact physical storage of a layer and enables the client to detect when multiple layers are served from the same store. |
| fields | [field](field.cmn.md)[] | A collection of objects that describe each attribute field regarding its field name, datatype, and a user friendly name {name,type,alias}. It includes all fields that are included as part of the scene layer as derived from a source input feature layer. |
| attributeStorageInfo | [attributeStorageInfo](attributeStorageInfo.cmn.md)[] | Provides the schema and layout used for storing attribute content in binary format in I3S. |
| statisticsInfo | [statisticsInfo](statisticsInfo.cmn.md)[] | Contains the statistical information for a layer. |
| nodePages | [nodePageDefinition](nodePageDefinition.cmn.md) | The paged-access index description. |
| materialDefinitions | [materialDefinitions](materialDefinitions.cmn.md)[] | List of materials classes used in this layer. |
| textureSetDefinitions | [textureSetDefinition](textureSetDefinition.cmn.md)[] | Defines the set of textures that can be referenced by meshes. |
| **geometryDefinitions** | [geometryDefinition](geometryDefinition.cmn.md)[] | Define the layouts of mesh geometry and its attributes. |
| fullExtent | [fullExtent](fullExtent.cmn.md) | 3D extent. If ```layer.fullExtent.spatialReference``` is specified, it must match ```layer.spatialReference```. |

*Note: properties in **bold** are required*

36 changes: 36 additions & 0 deletions docs/1.9/3DSceneLayer.psl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 3DSceneLayer [Point Profile]

The 3DSceneLayerInfo object describes the properties of a layer in a store. Every scene layer contains 3DSceneLayerInfo. For features based scene layers, such as 3D objects or point scene layers, may include the default symbology, as specified in the drawingInfo, which contains stylization information for a feature layer.

### Properties

| Property | Type | Description |
| --- | --- | --- |
| **id** | integer | Unique numeric ID of the layer. |
| href | string | The relative URL to the 3DSceneLayerResource. Only present as part of the SceneServiceInfo resource. |
| **layerType** | string | The user-visible layer type.<div>Must be:<ul><li>`Point`</li></ul></div> |
| spatialReference | [spatialReference](spatialReference.cmn.md) | The spatialReference of the layer including the vertical coordinate reference system (CRS). Well Known Text (WKT) for CRS is included to support custom CRS. |
| heightModelInfo | [heightModelInfo](heightModelInfo.cmn.md) | Enables consuming clients to quickly determine whether this layer is compatible (with respect to its horizontal and vertical coordinate system) with existing content. |
| **version** | string | The ID of the last update session in which any resource belonging to this layer has been updated. |
| name | string | The name of this layer. |
| serviceUpdateTimeStamp | [serviceUpdateTimeStamp](serviceUpdateTimeStamp.cmn.md) | The time of the last update. |
| alias | string | The display alias to be used for this layer. |
| description | string | Description string for this layer. |
| copyrightText | string | Copyright and usage information for the data in this layer. |
| **capabilities** | string[] | Capabilities supported by this layer.<div>Possible values for each array string:<ul><li>`View`: View is supported.</li><li>`Query`: Query is supported.</li><li>`Edit`: Edit is defined.</li><li>`Extract`: Extract is defined.</li></ul></div> |
| ZFactor | number | ZFactor to define conversion factor for elevation unit. |
| cachedDrawingInfo | [cachedDrawingInfo](cachedDrawingInfo.cmn.md) | Indicates if any styling information represented as drawingInfo is captured as part of the binary mesh representation. This helps provide optimal client-side access. Currently the color component of the drawingInfo is supported. |
| drawingInfo | [drawingInfo](drawingInfo.cmn.md) | An object containing drawing information. |
| elevationInfo | [elevationInfo](elevationInfo.cmn.md) | An object containing elevation drawing information. If absent, any content of the scene layer is drawn at its z coordinate. |
| popupInfo | [popupInfo](popupInfo.cmn.md) | PopupInfo of the scene layer. |
| disablePopup | boolean | Indicates if client application will show the popup information. Default is FALSE. |
| **store** | [store](store.psl.md) | The store object describes the exact physical storage of a layer and enables the client to detect when multiple layers are served from the same store. |
| fields | [field](field.cmn.md)[] | A collection of objects that describe each attribute field regarding its field name, datatype, and a user friendly name {name,type,alias}. It includes all fields that are included as part of the scene layer as derived from a source input feature layer. |
| attributeStorageInfo | [attributeStorageInfo](attributeStorageInfo.cmn.md)[] | Provides the schema and layout used for storing attribute content in binary format in I3S. |
| statisticsInfo | [statisticsInfo](statisticsInfo.cmn.md)[] | Contains the statistical information for a layer. |
| pointNodePages | [nodePageDefinition](nodePageDefinition.cmn.md) | The paged-access index description. For legacy purposes, this property is called pointNodePages in [Point Scene Layers](3DSceneLayer.psl.md). |
| **geometryDefinition** | [geometryDefinition](geometryDefinition.psl.md) | Define the layouts of point geometry and its attributes. |
| fullExtent | [fullExtent](fullExtent.cmn.md) | 3D extent. If ```layer.fullExtent.spatialReference``` is specified, it must match ```layer.spatialReference```. |

*Note: properties in **bold** are required*

272 changes: 272 additions & 0 deletions docs/1.9/3Dobject_ReadMe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,272 @@
# 3D Object Scene Layer (1.9)

A 3D object scene layer is used to visualize 3D objects. 3D object scene layers are often created from GIS data with attributes and explicitly modeled in 3D. These attributes allow definition queries to specify symbology and other properties in lieu of setting properties for each object individually. A 3D object scene layer can efficiently create and share just a few buildings or an entire city.

**Examples**:<br />

New York LoD2 3D Buildings [SLPK](https://3dcities.maps.arcgis.com/home/item.html?id=3b3681b2476c4c31b2d187bebb0a1645).<br />
New York LoD2 3D Buildings [service](https://3dcities.maps.arcgis.com/home/item.html?id=fb47ee2fe4bb496f94dfcba5584e948c).<br />

Montreal, Canada textured buildings [SLPK](https://3dcities.maps.arcgis.com/home/item.html?id=2152b475da9542698d4fa42bc4efaf8d).<br />
Montreal, Canada textured buildings [service](https://3dcities.maps.arcgis.com/home/item.html?id=55f4164d43984e64b2cd2d36cd7cef53).<br />

*Realistic 3D Object Scene Layer with textures*

![Realistic 3D Object Scene Layer with textures](../img/LyonTextured.png)

*Thematic 3D Object Scene Layer without textures*

![Thematic 3D Object Scene Layer without textures](../img/LyonThematic.png)

## 3D Object Scene Layer Structure
The 3D object scene layer is structured into a tree of multiple JSON files. A 3D object scene layer can be represented as a scene layer package (*.slpk) or a I3S service. A 3D object scene layer contains the following:

- [3DSceneLayer](3DSceneLayer.cmn.md)
- [nodePage](nodePage.cmn.md)
- geometryBuffer (binary)
- attributesBuffer (binary)
- textures (binary)
- [statistics](stats.cmn.md)
- [3DNodeIndexDocument](3DNodeIndexDocument.cmn.md)*
- [sharedResource](sharedResource.cmn.md)*
- features^

3D object scene layer packages contain [metadata](metadata.cmn.md) and optionally contain a [hash table](slpk_hashtable.cmn.md) for faster indexing.

*Example of 3DObject layer structure*

```
.<host>/SceneServer/layers
+--0 // scene layer document
+-- nodePages
| +-- 0
| +-- (...)
+-- nodes
| +--0
| | +-- attributes
| | | +--f_2
| | | +--f_4
| | | +--(...)
| | +-- geometries
| | | +-- 0
| | | +-- 1
| | | +--(...)
| | +-- textures
| | | +-- 0
| | | +-- 0_0_1
| | | +--(...)
| | +-- 3dNodeIndexDocument*
| | +-- shared*
| | +-- features^
| | | +-- 0
| | (...)
+--statistics
| +-- f_2
| +-- f_4
| +-- (...)
```

_* Only required for 1.6 compatability for older clients._ <br />
_^ Not used by client. Human readable version of the features._ <br />



# HTTP API Overview

Version 1.9 is backwards compatible with 1.6+. For older clients to be able to read 1.7+, sharedResources and the 3DNodeIndexDocument resources are included.


The following API methods are available for 3D Object scene layer:

**Scene layer document**

<table>
<tr>
<td>Type</td>
<td>JSON</td>
</tr>
<tr>
<td>URL Template</td>
<td>http://serviceURL/layers/{layerID}</td>
</tr>
<tr>
<td>Example</td>
<td>http://my.server.com/3DObjectSceneLayer/SceneServer/layers/0</td>
</tr>
<tr>
<td>Description</td>
<td>This is the root document for the service containing properties common to the entire layer.<br/>
<code>layerID</code>: Integer. ID of the associated layer. Esri products expect this to be `0`.</td>
</tr>
</table>

[3DSceneLayer](3DSceneLayer.cmn.md)

**Node page** <br />

<table>
<tr>
<td>Type</td>
<td>JSON</td>
</tr>
<tr>
<td>URL Template</td>
<td>http://serviceURL/layers/{layerID}/nodepages/{nodePageID}</td>
</tr>
<tr>
<td>Example</td>
<td>http://my.server.com/3DObjectSceneLayer/SceneServer/layers/0/nodepages/8</td>
</tr>
<tr>
<td>Description</td>
<td><code>layerID</code>: Integer. ID of the associated layer. Esri products expect this to be `0`.<br/>
<code>nodePageID</code>: Integer. ID of the associated node page.</td>
</tr>
</table>

[nodePage](nodePage.cmn.md)

**Texture**
<table>
<tr>
<td>Type</td>
<td>JPG, PNG, DDS, KTX </td>
</tr>
<tr>
<td>URL Template</td>
<td>http://serviceURL/layers/{layerID}/nodes/{nodeID}/textures/{textureID}</td>
</tr>
<tr>
<td>Example</td>
<td>http://my.server.com/3DObjectSceneLayer/SceneServer/layers/0/nodes/98/textures/0_0_1 </td>
</tr>
<tr>
<td>Description</td>
<td>The texture resource (image). <br/>
<code>layerID</code> Integer. ID of the associated layer. Esri products expect this to be `0`. <br/>
<code>nodeID</code> Integer. ID of the associated node. <br/>
<code>textureID</code> String. This ID returns one of the textures available for this node. The same texture may be available in different formats.</td>
</tr>
</table>

**Geometry**
<table>
<tr>
<td>Type</td>
<td>bin, draco</td>
</tr>
<tr>
<td>URL Template</td>
<td>http://serviceURL/layers/{layerID}/nodes/{nodeID}/geometries/{geometryID}</td>
</tr>
<tr>
<td>Example</td>
<td>http://my.server.com/3DObjectSceneLayer/SceneServer/layers/0/nodes/98/geometries/1 </td>
</tr>
<tr>
<td>Description</td>
<td>The geometry resource (mesh information). <br/>
<code>layerID</code> Integer. ID of the associated layer. Esri products expect this to be `0`. <br/>
<code>nodeID</code> Integer. ID of the associated node. <br/>
<code>geometryID</code> Integer. This ID returns one of the geometries available for this node. The same geometry may be available in a different format. </td>
</tr>
</table>

**Attributes**
<table>
<tr>
<td>Type</td>
<td>bin</td>
</tr>
<tr>
<td>URL Template</td>
<td>http://serviceURL/layers/{layerID}/nodes/{nodeID}/attributes/f_{attributeID}/0</td>
</tr>
<tr>
<td>Example</td>
<td>http://my.server.com/3DObjectSceneLayer/SceneServer/layers/0/nodes/2/attributes/f_5/0 </td>
</tr>
<tr>
<td>Description</td>
<td>The value for a specific attribute within a node. <br/>
<code>layerID</code> Integer. ID of the associated layer. Esri products expect this to be `0`. <br/>
<code>nodeID</code> Integer. ID of the associated node. <br/>
<code>attributeID</code> Integer. ID of the specific attribute for the layer. </td>
</tr>
</table>

**Statistics**
<table>
<tr>
<td>Type</td>
<td>JSON</td>
</tr>
<tr>
<td>URL Template</td>
<td>http://serviceURL/layers/{layerID}/statistics/f_{attributeID}/0</td>
</tr>
<tr>
<td>Example</td>
<td>http://my.server.com/3DObjectSceneLayer/SceneServer/layers/0/statistics/f_5/0 </td>
</tr>
<tr>
<td>Description</td>
<td>The statistics for the entire layer for a specific attribute. <br/>
<code>layerID</code> Integer. ID of the associated layer. Esri products expect this to be `0`.<br/>
<code>attributeID</code> Integer. ID of the specific attribute for the layer. </td>
</tr>
</table>

[Statistics](statsInfo.cmn.md)

## HTTP API included for backward compatibility with 1.6

**Shared resources**
<table>
<tr>
<td>Type</td>
<td>JSON</td>
</tr>
<tr>
<td>URL Template</td>
<td>http://serviceURL/layers/{layerID}/nodes/{nodeID}/shared</td>
</tr>
<tr>
<td>Example</td>
<td>http://my.server.com/3DObjectSceneLayer/SceneServer/layers/0/nodes/98/shared </td>
</tr>
<tr>
<td>Description</td>
<td>Legacy texture and material description. **Not used in 1.7+.**. <br/>
<code>layerID</code> Integer. ID of the associated layer. ArcGIS clients expect this to be `0`. <br/>
<code>nodeID</code> Integer. ID of the associated node. </td>
</tr>
</table>

[Shared Resources](sharedResource.cmn.md)

**3D node index document**

<table>
<tr>
<td>Type</td>
<td>JSON</td>
</tr>
<tr>
<td>URL Template</td>
<td>http://serviceURL/layers/{layerID}/nodes/{nodeID}</td>
</tr>
<tr>
<td>Example</td>
<td>http://my.server.com/3DObjectSceneLayer/SceneServer/layers/0/nodes/98</td>
</tr>
<tr>
<td>Description</td>
<td>Description of the node. **Not used in 1.7+.**<br/>
<code>layerID</code> Integer. ID of the associated layer. Esri clients expect this to be `0`.<br/>
<code>nodeID</code> Integer. ID of the associated resource.</td>
</tr>
</table>

[3DNodeIndexDocument](3DNodeIndexDocument.cmn.md)

Loading