Format of the Library
Added 2020-11-23 13:48:25 +0000 UTCA question to everyone wanting to use or is just interested in the idea of the Wrangle tool and the library.
As you know, one of the base ideas of the library was to have all the most important functions in there, for quick access so you don't need to jump to the docs all the time.
But there is a question of format. Let's look at an example.
The function intersect.
So the question is what would be most usefull.
The quickest way would be to just copy in the docs:
Option 1:
int intersect(<geometry>geometry, vector orig, vector dir, vector &p, float &u, float &v)
This has the benefit that many can quickly recognize what is needed. But on the other hand - I often heard people being not happy with the docs. Also it is always written in pseudo code - so it always starts with an error.
What I did so far was try to write correct syntax but still have clear names. Cleaner but you don't see the correct datatype,
Option 2:
int interResult = intersect(0, origin, direction, position, uv);
And finally a version to write correct syntax but still see what datatypes are used. The downside is that, if you are a bit more savy the comments are just a waste of space.
Option 3:
// vector origin,direction,position,uv;
int interResult = intersect(0, origin, direction, position, uv);
P.S.
Did someone already played around with version 0.2.4?
Cheers
Dave
