thatopen / engine_docs Goto Github PK
View Code? Open in Web Editor NEWHome Page: https://docs-one-orpin.vercel.app
Home Page: https://docs-one-orpin.vercel.app
Right now, code blocks in the documentation doesn't have indentations. Would be great to have them in order to better read the code.
No response
No response
N/A
yarn
No response
Hi, in the tutorial for the PostproductionRenderer we should have the absolute url for the file instead for the relative one.
Thanks.
asdf
asdf
asdf
asdf
npm
asdf
Original posted in ThatOpen/engine_components#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
In this tutorial the retrieval of tools is explained like this:
const hwTool = await components.get(HelloWorldTool.uuid);
but it works with the tools attribute and without the uuid like this:
const hwTool = await components.tools.get(HelloWorldTool);
Also the tutorial should note, that the retrieval only works, if the components constructor doesnβt get other parameters than OBC.Components. If the class needs more to function, I would recommend to write a setup() Method that takes everything else.
No response
No response
Not needed since the error is in the content of the docs
npm
No response
Right now the documentation is an iframe in the platform. We want to make it standalone so that we can use all docusaurus features (such as URL paths for each tutorial)
No response
No response
No response
Currently, the 3 dimensions examples are using CSS classes (.ifcjs-dimension-label, etc) that has no relevance as the applied styles in components are coming from Tailwind.
No response
No response
N/A
npm
No response
I notice it's not clear how to locally test the library.
I followed this: https://github.com/IFCjs/docs/blob/main/docs/components/contributing.md#start-coding
The issue with the three steps is that is not enough to test my changes locally. My case is that I'm using react to develop/test and not vanila js.
I saw on npm I can use npm link
(https://docs.npmjs.com/cli/v10/commands/npm-link) to locally test the changes.
I did it and it works, the only problem is I had to follow the following process:
npm run build
cp package.json dist/
npm link
npm link openbim-components
Step 2 is the one I feel strange, maybe copying package.json
inside the dist folder or have a command that does 1,2 and 3?
Besides that, I could work on the documentation to be more clear.
Thoughts?
Link to Setting up a nav cube tutorial (https://top-docs.vercel.app/docs/Tutorials/CubeMap.mdx) on page https://top-docs.vercel.app/docs/components/tutorial-paths results in error 404
Documentation > Components > Tutorial paths >Making great 3D apps > Setting up a nav cube
I was going through the Tutorial Path and realised the link embedeed in the "Create some clipping planes" redirects to the previous SimpleRaycaster tutorial. I'm assuming this is a bug rather than the tutotial being outright unavailable :)
https://docs.thatopen.com/components/tutorial-paths
System:
OS: Windows 10 10.0.19045
CPU: (8) x64 Intel(R) Core(TM) i7-7700HQ CPU @ 2.80GHz
Memory: 5.98 GB / 15.89 GB
Binaries:
Node: 16.16.0 - C:\Program Files\nodejs\node.EXE
npm: 8.11.0 - C:\Program Files\nodejs\npm.CMD
Browsers:
Edge: Spartan (44.19041.3636.0), Chromium (120.0.2210.61)
Internet Explorer: 11.0.19041.3636
npmPackages:
openbim-components: ^1.2.0 => 1.2.0
npm
No response
I'm trying to use the package of IFC.js but it doesn't works for my IFC file, I'n not sure what could be happening because it works with others viewers. But I'm using it with others IFC files and it works
No response
No response
nO
npm
No response
Given the growing amount of components, APIs, and tutorials, it would be very handy to have a search through the documentation.
As registered in #22, there is some documentation out of date.
This issue will update the references of highlighter.outlinesEnabled
to highlighter.outlineEnabled
as we can found in https://github.com/IFCjs/components/blob/main/src/fragments/FragmentHighlighter/index.ts#L85
Reposting this issue from the thread: https://people.thatopen.com/c/conversations?message_id=18993632#message_18993632
The documentation is published in vercel.app page, which is then embedded as iframe in the https://platform.thatopen.com/documentation pages. This embed works well until you open internal link to other documentation page in a new browser tab - then you get carried straight to the https://top-docs.vercel.app/docs and lose all of the platform functionality.
I am attempting to follow the documentation as closely as possible and there have been multiple instances where the documentation has been outright incorrect in regards to types and what is actually available.
Examples of instances of missing documented properties/methods:
components.scene.setup()
, where setup()
does not existcomponents.renderer.postproduction.customEffects.outlineEnabled = true
, where postproduction
does not existhighlighter.outlinesEnabled = true
, where the actual call is highlighter.outlineEnabled = true
.With running into just these few variances, there have to be multiple more. The variance between the documentation and the actual types can get frustrating and if types are included, they should accurately describe available functionality, methods, and properties.
No response
Node, Vite, Typescript, MacOS
npm
No response
A declarative, efficient, and flexible JavaScript library for building user interfaces.
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. πππ
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google β€οΈ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.