Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SolidLineTechniqueParams

Declares a a geometry as a solid line.

Hierarchy

Index

Properties

Optional caps

Describes the style of the line caps.

defaultvalue

"Round".

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 clipping

clipping: DynamicProperty<boolean>

Clip the line outside the tile if true.

defaultvalue

false

color

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

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 dashColor

Color of a line dashes in hexadecimal or CSS-style notation, for example: "#e4e9ec", "#fff", "rgb(255, 0, 0)", or "hsl(35, 11%, 88%)".

format

color-hex

Optional dashSize

Length of a line in meters for different zoom levels.

Optional dashes

Describes the style of the line dashes.

defaultvalue

"Square".

Optional depthTest

depthTest: DynamicProperty<boolean>
defaultvalue

false

Optional drawRangeEnd

drawRangeEnd: undefined | number

Describes the ending drawing position for the line (in the range [0...1]). Default is 1.0.

Optional drawRangeStart

drawRangeStart: undefined | number

Describes the starting drawing position for the line (in the range [0...1]). Default is 0.0.

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 gapSize

Size of a gap between lines in meters for different zoom levels.

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

Sets the polygon outline color.

format

color-hex

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

Width of a line in metricUnit for different zoom levels.

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 metricUnit

metricUnit: MetricUnit
deprecated

Specify metrics units as part of the value instead. Units in which different size properties are specified. Either Meter (default) or Pixel.

Optional minZoomLevel

minZoomLevel: DynamicProperty<number>

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

Optional offset

offset: DynamicProperty<number>

Size in world units how far to offset the line perpendicular to its direction.

Optional opacity

opacity: DynamicProperty<number>

For transparent lines, set a value between 0.0 for fully transparent, to 1.0 for fully opaque.

Optional outlineColor

Color of a line outline in hexadecimal or CSS-style notation, for example: "#e4e9ec", "#fff", "rgb(255, 0, 0)", or "hsl(35, 11%, 88%)".

format

color-hex

Optional outlineWidth

Outline width of a line in metricUnits for different zoom levels.

Optional polygonOffset

polygonOffset: undefined | false | true

Whether to use polygon offset. Default is false.

remarks

This corresponds to the GL_POLYGON_OFFSET_FILL WebGL feature.

PolygonOffset is used to raise the geometry towards the geometry (for depth calculation only). Default is false.

See here: https://sites.google.com/site/threejstuts/home/polygon_offset

To activate polygonOffset these values have to be set to pull the line "forwards":

transparent: true

polygonOffset: true

polygonOffsetFactor : -1.0, (as an example, see link above)

polygonOffsetUnits: -1 (as an example, see link above)

Optional polygonOffsetFactor

polygonOffsetFactor: DynamicProperty<number>

Sets the polygon offset factor. Default is 0.

Optional polygonOffsetUnits

polygonOffsetUnits: DynamicProperty<number>

Sets the polygon offset units. Default is 0.

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 secondaryCaps

secondaryCaps: DynamicProperty<LineCaps>

Describes the style of the secondary line caps

defaultvalue

"Round".

Optional secondaryCategory

secondaryCategory: DynamicProperty<string>

Describes the category of the secondary geometry object created using this technique.

Optional secondaryColor

secondaryColor: DynamicProperty<StyleColor>

Color of secondary line geometry in hexadecimal or CSS-style notation, for example: "#e4e9ec", "#fff", "rgb(255, 0, 0)", or "hsl(35, 11%, 88%)".

format

color-hex

Optional secondaryRenderOrder

secondaryRenderOrder: DynamicProperty<number>

The render order of the secondary line geometry object created using this technique.

Optional secondaryWidth

secondaryWidth: DynamicProperty<StyleLength>

Width of secondary line geometry in metricUnits for different zoom levels.

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 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.

Generated using TypeDoc