0.2.1 • Published 9 years ago

babylon-atlas-sprite v0.2.1

Weekly downloads
2
License
MIT
Repository
github
Last release
9 years ago

babylon-atlas-sprite

A Babylon.js object that shows frames from a texture atlas (img+JSON).

Usage:

var AtlasSprite = require('babylon-atlas-sprite')

var sprite = new AtlasSprite('sprites.png', 'sprites.json', scene, BABYLON)

// standard babylon objects exposed as 'mesh', 'material', 'texture'
sprite.mesh.position.x = 5

// set frame to names specified in the json
sprite.setFrame( 'frame003' )

Live demo here.

Installation

npm install babylon-atlas-sprite

To see example locally:

cd babylon-atlas-sprite
npm install
npm test

API

var AtlasSprite = require('babylon-atlas-sprite')

new AtlasSprite( imgURL, jsonURL, scene, BABYLON, noMipMap, samplingMode )

sprite.frames // array of frame names from JSON

sprite.setFrame(frameName)

sprite.setFrame(num) // same as: sprite.setFrame(sprite.frames[num]) 

sprite.dispose()