Newton Archemedia - Architecture and Programmer's Guide

A place to discuss everything related to Newton Dynamics.

Moderators: Sascha Willems, walaber

Newton Archemedia - Architecture and Programmer's Guide

Postby aqnuep » Tue Nov 24, 2009 2:15 pm

Hi,

As many times earlier I would like to collect information about Newton to make some kind of programmer's guide for it, because it would be very useful for me as well. I would appreciate the help of any of you.

Let's start from the beginning. What we have?
1. Demos shipping with Newton - these help a lot and show most of Newton's features, but they're maybe not the easiest way to learn Newton.
2. API function database on Wiki - nice, however it is incomplete and again, hard to figure out what to do if you are a newcomer.
3. Tutorials on Wiki - these are pretty good even for newbies, however, it is based on a precooked graphics scene manager that maybe not the best way for those who already have their graphics solution.

What I would like to make is a programmer's guide, which guides through Newton, starting from the beginning. Let's say the following topics would be covered in it:
Chapter 1 - what object types and objects are in Newton? (e.g. bodies, materials, joints, collisions, special collision types like compound collision, tree collision etc.)
Chapter 2 - hello world of newton (simple walkthrough how to make a simple rigid body dynamics demo)
Chapter 3 - using collisions (what exactly is for each and every collision type)
Chapter 4 - using rigid bodies (what stuffs can they do)
Chapter 5 - manipulating materials (how to configure the behaviors we would like to achieve)
Chapter 6 - using joints (types of joints, what are they good for and how to configure them)
Chapter 7 - using callbacks (an advanced view of callbacks and using them to integrate newton into an existing project)
Chapter 8 - advanced collisions (like compound collisions, etc.)
Chapter 9 - advanced joints (like rag doll joint, vehicle joint, etc.)
Chapter 10 - character controller (all about Newton's character controller and ways how to make your own, etc.)
Chapter ... - more advanced stuff
Appendix A - categoric list of newton api functions
Appendix ... - other useful stuff

I would greatly appreciate all of your help and be sure, I would like to make the resulting documentation public domain, so I think it would be useful for many people.
As I see, for such a detailed discussion, maybe forums are of too high "latency", so I you want to help me, please PM me for example and send me your MSN messenger ID, or whatever, to speed up the communication.

I know that almost none of you know me so you might think that I'm another jerk who thinks he can change the world :D, but please take me seriously, I have the competence for making such a guide, just I don't know Newton that well, that's why I need your help.

Thanks in advance and hope finally there will be some step forward in this topic!
aqnuep
 
Posts: 97
Joined: Sat Dec 22, 2007 4:14 pm

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby Stucuk » Tue Nov 24, 2009 3:06 pm

In my oppinion if you are going to do this it would be best to just do it on the Wiki(Especialy since it already covers some of the stuff you mention) so its easily accessible to everyone rather than a separate download that some may not even know exists.
User avatar
Stucuk
 
Posts: 801
Joined: Sat Mar 12, 2005 3:54 pm
Location: Scotland

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby aqnuep » Tue Nov 24, 2009 3:25 pm

I don't mind doing it on the Wiki, but beside that I would like to make it also in the form of an offline PDF document as well.
Not the fact that where it is stored is the most important, but that it should contain all the information I've mentioned.

So as an answer, yes, yes I'll put on the Wiki page too, but still I need help to make it.

However I don't think that the Wiki already covers the stuff I mentioned as I've read almost all the info on the Wiki, and beside the stuff about joints, which is also quite inadequate and incomplete, the rest is missing many important information.
aqnuep
 
Posts: 97
Joined: Sat Dec 22, 2007 4:14 pm

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby Stucuk » Tue Nov 24, 2009 3:31 pm

However I don't think that the Wiki already covers the stuff I mentioned as I've read almost all the info on the Wiki, and beside the stuff about joints, which is also quite inadequate and incomplete, the rest is missing many important information.

The great thing about a Wiki is anyone can add to it, so would also be the best place to start, as it means you can add something and then get people to edit it and add in what you don't know. Some of the stuff (Especially the new features in 2.11) only Julio knows how they truly work.
User avatar
Stucuk
 
Posts: 801
Joined: Sat Mar 12, 2005 3:54 pm
Location: Scotland

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby JernejL » Tue Nov 24, 2009 3:38 pm

There's already some tutorials and manual here, this should help you a bit:

http://newtondynamics.com/wiki/index.ph ... Newton_2.0
http://newtondynamics.com/wiki/index.ph ... ewton_1.53

Functions without proper description are also categorized here:
http://newtondynamics.com/wiki/index.ph ... escription

I'm trying to complete the api database, but it is only going a few functions a week, i would love to have your help with this.

The wiki can be exported to a disk file easily, the articles are also nicely formatted, so making a pdf version is possible later.
Help improving the Newton Game Dynamics WIKI
User avatar
JernejL
 
Posts: 1587
Joined: Mon Dec 06, 2004 2:00 pm
Location: Slovenia

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby aqnuep » Tue Nov 24, 2009 4:00 pm

As the good thing in Wiki is that everybody can edit it, this is also it's backside because usually nobody updates them.
I know that e.g. you guys really made huge amount of work on it and I strongly appreciate that.
What I really dislike in the Wiki page are the following:

1. There is no info about the architecture, I mean what are the entities in the physics engine, what subtypes of these entities are and what are they for (e.g. collisions), for joints it is quite well documented. The categorized form of the function list is also a great idea, however, there is not enough information there to make people understand what it is all about.
2. The API documentation is quite incomplete - yes, I know that only Julio knows the purpose of the latest functions, but even some basic stuff are missing and I feel the lack of examples and use cases.
3. The tutorials are nice, however, as I mentioned it earlier, they use some precooked graphics stuff, they don't really present Newton in the most abstract way, but via these frameworks.

I would like to emphasize that I really appreciate your and a few others work, those of you who really contributed to this Wiki and I would like to extend it and spend time to make examples and use cases, as well as nice figures and stuff like that, as probably you don't have enough time for such, but I need you to tell me the details not to put invalid data up there for example.
I hope that you understand my point of view.
aqnuep
 
Posts: 97
Joined: Sat Dec 22, 2007 4:14 pm

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby JernejL » Tue Nov 24, 2009 5:09 pm

So what's the problem? we really aren't going to stop you from improving the wiki.. :) You are welcome to help create new pages, just do it in a non-destructive way ;)
Help improving the Newton Game Dynamics WIKI
User avatar
JernejL
 
Posts: 1587
Joined: Mon Dec 06, 2004 2:00 pm
Location: Slovenia

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby Stucuk » Tue Nov 24, 2009 6:07 pm

aqnuep wrote:As the good thing in Wiki is that everybody can edit it, this is also it's backside because usually nobody updates them.


No matter what medium your talking about its generally only the few that create documentation for anything. So i don't see how its a downside, with a wiki at least you can improve on it. With other stuff you just have to suffer with a PDF/Whatever which is incomplete.
User avatar
Stucuk
 
Posts: 801
Joined: Sat Mar 12, 2005 3:54 pm
Location: Scotland

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby aqnuep » Tue Nov 24, 2009 6:09 pm

I know I sound like somebody who is blaming your work, but if you like so, I would do so. :D
I will update the wiki with new stuff, but please then correct any mistake I make, because I'm not understanding the whole picture and maybe I'll post some bad info.
If it is good like this for you, I'll start by putting some stuff on the Wiki what seems correct from my point of view but please review it not to spread false information.
aqnuep
 
Posts: 97
Joined: Sat Dec 22, 2007 4:14 pm

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby JernejL » Tue Nov 24, 2009 6:16 pm

Feel free to edit, if you need a help of a wikisysop me & stucuk are the people you need to contact (to edit stuff on sidebar or main page).
Help improving the Newton Game Dynamics WIKI
User avatar
JernejL
 
Posts: 1587
Joined: Mon Dec 06, 2004 2:00 pm
Location: Slovenia

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby aqnuep » Tue Nov 24, 2009 6:22 pm

OK, then that's for now. Anyway, in the future if you find my new topics on the Wiki useful, please send me some immediate contact forms so speed up the improvement process. Till then at least I thank you that you care about the topic itself.
aqnuep
 
Posts: 97
Joined: Sat Dec 22, 2007 4:14 pm

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby JernejL » Wed Nov 25, 2009 7:02 pm

I've just been installing some new extensions on the wiki (imagelink) which Stucuk needed and checked recent changes.
The few new function pages are a great addition, you have my support. Keep up the good work :)
Help improving the Newton Game Dynamics WIKI
User avatar
JernejL
 
Posts: 1587
Joined: Mon Dec 06, 2004 2:00 pm
Location: Slovenia

Re: Newton Archemedia - Architecture and Programmer's Guide

Postby aqnuep » Thu Nov 26, 2009 1:57 pm

Thanks!

I've already put API stuff related to HeightFieldCollision and SceneCollision, and extended with some stuff the collision overview page.
Today I would like to make the NewtonMesh related stuff and maybe more. :D
aqnuep
 
Posts: 97
Joined: Sat Dec 22, 2007 4:14 pm


Return to General Discussion

Who is online

Users browsing this forum: No registered users and 2 guests

cron