pex-cam v2.8.0

pex-cam

Cameras models and controllers for 3D rendering in PEX.

Installation

npm install pex-cam

Usage

import {
  perspective as createPerspectiveCamera,
  orbiter as createOrbiter,
} from "pex-cam";

const perspectiveCamera = createPerspectiveCamera({
  position: [2, 2, 2],
  target: [0, -0.5, 0],
  aspect: window.innerWidth / window.innerHeight,
});

const perspectiveOrbiter = createOrbiter({
  camera: perspectiveCamera,
});

console.log(perspectiveCamera.projectionMatrix);

API

Modules

Classes

Typedefs

index

Re-export classes and factory functions

• index
  • .perspective ⇒ PerspectiveCamera
  • .orthographic ⇒ OrthographicCamera
  • .orbiter ⇒ OrbiterControls

index.perspective ⇒ PerspectiveCamera

Factory function for perspective camera

Kind: static constant of index

index.orthographic ⇒ OrthographicCamera

Factory function for orthographic camera

Kind: static constant of index

index.orbiter ⇒ OrbiterControls

Factory function for orbiter controls

Kind: static constant of index

Camera

An interface for cameras to extend

Kind: global class

camera.set(opts)

Update the camera

Kind: instance method of Camera

OrbiterControls

Camera controls to orbit around a target

Kind: global class

• OrbiterControls
  • new OrbiterControls(opts)
  • .set(opts)
  • .dispose()

new OrbiterControls(opts)

Create an instance of OrbiterControls

orbiterControls.set(opts)

Update the control

Kind: instance method of OrbiterControls

orbiterControls.dispose()

Remove all event listeners

Kind: instance method of OrbiterControls

OrthographicCamera ⇐ Camera

A class to create an orthographic camera

Kind: global class Extends: Camera

• OrthographicCamera ⇐ Camera
  • new OrthographicCamera(opts)
  • .set(opts)

new OrthographicCamera(opts)

Create an instance of PerspectiveCamera

orthographicCamera.set(opts)

Update the camera

Kind: instance method of OrthographicCamera Overrides: set

PerspectiveCamera ⇐ Camera

A class to create a perspective camera

Kind: global class Extends: Camera

• PerspectiveCamera ⇐ Camera
  • new PerspectiveCamera(opts)
  • .set(opts)
  • .getViewRay(x, y, windowWidth, windowHeight) ⇒ ray
  • .getWorldRay(x, y, windowWidth, windowHeight) ⇒ ray

new PerspectiveCamera(opts)

Create an instance of PerspectiveCamera

perspectiveCamera.set(opts)

Update the camera

Kind: instance method of PerspectiveCamera Overrides: set

perspectiveCamera.getViewRay(x, y, windowWidth, windowHeight) ⇒ ray

Create a picking ray in view (camera) coordinates

Kind: instance method of PerspectiveCamera

perspectiveCamera.getWorldRay(x, y, windowWidth, windowHeight) ⇒ ray

Create a picking ray in world coordinates

Kind: instance method of PerspectiveCamera

Radians : number

Kind: global typedef

Degrees : number

Kind: global typedef

CameraView : Object

Kind: global typedef Properties

CameraOptions : Object

Kind: global typedef Properties

PerspectiveCameraOptions : Object

Kind: global typedef Properties

OrthographicCameraOptions : Object

Kind: global typedef Properties

OrbiterControlsOptions : Object

Kind: global typedef Properties

License

MIT. See license file.