Skip to main content

This class allows you to render a single THREE.js object to a canvas element. This is useful for generating images of objects for use in the game. However, there are performance bottlenecks that you should be aware of:

  • The THREE.js renderer is shared between all instances of this class. This is because there is a limit to how many webgl contexts can be created.
  • Each individual portrait has their own render loop. This means that if you have a lto of portraits, you will be rendering a lot of frames per second. This can be mitigated by either using the renderOnce parameter or utilizing the ItemSlots class, which batch renders objects in a grid-like fashion.

Example

const portrait = new Portrait(world.makeBlockMesh(5));
document.body.appendChild(portrait.canvas);

Constructors​

constructor​

• new Portrait(object, options?): Portrait

Create a new portrait. This automatically starts a render loop.

Parameters​

NameTypeDescription
objectObject3D<Object3DEventMap>The object to render to the canvas.
optionsPartial<PortraitOptions>The options to create this portrait with.

Returns​

Portrait

Properties​

camera​

• camera: OrthographicCamera

The THREE.js camera to use for rendering this portrait.

canvas​

• canvas: HTMLCanvasElement

The canvas element to render this portrait to.

object​

• object: Object3D<Object3DEventMap>

The target of this portrait.

options​

• options: PortraitOptions

Parameters to create this portrait with.

renderer​

▪ Static renderer: WebGLRenderer

The shared THREE.js webgl renderer. This is shared because there is a limit to how many webgl contexts can be created.

scene​

• scene: Scene

The THREE.js scene to use for rendering this portrait.

Methods​

dispose​

▸ dispose(): void

Dispose of this portrait. This stops the render loop and removes the object from the scene. However, it does not remove the canvas from the DOM.

Returns​

void

setObject​

▸ setObject(object): void

Set the object to render to the canvas.

Parameters​

NameTypeDescription
objectObject3D<Object3DEventMap>The object to render to the canvas.

Returns​

void