engine_components icon indicating copy to clipboard operation
engine_components copied to clipboard

SimpleScene documentation is outdated

Open Maozerhouni opened this issue 2 years ago • 2 comments

Hi,

Exploring the different tutorials, it seems it is non-compliant with what should be done. For example, Simple scene tutorial : ` const container = document.getElementById('container');

const components = new OBC.Components(); components.scene = new OBC.SimpleScene(components); components.renderer = new OBC.SimpleRenderer(components, container); components.camera = new OBC.SimpleCamera(components); components.raycaster = new OBC.SimpleRaycaster(components);Wouldn't be enough. Scene shall be initialised. Code should be more like : const viewer = new OBC.Components()

const sceneComponent = new OBC.SimpleScene(viewer) sceneComponent.setup() viewer.scene = sceneComponent

const viewerContainer = document.getElementById("app") as HTMLDivElement const rendererComponent = new OBC.SimpleRenderer(viewer, viewerContainer) viewer.renderer = rendererComponent

const cameraComponent = new OBC.SimpleCamera(viewer) viewer.camera = cameraComponent

const raycasterComponent = new OBC.SimpleRaycaster(viewer) viewer.raycaster = raycasterComponent `

Maozerhouni avatar Oct 14 '23 10:10 Maozerhouni

Hi @Maozerhouni , I replicated this issue in IFCjs/docs project and submitted a Pull Request to update documentation.

See a similar question registered at https://github.com/IFCjs/docs/issues/22

And PR: https://github.com/IFCjs/docs/pull/13/commits/aab53e6d02e2c1454cf16ae964b88b581247a2db

daniel-augusto avatar Oct 15 '23 08:10 daniel-augusto

Thanks a lot for the help @daniel-augusto! Small notice: the tutorials are written in JavaScript because they are directly written in the HTML of the example where they are executed, so things like type assertions are not possible. But we'll update it right away!

agviegas avatar Nov 03 '23 11:11 agviegas

Fixed! You can check it here.

agviegas avatar Jun 19 '24 10:06 agviegas