scene-2d v2.0.0

scene-2d

Multitouch capable 2d scene implementing pan, zoom and object selection.

How

Synthesizing touch events from mouse events.

Example

var Scene2d = require('scene-2d')

// create a scene
customElements.define('scene-2d', Scene2d)
var scene = document.createElement('scene-2d')
scene.addEventListener('select', () => console.log('scene selection state changed', scene.selections))
scene.addEventListener('scale', () => console.log('scene zoomed', scene.scale))
scene.addEventListener('move', () => console.log('scene panned', scene.origin))

// add scene to display
var reference = document.querySelector('#reference')
reference.appendChild(scene)

// define an object to use in the scene
customElements.define('object-2d', class extends HTMLElement {
  constructor () {
    super()
    this.origin = [0,0,0]
    this.movable = true
    this.selectable = true
    this.addEventListener('origin', () => {
      this.style.transform = `translate3d(${this.origin[0]}px,${this.origin[1]}px,${this.origin[2]}px)`
    })
    this.addEventListener('select', () => {
      this.classList[this.selected ? 'add' : 'remove']('selected')
    })
    this.addEventListener('move', () => {
      console.log('object moved', this.origin)
    })
  }

  connectedCallback () {
    this.classList.add('object-2d')
    this.innerHTML = `<div id=handle></div>`
    var handle = this.querySelector('#handle')
    handle.object = this
  }
})

// create and add some objects to the scene
scene.objects.appendChild(document.createElement('object-2d'))
scene.objects.appendChild(document.createElement('object-2d'))
scene.objects.appendChild(document.createElement('object-2d'))

You can run this example by doing:

$ npm run example

API (scene)

This is the API for the scene itself, see the object API below for individual objects.

Properties

scene.origin

Array of pixel offsets (e.g. [x,y,z]) representing the current pan position.

scene.scale

Current zoom scale.

scene.selections

Array of all currently selected objects.

scene.objects

Container element for all objects in the scene.

Methods

scene.render()

Writes the scene's current origin and scale to the display.

Events

scene.addEventListener('move', fn)

Dispatched when a pan operation ends.

scene.addEventListener('scale', fn)

Dispatched when a zoom operation ends.

scene.addEventListener('select', fn)

Dispatched when the scene's selection state has changed.

API (objects)

Any elements you append to scene.objects may implement these properties or listen for these events.

Properties

object.object

Pointer to another object to consider as the target. Useful for implementing grip or handle interfaces.

object.selectable

Boolean indicating whether the object is selectable.

object.selected

Boolean representing the object's selection state.

object.movable

Boolean indicating whether the object is movable.

object.origin

Array of pixel offsets (e.g. [x,y,z]) representing the object's current position. Required if object.movable is set to true true.

Events

object.addEventListener('origin', fn)

Dispatched during a drag operation.

object.addEventListener('move', fn)

Dispatched when a drag operation ends.

object.addEventListener('select', fn)

Dispatched when the object's selection state has changed.

Releases

• 1.0
  • First release

License

MIT