Interface IVectorDataLayer
Inherited Members
Namespace:Mapbox.Unity.Map
Assembly:cs.temp.dll.dll
Syntax
public interface IVectorDataLayer : ILayerMethods
AddCustomFeatureSubLayer(String, String)
Adds feature sub layer for rendering using a custom pipeline. Custom Feature Sub Layer should be used with custom modifiers to leverage the layer data or render it using a non-standard pipeline.
Declaration
void AddCustomFeatureSubLayer(string assignedSubLayerName, string dataLayerNameInService)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | assignedSubLayerName | Assigned sub layer name. |
| System.String | dataLayerNameInService | Data layer name in service. |
AddFeatureSubLayer(VectorSubLayerProperties)
Declaration
void AddFeatureSubLayer(VectorSubLayerProperties subLayerProperties)Parameters
| Type | Name | Description |
|---|---|---|
| VectorSubLayerProperties | subLayerProperties |
AddLayerSource(String)
Adds the provided Data Source (Tileset ID) to existing ones. For multiple
sources, you can separate with a comma. Tileset ID string is added at the
end of the existing sources.
Declaration
void AddLayerSource(string vectorSource)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | vectorSource |
|
AddLineFeatureSubLayer(String, String, Single)
Adds a sub layer to render line features. Default settings include : LineWidth = 1 Extrusion = true ExtrusionType = AbsoluteHeight ExtrusionGeometryType = Roof And Sides Testuring = Dark.
Declaration
void AddLineFeatureSubLayer(string assignedSubLayerName, string dataLayerNameInService, float lineWidth = 1F)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | assignedSubLayerName | Assigned sub layer name. |
| System.String | dataLayerNameInService | Data layer name in service. |
| System.Single | lineWidth | Line width. |
AddPointFeatureSubLayer(String, String)
Adds a sub layer to render point features.
Declaration
void AddPointFeatureSubLayer(string assignedSubLayerName, string dataLayerNameInService)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | assignedSubLayerName | Assigned sub layer name. |
| System.String | dataLayerNameInService | Data layer name in service. |
AddPointsOfInterestSubLayer(PrefabItemOptions)
Declaration
void AddPointsOfInterestSubLayer(PrefabItemOptions poiLayerProperties)Parameters
| Type | Name | Description |
|---|---|---|
| PrefabItemOptions | poiLayerProperties |
AddPolygonFeatureSubLayer(String, String)
Adds a sub layer to render polygon features. Default settings include : Extrusion = true ExtrusionType = PropertyHeight ExtrusionGeometryType = Roof And Sides Testuring = Realistic.
Declaration
void AddPolygonFeatureSubLayer(string assignedSubLayerName, string dataLayerNameInService)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | assignedSubLayerName | Assigned sub layer name. |
| System.String | dataLayerNameInService | Data layer name in service. |
DisableVectorFeatureProcessingWithCoroutines()
Disables processing of vector features on coroutines.
Declaration
void DisableVectorFeatureProcessingWithCoroutines()EnableVectorFeatureProcessingWithCoroutines(Int32)
Enables coroutines for vector features. Processes the specified amount of them each frame.
Declaration
void EnableVectorFeatureProcessingWithCoroutines(int entityPerCoroutine = 20)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | entityPerCoroutine | Numbers of features to process each frame. |
FindFeatureSubLayerWithName(String)
Declaration
VectorSubLayerProperties FindFeatureSubLayerWithName(string featureLayerName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | featureLayerName |
Returns
| Type | Description |
|---|---|
| VectorSubLayerProperties |
FindPointsofInterestSubLayerWithName(String)
Declaration
PrefabItemOptions FindPointsofInterestSubLayerWithName(string poiLayerName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | poiLayerName |
Returns
| Type | Description |
|---|---|
| PrefabItemOptions |
GetAllFeatureSubLayers()
Declaration
IEnumerable<VectorSubLayerProperties> GetAllFeatureSubLayers()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<VectorSubLayerProperties> |
GetAllLineFeatureSubLayers()
Declaration
IEnumerable<VectorSubLayerProperties> GetAllLineFeatureSubLayers()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<VectorSubLayerProperties> |
GetAllPointFeatureSubLayers()
Declaration
IEnumerable<VectorSubLayerProperties> GetAllPointFeatureSubLayers()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<VectorSubLayerProperties> |
GetAllPointsOfInterestSubLayers()
Declaration
IEnumerable<PrefabItemOptions> GetAllPointsOfInterestSubLayers()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<PrefabItemOptions> |
GetAllPolygonFeatureSubLayers()
Declaration
IEnumerable<VectorSubLayerProperties> GetAllPolygonFeatureSubLayers()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<VectorSubLayerProperties> |
GetFeatureSubLayerAtIndex(Int32)
Declaration
VectorSubLayerProperties GetFeatureSubLayerAtIndex(int i)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | i |
Returns
| Type | Description |
|---|---|
| VectorSubLayerProperties |
GetFeatureSubLayerByQuery(Func<VectorSubLayerProperties, Boolean>)
Declaration
IEnumerable<VectorSubLayerProperties> GetFeatureSubLayerByQuery(Func<VectorSubLayerProperties, bool> query)Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<VectorSubLayerProperties, System.Boolean> | query |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<VectorSubLayerProperties> |
GetPointsOfInterestSubLayerAtIndex(Int32)
Declaration
PrefabItemOptions GetPointsOfInterestSubLayerAtIndex(int i)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | i |
Returns
| Type | Description |
|---|---|
| PrefabItemOptions |
GetPointsOfInterestSubLayerByQuery(Func<PrefabItemOptions, Boolean>)
Declaration
IEnumerable<PrefabItemOptions> GetPointsOfInterestSubLayerByQuery(Func<PrefabItemOptions, bool> query)Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<PrefabItemOptions, System.Boolean> | query |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<PrefabItemOptions> |
GetTileJsonData()
Declaration
TileJsonData GetTileJsonData()Returns
| Type | Description |
|---|---|
| TileJsonData |
RemoveFeatureSubLayer(VectorSubLayerProperties)
Declaration
void RemoveFeatureSubLayer(VectorSubLayerProperties layer)Parameters
| Type | Name | Description |
|---|---|---|
| VectorSubLayerProperties | layer |
RemoveFeatureSubLayerWithName(String)
Declaration
void RemoveFeatureSubLayerWithName(string featureLayerName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | featureLayerName |
RemovePointsOfInterestSubLayer(PrefabItemOptions)
Declaration
void RemovePointsOfInterestSubLayer(PrefabItemOptions layer)Parameters
| Type | Name | Description |
|---|---|---|
| PrefabItemOptions | layer |
RemovePointsOfInterestSubLayerWithName(String)
Declaration
void RemovePointsOfInterestSubLayerWithName(string poiLayerName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | poiLayerName |
SetLayerSource(VectorSourceType)
Gets the Data Source for the MAP LAYERS section.
Declaration
void SetLayerSource(VectorSourceType vectorSource)Parameters
| Type | Name | Description |
|---|---|---|
| VectorSourceType | vectorSource |
SetLayerSourceWithOptimizedStyle(VectorSourceType, String, String, String)
Sets the layer source as Style-optimized vector tiles
Declaration
void SetLayerSourceWithOptimizedStyle(VectorSourceType vectorSource, string styleId, string modifiedDate, string styleName = null)Parameters
| Type | Name | Description |
|---|---|---|
| VectorSourceType | vectorSource | Vector source. |
| System.String | styleId | Style-Optimized style id. |
| System.String | modifiedDate | Modified date. |
| System.String | styleName | Style name. |
SetLayerSourceWithOptimizedStyle(String, String, String, String)
Sets the layer source as Style-optimized vector tiles
Declaration
void SetLayerSourceWithOptimizedStyle(string vectorSource, string styleId, string modifiedDate, string styleName = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | vectorSource | Vector source. |
| System.String | styleId | Style-Optimized style id. |
| System.String | modifiedDate | Modified date. |
| System.String | styleName | Style name. |
SpawnPrefabAtGeoLocation(GameObject, Vector2d, Action<List<GameObject>>, Boolean, String)
Places a prefab at the specified LatLon on the Map.
Declaration
void SpawnPrefabAtGeoLocation(GameObject prefab, Vector2d LatLon, Action<List<GameObject>> callback = null, bool scaleDownWithWorld = true, string locationItemName = "New Location")Parameters
| Type | Name | Description |
|---|---|---|
| GameObject | prefab | A Game Object Prefab. |
| Vector2d | LatLon | A Vector2d(Latitude Longitude) object |
| System.Action<System.Collections.Generic.List<GameObject>> | callback | |
| System.Boolean | scaleDownWithWorld | |
| System.String | locationItemName |
SpawnPrefabAtGeoLocation(GameObject, Vector2d[], Action<List<GameObject>>, Boolean, String)
Places a prefab at all locations specified by the LatLon array.
Declaration
void SpawnPrefabAtGeoLocation(GameObject prefab, Vector2d[] LatLon, Action<List<GameObject>> callback = null, bool scaleDownWithWorld = true, string locationItemName = "New Location")Parameters
| Type | Name | Description |
|---|---|---|
| GameObject | prefab | A Game Object Prefab. |
| Vector2d[] | LatLon | A Vector2d(Latitude Longitude) object |
| System.Action<System.Collections.Generic.List<GameObject>> | callback | |
| System.Boolean | scaleDownWithWorld | |
| System.String | locationItemName |
SpawnPrefabByCategory(GameObject, LocationPrefabCategories, Int32, Action<List<GameObject>>, Boolean, String)
Places the prefab for supplied categories.
Declaration
void SpawnPrefabByCategory(GameObject prefab, LocationPrefabCategories categories = LocationPrefabCategories.AnyCategory, int density = 30, Action<List<GameObject>> callback = null, bool scaleDownWithWorld = true, string locationItemName = "New Location")Parameters
| Type | Name | Description |
|---|---|---|
| GameObject | prefab | GameObject Prefab |
| LocationPrefabCategories | categories | LocationPrefabCategories For more than one category separate them by pipe (eg: LocationPrefabCategories.Food | LocationPrefabCategories.Nightlife) |
| System.Int32 | density | Density controls the number of POIs on the map.(Integer value between 1 and 30) |
| System.Action<System.Collections.Generic.List<GameObject>> | callback | |
| System.Boolean | scaleDownWithWorld | Should the prefab scale up/down along with the map game object? |
| System.String | locationItemName | Name of this location prefab item for future reference |
SpawnPrefabByName(GameObject, String, Int32, Action<List<GameObject>>, Boolean, String)
Places the prefab at POI locations if its name contains the supplied string GameObject Prefab This is the string that will be checked against the POI name to see if is contained in it, and ony those POIs will be spawned Density (Integer value between 1 and 30) Name of this location prefab item for future reference Should the prefab scale up/down along with the map game object?
Declaration
void SpawnPrefabByName(GameObject prefab, string nameString, int density = 30, Action<List<GameObject>> callback = null, bool scaleDownWithWorld = true, string locationItemName = "New Location")Parameters
| Type | Name | Description |
|---|---|---|
| GameObject | prefab | |
| System.String | nameString | |
| System.Int32 | density | |
| System.Action<System.Collections.Generic.List<GameObject>> | callback | |
| System.Boolean | scaleDownWithWorld | |
| System.String | locationItemName |