Skip to content
This repository has been archived by the owner on Feb 13, 2021. It is now read-only.

Documentation for scene construction helpers #530

Closed
deltakosh opened this issue Jul 14, 2017 · 15 comments
Closed

Documentation for scene construction helpers #530

deltakosh opened this issue Jul 14, 2017 · 15 comments

Comments

@deltakosh
Copy link
Contributor

Need a simple doc to present how to use createDefaultCameraOrLighting and createDefaultSkybox

https://www.babylonjs-playground.com/#SIB60G#4

@brian-hay
Copy link
Contributor

@deltakosh I could have a go at this.

Let me know if there's any other doc priorities, especially English review/rewrite stuff.

@deltakosh
Copy link
Contributor Author

Any issue here is important so feel free to pick this one

@deltakosh
Copy link
Contributor Author

Thanks a lot btw

@brian-hay
Copy link
Contributor

I can't seem to assign myself, or do you need to do that?

@deltakosh
Copy link
Contributor Author

I can't either as you did not create the issue. But consider it yours!

@brian-hay
Copy link
Contributor

OK.

@brian-hay
Copy link
Contributor

I'm a little confused about the difference between createDefaultCamera() & createDefaultCameraOrLight() - in the Class API docs they seem to have the same method parameters, but only the latter method is in the source code, so I'm assuming it's a temporary doc generation glitch?

Do you want these docs in 101, how to or features section? And with createDefaultCameraOrLight() most other documentation like this that I see is subcategorised under "light" or "camera" - it can't be tagged both as far as I can see. So unclear where exactly it should go.

I'll stop bothering you when I more familiar with the doc structure. It's just because I'm new ...

@brian-hay
Copy link
Contributor

Sorry I see createDefaultCamera() in 3.2.0-beta.1 and I understand the intent there, so disregard that question.

But question of where docs should ideally go still stands.

@BabylonJSGuide
Copy link
Collaborator

The sections are loosely intended as

features - this gives an overview of the features of BJS objects in categories and usually just gives a brief mention and short description with links to a more detailed explanation in 101 or How To. Probably these methods get a mention in the scene section of features and could also get a mention in camera, lights and environment sections of features

101 - read through from start to finish as a basic introduction to Babylon.js with examples to build a starter project. So possibly added detail in the camera, lights and environment pages

How To - detailed explanations and examples of features beyond 101. Never any harm in repeating small sections so an example in http://doc.babylonjs.com/how_to/load_from_any_file_type might not got amiss.

Sorry not to be more precise but other than where to place these methods is not entirely clear to me.

@deltakosh
Copy link
Contributor Author

deltakosh commented Mar 24, 2018

I could see a new chapter here about helpers:
http://doc.babylonjs.com/features/scene

We could even reference the scene.createDefaultEnvironment (Which is detailed in the environment 101) and the scene.createDefaultVRExperience (Which has its own chapter)

@brian-hay
Copy link
Contributor

New section helpers it is. Thanks @deltakosh and @BabylonJSGuide

Will aim to get it done within the next week.

@deltakosh
Copy link
Contributor Author

Much appreciated

@BabylonJSGuide
Copy link
Collaborator

Good plan

@deltakosh
Copy link
Contributor Author

up?

@BabylonJSGuide
Copy link
Collaborator

Issue #1101 was a re-statement of this and has now been dealt with.

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

No branches or pull requests

3 participants