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

Documentation for IDCount functions #10095

Closed
looeee opened this issue Nov 10, 2016 · 12 comments
Closed

Documentation for IDCount functions #10095

looeee opened this issue Nov 10, 2016 · 12 comments

Comments

@looeee
Copy link
Collaborator

looeee commented Nov 10, 2016

There are four IDCount functions:

  • THREE.GeometryIdCount()
  • THREE.MaterialIdCount()
  • THREE.Object3DIdCount()
  • THREE.TextureIdCount()

They are part of the API (can be accessed via THREE.GeometryIdCount() etc. ) so they should be documented.

The question is, where? Should they get a separate page, or be included in the Geometry, Material... pages?

@aardgoose
Copy link
Contributor

Note GeometryIdCount is also used by BufferGeometry which may influence your choice, which would tend to indicate a separate page, to avoid duplication. Not sure how useful they are though.

@mrdoob
Copy link
Owner

mrdoob commented Nov 10, 2016

These are not supposed to be accessible to the user. Now that we're using modules should be easy to hide them. I'll see if I can work this out.

@mrdoob
Copy link
Owner

mrdoob commented Dec 14, 2016

GeometryIdCount is still pending to be removed. Will leave it for the next cycle though.

@looeee looeee reopened this Dec 15, 2016
@looeee
Copy link
Collaborator Author

looeee commented Dec 15, 2016

OK, I'll leave this open for now

@Mugen87
Copy link
Collaborator

Mugen87 commented Sep 18, 2017

We can't remove GeometryIdCount() like the other functions because both BufferGeometry and Geometry need to share the same ID generation. Should we agree to keep the function and close the issue?

@looeee
Copy link
Collaborator Author

looeee commented Sep 19, 2017

I'm OK with this, although the functions should be documented if they are exposed

@Mugen87
Copy link
Collaborator

Mugen87 commented Sep 22, 2017

Then i would suggest to document GeometryIdCount() for now and note that the function is intended for internal usage only.

@dubejf
Copy link
Contributor

dubejf commented Sep 23, 2017

You could use even/odd Ids for BufferGeometry and Geometry and increment by two to get rid GeometryIdCount().

@mrdoob
Copy link
Owner

mrdoob commented Sep 24, 2017

You could use even/odd Ids for BufferGeometry and Geometry and increment by two to get rid GeometryIdCount().

Interesting! 😀

@Mugen87
Copy link
Collaborator

Mugen87 commented Sep 24, 2017

Indeed! 😊 We should give this a try!

@mrdoob
Copy link
Owner

mrdoob commented Sep 24, 2017

Actually, I don't even know why GeometryIdCount() was public...

mrdoob added a commit that referenced this issue Sep 24, 2017
@mrdoob
Copy link
Owner

mrdoob commented Sep 24, 2017

Okay. This can be closed now.
Thanks @dubejf!

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

No branches or pull requests

5 participants