API / geotoolkit3d / scene / LineSegments / LineSegments
scene.LineSegments.LineSegments
Type Aliases
Type Aliases
Ƭ DataOptions: Object
| Name | Type | Description |
|---|---|---|
colorprovider? | ColorProvider | color provider used along values. |
colors? | number[] | line colors in r,g,b format. One color for each point. |
endcaps? | boolean | If the segments should have end caps, used to avoid seams when neighbor segments make a sharp angle, or to make thick segments smoother on the ends. |
line? | boolean | true if need to use geometry as line geometry, not line segments data.x/y/z allow to store x,y,z coordinates in separate array for clarity, and does not need duplicate points for continuous line. Set data.line to "true" for this format to produce a continuous line with the given points. Leave to false if they are expected to be separate segments. |
positions? | number[] | TypedArray | line vertices pairs in x,y,z format data.positions store the points xyz interleaved, by pairs ex: [x1,y1,z1, x2,y2,z2, x3,y3,z3, x4,y4,z4], where 1 and 2 form the first line segment, 3 and 4 form the second segment. In this case, segments are separate, and a continuous line require duplicate points between segments for continuity. |
values? | number[] | values the value for each point in the data. Used along the colorprovider. |
x? | number[] | line x positions |
y? | number[] | line y positions |
z? | number[] | line z positions |
Ƭ Options: ShaderOptions & { data?: DataOptions ; optimizations?: { disposetrajectoryattribute?: boolean } ; selectable?: boolean }
options object
Ƭ ShaderOptions: Object
| Name | Type | Description |
|---|---|---|
color? | Color | string | Color. Default is white (1, 1, 1). |
dashed? | boolean | True to make the line dashed. Default is false. |
dashoffset? | number | Dash offset. Default is 0. |
dashscale? | number | Dash scale. Default is 1. |
dashsize? | number | Dash size. Default is 1. |
gapsize? | number | Gap size. Default is 1. |
linestyle? | Type | Line style. Default is undefined. |
linewidth? | number | Line width. Default is 1. |
opacity? | number | Opacity. Default is 1. |
polygonoffset? | boolean | True to use offset (like avoiding Z-fight/occlusion when used for contour). Default is false. |
polygonoffsetfactor? | number | Factor for polygon offset, > 0 will make line closer to camera, < 0 will make it farther. Default is 1. |
Ƭ ShaderOptionsOut: Object
| Name | Type | Description |
|---|---|---|
color | Color | color |
dashed | boolean | dashed |
dashoffset | number | dash offset |
dashscale | number | dash scale |
dashsize | number | dash size |
gapsize | number | gap size |
linewidth | number | line width |
opacity | number | opacity |
polygonoffset | boolean | true to use offset (like avoid Z-fight/occlusion when used for contour) |
polygonoffsetfactor | number | factor for polygon offset, > 0 will make line closer to camera, < 0 will make it farther |