Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PolygonalTechniqueParams

Declares a a geometry as a polygon.

Hierarchy

Index

Properties

Optional color

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 depthTest

depthTest: DynamicProperty<boolean>
defaultvalue

false

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.

Optional opacity

opacity: DynamicProperty<number>

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

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 transparent

transparent: DynamicProperty<boolean>

Set to true if line should appear transparent. Rendering transparent lines may come with a slight performance impact.

Generated using TypeDoc