Skip to content

Class: Quiver3DLayer

Defined in: plot3d/quiver3d.ts:61

A 3D vector field: each arrow is a shaft + a 4-wing arrowhead, drawn as lines.

Implements

Constructors

Constructor

ts
new Quiver3DLayer(gl, opts): Quiver3DLayer;

Defined in: plot3d/quiver3d.ts:80

Parameters

ParameterType
glWebGL2RenderingContext
optsQuiver3DOptions

Returns

Quiver3DLayer

Properties

colorCss?

ts
readonly optional colorCss?: string;

Defined in: plot3d/quiver3d.ts:64

A solid CSS color for the legend swatch (solid-colored layers only).

Implementation of

Layer3D.colorCss


id

ts
readonly id: string;

Defined in: plot3d/quiver3d.ts:62

Implementation of

Layer3D.id


name?

ts
readonly optional name?: string;

Defined in: plot3d/quiver3d.ts:63

Series name for the legend (optional).

Implementation of

Layer3D.name

Methods

bounds3()

ts
bounds3(): Bounds3 | null;

Defined in: plot3d/quiver3d.ts:178

Returns

Bounds3 | null

Implementation of

Layer3D.bounds3


colorInfo()

ts
colorInfo(): ColorInfo | null;

Defined in: plot3d/quiver3d.ts:180

Colormap + value range for a colorbar, if this layer is colormapped.

Returns

ColorInfo | null

Implementation of

Layer3D.colorInfo


dispose()

ts
dispose(): void;

Defined in: plot3d/quiver3d.ts:193

Returns

void

Implementation of

Layer3D.dispose


draw()

ts
draw(gl, mvp): void;

Defined in: plot3d/quiver3d.ts:184

Parameters

ParameterType
glWebGL2RenderingContext
mvpMat4

Returns

void

Implementation of

Layer3D.draw


pickData()

ts
pickData(): 
  | {
  positions: Float32Array<ArrayBufferLike>;
}
  | null;

Defined in: plot3d/quiver3d.ts:182

Data-space points for hover picking (xyz triples), with an optional per-point tooltip label builder. Null if the layer isn't pickable.

Returns

| { positions: Float32Array<ArrayBufferLike>; } | null

Implementation of

Layer3D.pickData


setData()

ts
setData(
   x, 
   y, 
   z, 
   u, 
   v, 
   w): void;

Defined in: plot3d/quiver3d.ts:171

Stream a new vector field (arrows rebuilt). Call plot.refresh() after.

Parameters

ParameterType
xArrayLike<number>
yArrayLike<number>
zArrayLike<number>
uArrayLike<number>
vArrayLike<number>
wArrayLike<number>

Returns

void

MIT licensed. WebGL2 required.