Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 2.29 KB

readme.md

File metadata and controls

63 lines (38 loc) · 2.29 KB

jQuery Three

A plugin / extension of the jQuery API for 3d objects (using Three.js)

jQuery Three was developed to bridge the gap between WebGL and the DOM by using existing conventions web designers are already familiar with.

Effectively it provides a higher level api that abstracts Three.js methods to known common conventions from regular web development.

Dependencies

  • jQuery v2.x
  • THREE.js rev.75

Examples

Install

Get the latest (stable) version using bower:

bower install jquery.three

Usage

Enable 3D actions on any container using:

$("container").three( options, callback );

Read the wiki docs for more details on the methods and tag support.

Options

There are the setup options used when initiating the .three() method:

  • alpha: (boolean, default: true) Renders the WebGL canvas transparent so you can stack other elements behind it.
  • deps: (object, default: {}) Listing dependency scripts loaded as extensions of THREE.js
  • paused: (boolean, default: false) Start with a paused loop - or set as a flag to pause anytime.
  • watch: (boolean, default: false) If set it monitors the DOM for updates and syncs the changes with THREE.js

Credits

Created by Makis Tracend [ full list of contributors ]

Distributed through Makesites.org

Released under the MIT License