API / geotoolkit3d / scene / well / TubeGeometry / TubeGeometry
well.TubeGeometry.TubeGeometry
Type Aliases
Type Aliases
Ƭ Data: Object
| Name | Type | Description |
|---|---|---|
heights | number[] | number | Radiuses of the ellipsis North-South axis (For first ellipsis) |
rolls | number[] | number | Rolling angles in radians |
values | number[] | A value attribute used for coloring the trajectory (see options.colorprovider) |
widths | number[] | number | Radiuses of the ellipsis for the East-West axis (For first ellipsis) |
x | number[] | The x deviation values |
y | number[] | The y deviation values |
z | number[] | The elevation values |
Ƭ Options: Object
The options
| Name | Type | Description |
|---|---|---|
data | { heights?: number[] | number ; rolls?: number[] | number ; values?: number[] ; widths?: number[] | number ; x: number[] ; y: number[] ; z: number[] } | The data options |
data.heights? | number[] | number | Radiuses of the ellipsis North-South axis (For first ellipsis) |
data.rolls? | number[] | number | Rolling angles in radians |
data.values? | number[] | A value attribute used for coloring the trajectory (see options.colorprovider) |
data.widths? | number[] | number | Radiuses of the ellipsis for the East-West axis (For first ellipsis) |
data.x | number[] | The x deviation values |
data.y | number[] | The y deviation values |
data.z | number[] | The elevation values |
generatedepths? | boolean | Flag to generate depths attribute for ranges colormaps, use only with WellColorRangeMaterial See WellColorRangeMaterial |
openended? | boolean | False if the tube should have a cap at both ends |
radiusmax? | number | The maximum radius, this is used as a size factor applied to the ellipses |
radiusmin? | number | The minimum radius, this is used as a size factor applied to the ellipses |
size? | number | tube size factor |
tubeprecision? | number | The ellipsis shape is approximated using triangles. This factor is used to define how many triangles will be used for the approximation. |
usefrenet? | boolean | calculate tube using Frenet Frames |
Ƭ OptionsBase: Object
The options
| Name | Type | Description |
|---|---|---|
data? | Partial<Data> | The data options |
generatedepths? | boolean | Flag to generate depths attribute for ranges colormaps, use only with WellColorRangeMaterial See WellColorRangeMaterial |
openended? | boolean | False if the tube should have a cap at both ends |
radiusmax? | number | The maximum radius, this is used as a size factor applied to the ellipses |
radiusmin? | number | The minimum radius, this is used as a size factor applied to the ellipses |
size? | number | tube size factor |
tubeprecision? | number | The ellipsis shape is approximated using triangles. This defines how many segments will be used for the approximation. |
usefrenet? | boolean | calculate tube using Frenet Frames |
Ƭ OptionsBaseOut: Merge<Required<OptionsBase>, { data: Data }>