Class GeometryExtrusionOptions

Inheritance
System.Object
MapboxDataProperty
ModifierProperties
GeometryExtrusionOptions
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace:Mapbox.Unity.Map
Assembly:cs.temp.dll.dll
Syntax
[Serializable]
public class GeometryExtrusionOptions : ModifierProperties, ISubLayerExtrusionOptions

Fields

extrusionGeometryType

Declaration
public ExtrusionGeometryType extrusionGeometryType
Field Value
Type Description
ExtrusionGeometryType

extrusionScaleFactor

Declaration
public float extrusionScaleFactor
Field Value
Type Description
System.Single

extrusionType

Declaration
public ExtrusionType extrusionType
Field Value
Type Description
ExtrusionType

maximumHeight

Declaration
public float maximumHeight
Field Value
Type Description
System.Single

minimumHeight

Declaration
public float minimumHeight
Field Value
Type Description
System.Single

propertyDescription

Declaration
public string propertyDescription
Field Value
Type Description
System.String

propertyName

Declaration
public string propertyName
Field Value
Type Description
System.String

Properties

ModifierType

Declaration
public override Type ModifierType { get; }
Property Value
Type Description
System.Type
Overrides

Methods

DisableExtrusion()

Disable mesh extrusion for the features in this layer.

Declaration
public virtual void DisableExtrusion()

EnableAbsoluteExtrusion(ExtrusionGeometryType, Single, Single)

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

Declaration
public virtual void EnableAbsoluteExtrusion(ExtrusionGeometryType geometryType, float height, float scaleFactor = 1F)
Parameters
Type Name Description
ExtrusionGeometryType geometryType

Option to create top and side polygons after extrusion.
System.Single height

Extrusion value
System.Single scaleFactor

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
public virtual 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
public virtual void EnablePropertyExtrusion(ExtrusionGeometryType geometryType, string propertyAttribute = "height", float scaleFactor = 1F)
Parameters
Type Name Description
ExtrusionGeometryType geometryType

Option to create top and side polygons after extrusion.
System.String propertyAttribute

Name of the property to use for extrusion
System.Single scaleFactor

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
public virtual 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
public virtual 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
public virtual 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
public virtual 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

ToGeometryExtrusionWithAtlasOptions()

Declaration
public GeometryExtrusionWithAtlasOptions ToGeometryExtrusionWithAtlasOptions()
Returns
Type Description
GeometryExtrusionWithAtlasOptions