Skip to content

Conversation

BigTurtle8
Copy link

Fix incorrect example in README.md under Basic Usage.

Fix incorrect example in `README.md` under `Basic Usage`.
@BigTurtle8
Copy link
Author

While not relevant to this fix specifically, in useProps and specifically the Advanced Usage section, three.camera should be three.currentCamera).

@bigmistqke
Copy link
Contributor

Hey @BigTurtle8 !

I just pushed a big refactor of the README.
For some reason I didn't see ur PR before, my bad. Thanks a lot for making me aware of the doc mismatches 🙏

Instead of changing documentation of currentCamera and currentRaycaster, I reverted the api so that it is useThree().camera and useThree().raycaster`. It was too confusing to differentiate between them.

I kept defaultCamera and defaultRaycaster for the Canvas-props. Lmk what you think about that.

I will be focussing on shipping solid-three next, I was exploring a plugin-system (#37) but I am going to move that to the backlog.

@BigTurtle8
Copy link
Author

Hey @bigmistqke, thanks for the response. I just saw the refactor! On initial glance it looks nice, I'll definitely get back to you if I find anything off.

useThree().camera (and related change) is probably for the best. And as for the Canvas props, honestly from my current perspective as long the props align with the documentation I think it's all good.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants