Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wiki #5

Open
baxerus opened this issue Aug 6, 2016 · 6 comments
Open

Wiki #5

baxerus opened this issue Aug 6, 2016 · 6 comments

Comments

@baxerus
Copy link

baxerus commented Aug 6, 2016

In the table describing the selectors the last selector seams to be at least a copy-paste error, because it contains ".png" (simply search for "(parent child),B grandchild.png" in the wiki).

By the way, great work with the lib!

But I need more documentation, I just reached the end :D. And for example the "orient" module seams to be able to use lists of vectors (see "orient([x,y,z])" in the examples), but this isn't documented under the orient section.

@davidson16807
Copy link
Owner

Thanks for the tip. I fixed the .png typo and added the bit about orient. align also has similar functionality where you can pass it a list of vectors, which I've also added to the wiki. I'll still need to create illustrations of the demos I added for them.

Just in general, what sort of documentation would you like to see added? demos? method signatures? tutorials? If there's any glaring omissions or mistakes, feel free to edit the wiki.

@baxerus
Copy link
Author

baxerus commented Aug 8, 2016

Method signatures would be great (for me). But I think most other users would like everything you mentioned, demos (aka demo-code) and tutorials.

For the illustrations, look at how this guy have done it (the best thing I have seen vor OpenSCAD code till now):
https://github.com/revarbat/snappy-reprap
All the illustrations are generated by OpenSCAD (controlled by a makefile) from OpenSCAD files of course. Perhaps this is a little bit oversized (but actually cool) for your case, but a simple what-ever-script (shell, python, ruby, ...) and the illustrations next to the OpenSCAD files for the illustrations is already a bunch of demo code a user could look at to understand how methods should be used.
And since we are on GitHub I think users will be able to browse into an "illustration" folder and look into the scad files, if they are interested!

@thecraw
Copy link

thecraw commented Mar 17, 2017

Library looks awesome and documentation is extensive but I am a little thick. I was going through the example you had for the little stepping motor and came across the translated function. Not sure how exactly your variables in this work. I understand the 31mm * the y vector but don't understand the [-1,1]/2 and how that gives you two screws. I am not a css guy so if it comes from that I don't have that background. Is there somewhere that describes the options of the inputs to this function. In normal scad I am using the translate function all the time and this looks way better but not sure what the square brackets do for you.

Thanks for any help with this and amazing work. I am in awe.

@thecraw
Copy link

thecraw commented Mar 17, 2017

Is there anyway to have Box with different dimension like cube does. All examples using Box seem to have x y and z all same. I tried varying them like box(12,10,80) but it only seems to use first dimension. How would you do this if your box or cube is not the same in all dimensions?

@davidson16807
Copy link
Owner

@thecraw:

don't understand the [-1,1]/2 and how that gives you two screws

Not css, just a trick with vectors. The vector [-1,1]/2 is equivalent to [-1/2,1/2]. translated will take a list as the second argument and multiply each element by the first. If I called translated(31*y, [-1,1]) my screws would be 31*2=62mm apart, but I want them 31mm apart, so I call translated(31*y, [-1,1]).

I tried varying them like box(12,10,80) but it only seems to use first dimension

It needs to be a vector, like box([12,10,80]). OpenSCAD's built-in cube function behaves the same way.

This is good feedback. I'll work this into the wiki.

@thecraw
Copy link

thecraw commented Mar 21, 2017 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants