Package Exports

@metamask/logo

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@metamask/logo) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Metamask Logo

A browserifyable 3d metamask logo. Live demo.

This repo can both be included as a browserifiable module, and includes a sample app.

The sample app address is index.html. The sample app javascript is bundle.js, which is built from sample.js using the build task (see the package.json).

API

const ModelViewer = require('@metamask/logo')

// To render with fixed dimensions:
const viewer = ModelViewer({

  // Dictates whether width & height are px or multiplied
  pxNotRatio: true,
  width: 500,
  height: 400,
  // pxNotRatio: false,
  // width: 0.9,
  // height: 0.9,

  // To make the face follow the mouse.
  followMouse: false,

  // head should slowly drift (overrides lookAt)
  slowDrift: false,

})

// add viewer to DOM
const container = document.getElementById('logo-container')
container.appendChild(viewer.container)

// look at something on the page
viewer.lookAt({
  x: 100,
  y: 100,
})

// enable mouse follow
viewer.setFollowMouse(true)

// deallocate nicely
viewer.stopAnimation()

Running Example

First, rebuild browserify example/example.js -o bundle.js. Then, run a local server in this folder and visit it. For example, http-server.