building-editor

The goal of this project is to provide base implementation of web 3D editor for building/architecture which can be used easily. The codes are based on three.js editor fork, as we respect the great work of three.js.

Note: This project is under development. Please remember that there would be breaking changes. Or you can join us to make this project better for users.

Installation

npm install building-editor

Usage

Sample code

import { Editor } from 'building-editor';

const editor = new Editor();
document.body.appendChild(editor.renderer.domElement);

const init = () => {
  const width = window.innerWidth;
  const height = window.innerHeight;
  editor.renderer.setPixelRatio(window.devicePixelRatio);
  editor.renderer.setSize(width, height);
  editor.render();
}

init();

API

Editor

The main API of this library to create web 3D editor. This includes properties and actions. Note that you need to implement user interactions such as selected, hovered etc., using addEventListener since Editor itself does not provide it.

Constructor

Editor()

This creates a new Editor.

Properties and Methods

Editor has many properties and methods. Please check Editor class to find them. The documents will be prepared later.