Interface ISubLayerExtrusionOptions

Namespace:Mapbox.Unity.SourceLayers

Assembly:cs.temp.dll.dll

Syntax

public interface ISubLayerExtrusionOptions

Methods

DisableExtrusion()

Disable mesh extrusion for the features in this layer.

Declaration

void DisableExtrusion()

EnableAbsoluteExtrusion(ExtrusionGeometryType, Single, Single)

Changes extrusion type to "Absolute height" and extrudes all features by the given fixed value.

Declaration

void EnableAbsoluteExtrusion(ExtrusionGeometryType extrusionGeometryType, float height, float extrusionScaleFactor = 1F)

Parameters

Type	Name	Description
ExtrusionGeometryType	extrusionGeometryType	Option to create top and side polygons after extrusion.
System.Single	height	Extrusion value
System.Single	extrusionScaleFactor	Height multiplier

EnableMaxExtrusion(ExtrusionGeometryType, String, Single)

Changes extrusion type to "Range Height" and extrudes all features by the choosen property's value such that all vertices (roof) will be flat at the highest vertex elevation (after terrain elevation taken into account).

Declaration

void EnableMaxExtrusion(ExtrusionGeometryType extrusionGeometryType, string propertyName = "height", float extrusionScaleFactor = 1F)

Parameters

Type	Name	Description
ExtrusionGeometryType	extrusionGeometryType	Option to create top and side polygons after extrusion.
System.String	propertyName	Name of the property to use for extrusion
System.Single	extrusionScaleFactor	Height multiplier

EnableMinExtrusion(ExtrusionGeometryType, String, Single)

Changes extrusion type to "Minimum Height" and extrudes all features by the choosen property's value such that all vertices (roof) will be flat at the lowest vertex elevation (after terrain elevation taken into account).

Declaration

void EnableMinExtrusion(ExtrusionGeometryType extrusionGeometryType, string propertyName = "height", float extrusionScaleFactor = 1F)

Parameters

Type	Name	Description
ExtrusionGeometryType	extrusionGeometryType	Option to create top and side polygons after extrusion.
System.String	propertyName	Name of the property to use for extrusion
System.Single	extrusionScaleFactor	Height multiplier

EnablePropertyExtrusion(ExtrusionGeometryType, String, Single)

Changes extrusion type to "Property" and extrudes all features by the choosen property's value.

Declaration

void EnablePropertyExtrusion(ExtrusionGeometryType extrusionGeometryType, string propertyName = "height", float extrusionScaleFactor = 1F)

Parameters

Type	Name	Description
ExtrusionGeometryType	extrusionGeometryType	Option to create top and side polygons after extrusion.
System.String	propertyName	Name of the property to use for extrusion
System.Single	extrusionScaleFactor	Height multiplier

EnableRangeExtrusion(ExtrusionGeometryType, Single, Single, Single)

Changes extrusion type to "Minimum Height" and extrudes all features by the choosen property's value such that they'll be in provided range. Lower values will be increase to Minimum Height and higher values will be lowered to Maximum height.

Declaration

void EnableRangeExtrusion(ExtrusionGeometryType extrusionGeometryType, float minHeight, float maxHeight, float extrusionScaleFactor = 1F)

Parameters

Type	Name	Description
ExtrusionGeometryType	extrusionGeometryType	Option to create top and side polygons after extrusion.
System.Single	minHeight	Lower bound to be used for extrusion
System.Single	maxHeight	Top bound to be used for extrusion
System.Single	extrusionScaleFactor	Height multiplier

SetAbsoluteHeight(Single)

Sets the height value to be used for Absolute Height extrusion type. Same field is used for the maximum height of Range Extrusion type so beware of possible side effects.

Declaration

void SetAbsoluteHeight(float absoluteHeight)

Parameters

Type	Name	Description
System.Single	absoluteHeight	Fixed height value for all features in the layer.

SetExtrusionMultiplier(Single)

Sets the extrusion multiplier which will be used only in the Y axis (height).

Declaration

void SetExtrusionMultiplier(float multiplier)

Parameters

Type	Name	Description
System.Single	multiplier	Multiplier value.

SetHeightRange(Single, Single)

Change the minimum and maximum height values used for Range Height option. Maximum height is also used for Absolute Height option so beware of possible side effects.

Declaration

void SetHeightRange(float minHeight, float maxHeight)

Parameters

Type	Name	Description
System.Single	minHeight	Lower bound to be used for extrusion
System.Single	maxHeight	Top bound to be used for extrusion