ThatOpen / engine_docs

https://docs-one-orpin.vercel.app
9 stars 11 forks source link

SimpleScene documentation is outdated #14

Closed daniel-augusto closed 4 months ago

daniel-augusto commented 1 year ago

Original posted in https://github.com/IFCjs/components/issues/141, by Maozerhouni

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
agviegas commented 4 months ago

Everything is now updated! Let me know otherwise