Interface: View3DProjector

Experimental

See the module comment.

Implements

• ViewportProjector

Accessors

angles

Get Signature

get angles(): View3DAngles;

Experimental

Returns

View3DAngles

---

camera

Get Signature

get camera(): OrthographicCamera | PerspectiveCamera;

Experimental

The camera the viewport draws with.

Returns

OrthographicCamera | PerspectiveCamera

Implementation of

ViewportProjector.camera;

---

view

Get Signature

get view(): View3DCamera | null;

Experimental

The current camera math (null before the first layout).

Returns

View3DCamera | null

---

viewport

Get Signature

get viewport(): Viewport | null;

Experimental

The viewport drawn in 2.5D (null when detached).

Returns

Viewport | null

Methods

attach()

attach(viewport): void;

Experimental

Draw viewport in 2.5D (see the module comment).

Parameters

Parameter	Type
viewport	Viewport

Returns

void

---

detach()

detach(): void;

Experimental

Draw the viewport flat again: its camera, scissor, background and materials as before.

Returns

void

---

dispose()

dispose(): void;

Experimental

Free the plane (after detach).

Returns

void

---

layout()

layout(viewport): void;

Experimental

Recompute the camera for the viewport's rect and render area (called by layout()).

Parameters

Parameter	Type
viewport	Viewport

Returns

void

Implementation of

ViewportProjector.layout;

---

project()

project(
   x,
   y,
   z?
): [number, number];

Experimental

A plot-plane point (container px), raised by z px toward the viewer, on screen.

Parameters

Parameter	Type	Default value
x	number	undefined
y	number	undefined
z	number	0

Returns

[number, number]

Implementation of

ViewportProjector.project;

---

setAngles()

setAngles(angles): void;

Experimental

Change the angles (a drag, a transition frame): recomputes the camera; request a frame.

Parameters

Parameter	Type
angles	View3DAngles

Returns

void

---

takeBackground()

takeBackground(): void;

Experimental

Paint the viewport's background (e.g. set again by the chart for plot_bgcolor) with the plot-area quad, and clear it from the viewport. Call after anything that may set it.

Returns

void

---

unproject()

unproject(x, y): [number, number];

Experimental

Screen point → the plot-plane point under it (on extruded geometry: the point below it).

Parameters

Parameter	Type
x	number
y	number

Returns

[number, number]

Implementation of

ViewportProjector.unproject;