Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExtrudedPolygonTechniqueParams

Technique used to draw a geometry as an extruded polygon, for example extruded buildings.

Hierarchy

Index

Properties

Optional alphaMap

alphaMap: DynamicProperty<string | TextureBuffer>

URL or texture buffer that should be used as alpha map. See: https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.alphaMap

Optional alphaMapProperties

alphaMapProperties: DynamicProperty<TextureProperties>

Optional alphaTest

alphaTest: DynamicProperty<number>

The material will not be rendered if the opacity is lower than this value. See https://threejs.org/docs/#api/en/materials/Material.alphaTest.

Optional animateExtrusion

animateExtrusion: DynamicProperty<boolean>

Animate the extrusion of the buildings if set to true.

Optional animateExtrusionDuration

animateExtrusionDuration: undefined | number

Duration of the building's extrusion in milliseconds

Optional boundaryWalls

boundaryWalls: undefined | false | true

If true, wall geometry will is added along the tile boundaries.

remarks

this causes artifacts when used with shadows, so it should be known in advance that shadows won't be enabled.

defaultvalue

false

Optional bumpMap

bumpMap: DynamicProperty<string | TextureBuffer>

URL or texture buffer that should be used as bump map. See: https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.bumpMap

Optional bumpMapProperties

Optional category

category: DynamicProperty<string>

The category of this technique.

remarks

The category is used in conjunction with Theme.priorities to assign render orders to the objects created by this Style.

Optional color

Color of the feature in hexadecimal or CSS-style notation, for example: "#e4e9ec", "#fff", "rgb(255, 0, 0)", or "hsl(35, 11%, 88%)". See https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.color.

format

color-hex

Optional constantHeight

constantHeight: DynamicProperty<boolean>

If true, geometry height won't be scaled on projection. Enable it for projections with variable scale factor (e.g. mercator) to avoid distortions in geometry with great heights and latitude spans. E.g. a large object with even height would look oblique to the ground plane on mercator unless this property is set to true.

defaultvalue

true for geometries stored at level less than 12.

Optional defaultColor

Default color used if feature doesn't provide color attribute and MapEnv did not return it too.

format

color-hex

Optional defaultHeight

defaultHeight: undefined | number

In some data sources, for example Tilezen, building extrusion information might be missing. This attribute allows to define a default height of an extruded polygon in the theme.

deprecated

use height

Optional depthTest

depthTest: DynamicProperty<boolean>

Optional displacementMap

displacementMap: DynamicProperty<string | TextureBuffer>

URL or texture buffer that should be used as displacement map. See: https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.displacementMap

Optional displacementMapProperties

displacementMapProperties: DynamicProperty<TextureProperties>

Optional emissive

Emissive (light) color of the material, essentially a solid color unaffected by other lighting. Default is black. See https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.emissive.

format

color-hex

Optional emissiveIntensity

emissiveIntensity: DynamicProperty<number>

Intensity of the emissive light. Modulates the emissive color. Default is 1. See https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.emissiveIntensity.

Optional emissiveMap

emissiveMap: DynamicProperty<string | TextureBuffer>

URL or texture buffer that should be used as emissive map. See: https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.emissiveMap

Optional emissiveMapProperties

emissiveMapProperties: DynamicProperty<TextureProperties>

Optional enableDepthPrePass

enableDepthPrePass: undefined | false | true

Control rendering of depth prepass before the actual geometry.

remarks

Depth prepass is a method to render translucent meshes, hence only the visible front faces of a mesh are actually rendered, removing artifacts caused by blending with internal faces of the mesh. This method is used for drawing translucent buildings over map background.

By default, each DataSource determines how/if enable the depth pre-pass. A value of false forcefully disables depth prepass.

Optional enabled

enabled: DynamicProperty<boolean>

Runtime filtering of techniques.

Use with ['dynamic-properties'] operator for dynamic feature highlight, highlighig etc.

see

Picking example

Optional fadeFar

fadeFar: DynamicProperty<number>

Distance to the camera (0.0 = camera position, 1.0 = farPlane) at which the object has zero opacity and stops fading out. An undefined value disables fading.

Optional fadeNear

fadeNear: DynamicProperty<number>

Distance to the camera `(0.0 = camera position, 1.0 = farPlane) at which the object start fading out (opacity decreases).

Optional floorHeight

floorHeight: DynamicProperty<number>

Height of "floor" of extruded polygon in world units of extruded polygon.

Usually, unique per feature, so defaults to ["number", ["get", "min_height"], 0].

Optional footprint

footprint: undefined | false | true

Renders the footprint lines if set to 'true'.

Optional height

height: DynamicProperty<number>

Height above ground in world units of extruded polygon.

Usually, unique per feature, so defaults to ["get", "height"].

Optional id

id: undefined | string

The name used to identify materials created from this technique.

Optional kind

Specified kind of geometry.

remarks

One kind is set as default in the technique, and can be overridden in the style.

deprecated

Use enabled with expressions based on ['dynamic-properties'] operator. See "object picking" example.

Optional lineColor

Fill color in hexadecimal or CSS-style notation, for example: "#e4e9ec", "#fff", "rgb(255, 0, 0)", or "hsl(35, 11%, 88%)".

format

color-hex

Optional lineColorMix

lineColorMix: undefined | number

Mix value between the lineColor(0.0) and the geometry's vertex colors(1.0).

Optional lineFadeFar

lineFadeFar: DynamicProperty<number>

Distance to the camera (0.0 = nearPlane, 1.0 = farPlane) at which the object edges become transparent. A value of <= 0.0 disables fading.

Optional lineFadeNear

lineFadeNear: DynamicProperty<number>

Distance to the camera (0.0 = nearPlane, 1.0 = farPlane) at which the object edges start fading out.

lineWidth

lineWidth: DynamicProperty<number>

Width of the lines. Currently limited to the [0, 1] range.

Optional map

Optional mapProperties

Optional maxSlope

maxSlope: undefined | number

Set to a negative value to remove all the vertical lines, and to a value between 0.0 and 1.0 to modulate the amount of vertical lines rendered.

Optional maxZoomLevel

maxZoomLevel: DynamicProperty<number>

Maximum zoom level. If the current zoom level is equal to or greater, the technique will not be used.

Optional metalness

metalness: DynamicProperty<number>

How much the material is like a metal. Nonmetallic materials such as wood or stone use 0.0, metallic ones use 1.0, with nothing (usually) in between. Default is 0.0. A value between 0.0 and 1.0 can be used for a rusty metal look. If metalnessMap is also provided, both values are multiplied. See https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.metalness.

Optional metalnessMap

metalnessMap: DynamicProperty<string | TextureBuffer>

URL or texture buffer that should be used as metalness map. See: https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.metalnessMap

Optional metalnessMapProperties

metalnessMapProperties: DynamicProperty<TextureProperties>

Optional minZoomLevel

minZoomLevel: DynamicProperty<number>

Minimal zoom level. If the current zoom level is smaller, the technique will not be used.

Optional normalMap

normalMap: DynamicProperty<string | TextureBuffer>

URL or texture buffer that should be used as normal map. See: https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.normalMap

Optional normalMapProperties

normalMapProperties: DynamicProperty<TextureProperties>

Optional normalMapType

normalMapType: DynamicProperty<number>

Optional opacity

opacity: DynamicProperty<number>

For transparent lines, set a value between 0.0 for totally transparent, to 1.0 for totally opaque. See https://threejs.org/docs/#api/en/materials/Material.opacity.

Optional refractionRatio

refractionRatio: DynamicProperty<number>

The index of refraction (IOR) of air (approximately 1) divided by the index of refraction of the material. It is used with environment mapping modes THREE.CubeRefractionMapping and THREE.EquirectangularRefractionMapping. The refraction ratio should not exceed 1. Default is 0.98. See https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.refractionRatio.

Optional renderOrder

renderOrder: DynamicProperty<number>

The render order of the objects created using this technique.

remarks

If not specified in style file monotonically increasing values according to style position in file.

Optional roughness

roughness: DynamicProperty<number>

How rough the material appears. 0.0 means a smooth mirror reflection. 1.0 means fully diffuse. Default is 1.0. See https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.roughness.

Optional roughnessMap

roughnessMap: DynamicProperty<string | TextureBuffer>

URL or texture buffer that should be used as roughness map. See: https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.roughnessMap

Optional roughnessMapProperties

roughnessMapProperties: DynamicProperty<TextureProperties>

Optional side

side: DynamicProperty<number>

Defines which side of faces will be rendered - front, back or both. See https://threejs.org/docs/#api/en/materials/Material.side.

Optional textureCoordinateType

textureCoordinateType: TextureCoordinateType

Whether and how texture coordinates should be generated. No texture coordinates are generated if undefined. Should be set if any texture assigned (e.g. map, normalMap, ...).

Optional transient

transient: boolean | Pickability

Optional. If true or Pickability.transient, no IDs will be saved for the geometry this style creates. Default is Pickability.onlyVisible, which allows all pickable and visible objects to be picked, Pickability.all, will also allow invisible objects to be picked.

defaultvalue

Pickability.onlyVisible The boolean option is for backwardscompatibilty, please use the Pickability.

TODO: deprecate and rename to something that makes more sense

Optional transparent

transparent: DynamicProperty<boolean>

Set to 'true' if line should appear transparent.

remarks

Rendering transparent lines may come with a slight performance impact. See https://threejs.org/docs/#api/en/materials/Material.transparent.

Optional vertexColors

vertexColors: undefined | false | true

If vertexColors is true, every vertex has color information, which is interpolated between vertices. See https://threejs.org/docs/#api/en/materials/Material.vertexColors.

Optional wireframe

wireframe: undefined | false | true

A value of true creates a wireframe geometry. (May not be supported with all techniques). See https://threejs.org/docs/#api/en/materials/MeshStandardMaterial.wireframe.

Generated using TypeDoc