Skip to content

Commit a7564c1

Browse files
chore(vectortile): update the api
#### vectortile:v1 The following keys were added: - resources.featuretiles.methods.get.parameters.alwaysIncludeBuildingFootprints (Total Keys: 2) - schemas.Area.properties.basemapZOrder (Total Keys: 1) - schemas.BasemapZOrder (Total Keys: 8) - schemas.Line.properties.basemapZOrder (Total Keys: 1)
1 parent 03d9bd2 commit a7564c1

File tree

2 files changed

+904
-853
lines changed

2 files changed

+904
-853
lines changed

docs/dyn/vectortile_v1.featuretiles.html

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h2>Instance Methods</h2>
7878
<code><a href="#close">close()</a></code></p>
7979
<p class="firstline">Close httplib2 connections.</p>
8080
<p class="toc_element">
81-
<code><a href="#get">get(name, clientInfo_apiClient=None, clientInfo_applicationId=None, clientInfo_applicationVersion=None, clientInfo_deviceModel=None, clientInfo_operatingSystem=None, clientInfo_platform=None, clientInfo_userId=None, clientTileVersionId=None, enableDetailedHighwayTypes=None, enableFeatureNames=None, enableModeledVolumes=None, enablePoliticalFeatures=None, enablePrivateRoads=None, enableUnclippedBuildings=None, languageCode=None, regionCode=None, x__xgafv=None)</a></code></p>
81+
<code><a href="#get">get(name, alwaysIncludeBuildingFootprints=None, clientInfo_apiClient=None, clientInfo_applicationId=None, clientInfo_applicationVersion=None, clientInfo_deviceModel=None, clientInfo_operatingSystem=None, clientInfo_platform=None, clientInfo_userId=None, clientTileVersionId=None, enableDetailedHighwayTypes=None, enableFeatureNames=None, enableModeledVolumes=None, enablePoliticalFeatures=None, enablePrivateRoads=None, enableUnclippedBuildings=None, languageCode=None, regionCode=None, x__xgafv=None)</a></code></p>
8282
<p class="firstline">Gets a feature tile by its tile resource name.</p>
8383
<h3>Method Details</h3>
8484
<div class="method">
@@ -87,11 +87,12 @@ <h3>Method Details</h3>
8787
</div>
8888

8989
<div class="method">
90-
<code class="details" id="get">get(name, clientInfo_apiClient=None, clientInfo_applicationId=None, clientInfo_applicationVersion=None, clientInfo_deviceModel=None, clientInfo_operatingSystem=None, clientInfo_platform=None, clientInfo_userId=None, clientTileVersionId=None, enableDetailedHighwayTypes=None, enableFeatureNames=None, enableModeledVolumes=None, enablePoliticalFeatures=None, enablePrivateRoads=None, enableUnclippedBuildings=None, languageCode=None, regionCode=None, x__xgafv=None)</code>
90+
<code class="details" id="get">get(name, alwaysIncludeBuildingFootprints=None, clientInfo_apiClient=None, clientInfo_applicationId=None, clientInfo_applicationVersion=None, clientInfo_deviceModel=None, clientInfo_operatingSystem=None, clientInfo_platform=None, clientInfo_userId=None, clientTileVersionId=None, enableDetailedHighwayTypes=None, enableFeatureNames=None, enableModeledVolumes=None, enablePoliticalFeatures=None, enablePrivateRoads=None, enableUnclippedBuildings=None, languageCode=None, regionCode=None, x__xgafv=None)</code>
9191
<pre>Gets a feature tile by its tile resource name.
9292

9393
Args:
9494
name: string, Required. Resource name of the tile. The tile resource name is prefixed by its collection ID `tiles/` followed by the resource ID, which encodes the tile&#x27;s global x and y coordinates and zoom level as `@,,z`. For example, `tiles/@1,2,3z`. (required)
95+
alwaysIncludeBuildingFootprints: boolean, Flag indicating whether the returned tile will always contain 2.5D footprints for structures. If enabled_modeled_volumes is set, this will mean that structures will have both their 3D models and 2.5D footprints returned.
9596
clientInfo_apiClient: string, API client name and version. For example, the SDK calling the API. The exact format is up to the client.
9697
clientInfo_applicationId: string, Application ID, such as the package name on Android and the bundle identifier on iOS platforms.
9798
clientInfo_applicationVersion: string, Application version number, such as &quot;1.2.3&quot;. The exact format is application-dependent.
@@ -136,7 +137,12 @@ <h3>Method Details</h3>
136137
&quot;displayName&quot;: &quot;A String&quot;, # The localized name of this feature. Currently only returned for roads.
137138
&quot;geometry&quot;: { # Represents the geometry of a feature, that is, the shape that it has on the map. The local tile coordinate system has the origin at the north-west (upper-left) corner of the tile, and is scaled to 4096 units across each edge. The height (Z) axis has the same scale factor: an extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on. There is no clipping boundary, so it is possible that some coordinates will lie outside the tile boundaries. # The geometry of this feature, representing the space that it occupies in the world.
138139
&quot;areas&quot;: [ # The areas present in this geometry.
139-
{ # Represents an area. Used to represent regions such as water, parks, etc.
140+
{ # Represents an area. Used to represent regions such as water, parks, etc. Next ID: 10
141+
&quot;basemapZOrder&quot;: { # Metadata necessary to determine the ordering of a particular basemap element relative to others. To render the basemap correctly, sort by z-plane, then z-grade, then z-within-grade. # The z-order of this geometry when rendered on a flat basemap. Geometry with a lower z-order should be rendered beneath geometry with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting. Unlike Area.z_order this can be used to compare with Line.basemap_z_order, and in fact may yield more accurate rendering (where a line may be rendered beneath an area).
142+
&quot;zGrade&quot;: 42, # The second most significant component of the ordering of a component to be rendered onto the basemap.
143+
&quot;zPlane&quot;: 42, # The most significant component of the ordering of a component to be rendered onto the basemap.
144+
&quot;zWithinGrade&quot;: 42, # The least significant component of the ordering of a component to be rendered onto the basemap.
145+
},
140146
&quot;hasExternalEdges&quot;: True or False, # True if the polygon is not entirely internal to the feature that it belongs to: that is, some of the edges are bordering another feature.
141147
&quot;internalEdges&quot;: [ # When has_external_edges is true, the polygon has some edges that border another feature. This field indicates the internal edges that do not border another feature. Each value is an index into the vertices array, and denotes the start vertex of the internal edge (the next vertex in the boundary loop is the end of the edge). If the selected vertex is the last vertex in the boundary loop, then the edge between that vertex and the starting vertex of the loop is internal. This field may be used for styling. For example, building parapets could be placed only on the external edges of a building polygon, or water could be lighter colored near the external edges of a body of water. If has_external_edges is false, all edges are internal and this field will be empty.
142148
42,
@@ -156,12 +162,17 @@ <h3>Method Details</h3>
156162
42,
157163
],
158164
},
159-
&quot;zOrder&quot;: 42, # The z-ordering of this area. Areas with a lower z-order should be rendered beneath areas with a higher z-order. This z-ordering does not imply anything about the altitude of the line relative to the ground, but it can be used to prevent z-fighting during rendering on the client. This z-ordering can only be used to compare areas, and cannot be compared with the z_order field in the Line message. The z-order may be negative or zero.
165+
&quot;zOrder&quot;: 42, # The z-ordering of this area. Areas with a lower z-order should be rendered beneath areas with a higher z-order. This z-ordering does not imply anything about the altitude of the line relative to the ground, but it can be used to prevent z-fighting during rendering on the client. This z-ordering can only be used to compare areas, and cannot be compared with the z_order field in the Line message. The z-order may be negative or zero. Prefer Area.basemap_z_order.
160166
},
161167
],
162-
&quot;extrudedAreas&quot;: [ # The extruded areas present in this geometry.
168+
&quot;extrudedAreas&quot;: [ # The extruded areas present in this geometry. Not populated if modeled_volumes are included in this geometry unless always_include_building_footprints is set in GetFeatureTileRequest, in which case the client should decide which (extruded areas or modeled volumes) should be used (they should not be rendered together).
163169
{ # Represents a height-extruded area: a 3D prism with a constant X-Y plane cross section. Used to represent extruded buildings. A single building may consist of several extruded areas. The min_z and max_z fields are scaled to the size of the tile. An extruded area with a max_z value of 4096 has the same height as the width of the tile that it is on.
164-
&quot;area&quot;: { # Represents an area. Used to represent regions such as water, parks, etc. # The area representing the footprint of the extruded area.
170+
&quot;area&quot;: { # Represents an area. Used to represent regions such as water, parks, etc. Next ID: 10 # The area representing the footprint of the extruded area.
171+
&quot;basemapZOrder&quot;: { # Metadata necessary to determine the ordering of a particular basemap element relative to others. To render the basemap correctly, sort by z-plane, then z-grade, then z-within-grade. # The z-order of this geometry when rendered on a flat basemap. Geometry with a lower z-order should be rendered beneath geometry with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting. Unlike Area.z_order this can be used to compare with Line.basemap_z_order, and in fact may yield more accurate rendering (where a line may be rendered beneath an area).
172+
&quot;zGrade&quot;: 42, # The second most significant component of the ordering of a component to be rendered onto the basemap.
173+
&quot;zPlane&quot;: 42, # The most significant component of the ordering of a component to be rendered onto the basemap.
174+
&quot;zWithinGrade&quot;: 42, # The least significant component of the ordering of a component to be rendered onto the basemap.
175+
},
165176
&quot;hasExternalEdges&quot;: True or False, # True if the polygon is not entirely internal to the feature that it belongs to: that is, some of the edges are bordering another feature.
166177
&quot;internalEdges&quot;: [ # When has_external_edges is true, the polygon has some edges that border another feature. This field indicates the internal edges that do not border another feature. Each value is an index into the vertices array, and denotes the start vertex of the internal edge (the next vertex in the boundary loop is the end of the edge). If the selected vertex is the last vertex in the boundary loop, then the edge between that vertex and the starting vertex of the loop is internal. This field may be used for styling. For example, building parapets could be placed only on the external edges of a building polygon, or water could be lighter colored near the external edges of a body of water. If has_external_edges is false, all edges are internal and this field will be empty.
167178
42,
@@ -181,14 +192,19 @@ <h3>Method Details</h3>
181192
42,
182193
],
183194
},
184-
&quot;zOrder&quot;: 42, # The z-ordering of this area. Areas with a lower z-order should be rendered beneath areas with a higher z-order. This z-ordering does not imply anything about the altitude of the line relative to the ground, but it can be used to prevent z-fighting during rendering on the client. This z-ordering can only be used to compare areas, and cannot be compared with the z_order field in the Line message. The z-order may be negative or zero.
195+
&quot;zOrder&quot;: 42, # The z-ordering of this area. Areas with a lower z-order should be rendered beneath areas with a higher z-order. This z-ordering does not imply anything about the altitude of the line relative to the ground, but it can be used to prevent z-fighting during rendering on the client. This z-ordering can only be used to compare areas, and cannot be compared with the z_order field in the Line message. The z-order may be negative or zero. Prefer Area.basemap_z_order.
185196
},
186197
&quot;maxZ&quot;: 42, # The z-value in local tile coordinates where the extruded area ends.
187198
&quot;minZ&quot;: 42, # The z-value in local tile coordinates where the extruded area begins. This is non-zero for extruded areas that begin off the ground. For example, a building with a skybridge may have an extruded area component with a non-zero min_z.
188199
},
189200
],
190201
&quot;lines&quot;: [ # The lines present in this geometry.
191202
{ # Represents a 2D polyline. Used to represent segments such as roads, train tracks, etc.
203+
&quot;basemapZOrder&quot;: { # Metadata necessary to determine the ordering of a particular basemap element relative to others. To render the basemap correctly, sort by z-plane, then z-grade, then z-within-grade. # The z-order of this geometry when rendered on a flat basemap. Geometry with a lower z-order should be rendered beneath geometry with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting. Unlike Line.z_order this can be used to compare with Area.basemap_z_order, and in fact may yield more accurate rendering (where a line may be rendered beneath an area).
204+
&quot;zGrade&quot;: 42, # The second most significant component of the ordering of a component to be rendered onto the basemap.
205+
&quot;zPlane&quot;: 42, # The most significant component of the ordering of a component to be rendered onto the basemap.
206+
&quot;zWithinGrade&quot;: 42, # The least significant component of the ordering of a component to be rendered onto the basemap.
207+
},
192208
&quot;vertexOffsets&quot;: { # 2D vertex list used for lines and areas. Each entry represents an offset from the previous one in local tile coordinates. The first entry is offset from (0, 0). For example, the list of vertices [(1,1), (2, 2), (1, 2)] would be encoded in vertex offsets as [(1, 1), (1, 1), (-1, 0)]. # The vertices present in the polyline.
193209
&quot;xOffsets&quot;: [ # List of x-offsets in local tile coordinates.
194210
42,
@@ -197,10 +213,10 @@ <h3>Method Details</h3>
197213
42,
198214
],
199215
},
200-
&quot;zOrder&quot;: 42, # The z-order of the line. Lines with a lower z-order should be rendered beneath lines with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting during rendering on the client. In general, larger and more important road features will have a higher z-order line associated with them. This z-ordering can only be used to compare lines, and cannot be compared with the z_order field in the Area message. The z-order may be negative or zero.
216+
&quot;zOrder&quot;: 42, # The z-order of the line. Lines with a lower z-order should be rendered beneath lines with a higher z-order. This z-ordering does not imply anything about the altitude of the area relative to the ground, but it can be used to prevent z-fighting during rendering on the client. In general, larger and more important road features will have a higher z-order line associated with them. This z-ordering can only be used to compare lines, and cannot be compared with the z_order field in the Area message. The z-order may be negative or zero. Prefer Line.basemap_z_order.
201217
},
202218
],
203-
&quot;modeledVolumes&quot;: [ # The modeled volumes present in this geometry.
219+
&quot;modeledVolumes&quot;: [ # The modeled volumes present in this geometry. Not populated unless enable_modeled_volumes has been set in GetFeatureTileRequest.
204220
{ # Represents a modeled volume in 3D space. Used to represent 3D buildings.
205221
&quot;strips&quot;: [ # The triangle strips present in this mesh.
206222
{ # Represents a strip of triangles. Each triangle uses the last edge of the previous one. The following diagram shows an example of a triangle strip, with each vertex labeled with its index in the vertex_index array. (1)-----(3) / \ / \ / \ / \ / \ / \ (0)-----(2)-----(4) Vertices may be in either clockwise or counter-clockwise order.

0 commit comments

Comments
 (0)