Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.78 KB

README.md

File metadata and controls

41 lines (26 loc) · 1.78 KB

xeokit-sdk React integration

This attempt to integrate the xeokit-sdk's GLTF viewer into a React application aims to largely satisfy/provide the following requirements/features:

Initially supported set of features:

  • specify the dimensions of the viewer/canvas
  • render one or multiple viewer components
  • load scene with predefined camera settings
  • load one or multiple models into one scene
  • provide convenient camera presets/controls
  • dynamically add/remove models to/from a scene
  • load BCF viewpoint
  • highlight/pick entities
  • take screenshots of scene

Documentation

Documentation can be found at https://bimspot.gitbook.io/xeokit-react/. Please note that the documentation is a work in progress. Nevertheless, if you find any errors or can't find proper documentation on a particular feature, do let us know and we'll do our best to remedy the situation.

Bug tracking, feature requests

Indicate bugs, feature requests and any other issues here: https://github.com/bimspot/xeokit-react/issues.

Todos, ideas

Some open questions:

Contributing

Please find our contribution guidelines @ our docs pages; look for the Contribution guidelines menu in the sidebar.


create-react-app docs for the demo application:

Please refer to the official create-react-app documentation to run and/or build the demo application.