CODEWITHSUNDEEP
webglthree.js
Andrea
Andrea

Reputation: 20493

Is there a working THREE.js API documentation?

I am trying to learn the basics of THREE.js. I have read a couple of tutorial, and I would like to start experimenting. My problem is that I am not able to find any documentation

This is supposed to be an API browser, but I was not able to find the very basic objects, like PlaneGeometry or SphereGeometry. Is there any other place where to find an API?

Upvotes: 27

Views: 10322

Answers (6)

Stemkoski
Stemkoski

Reputation: 9045

I have written a set of more than 60 introductory examples with detailed comments at

http://stemkoski.github.io/Three.js/

These examples are meant to illustrate many of the basic features of Three.js, one at a time, and as the examples progress some build upon each other, some increase in complexity, and some incorporate additional Javascript libraries.

Hope this helps!

Upvotes: 3

LarsH
LarsH

Reputation: 28004

Another place to browse the API is here. I think both this and the one you referenced were generated before the recent name change for geometry objects. You could ask staunsholm to regenerate the API docs that he posted. Another, more official-looking place is here, but it still has quite a few "to-do's" in it.

I feel the same way about the lack of up-to-date documentation for THREE.js. If you want to apply some influence toward prioritizing this, you could reopen this bugtracker issue and comment on it. Or you could take it upon yourself :-) to maintain a frequently-updated THREE.js API reference, generated with jsdoc. Alternatively, you can dig through the source code and examples to find answers to your questions, and then update the apparently official wiki pages with your discoveries.

Sorry this is not the ideal solution you were hoping for, but maybe it's the best available solution for now. The author of three.js seems to feel that the API needs to stabilize more before a documentation effort would be worthwhile for him.

Upvotes: 17

Alex Under
Alex Under

Reputation: 1489

There is algo a book published recently: WebGL: Up and Running, which is based on THREE.js, so you'll get complete understanding of how it works. I think it's a good place to start if you want to get overall knowledge of all THREE.js aspects and not just by scrutinizing separate examples.

Upvotes: 2

Codler
Codler

Reputation: 11256

Latest official API is currently here http://mrdoob.github.com/three.js/docs/

Upvotes: 7

64k
64k

Reputation: 339

Official API is here:

Documentation: http://mrdoob.github.com/three.js/docs/48/index.html

Full Index: http://mrdoob.github.com/three.js/docs/48/genindex.html

And is pretty detailed at present.

Upvotes: 3

Jerome Etienne
Jerome Etienne

Reputation: 387

three.js doc is in the examples. http://mrdoob.github.com/three.js/

try them and look at the sources, they are quite clear. There is 112 of them and they are carefully maintained. It gives doc and test at the same time. There is no API documentation at the moment, and i dont think there will be in a near future.

It is more about. take an example close to what you want, and derive it.

Upvotes: 4

Related Questions