Type alias Editor

Editor: {
    addObject: ((object, parent?, index?) => void);
    camera: THREE.Camera;
    config?: Config;
    debugger: Debugger | null;
    focus: ((object) => void);
    gisHelper: GISHelper;
    loaderManager: LoaderManager;
    moveObject: ((object, parent?, before?) => void);
    nameObject: ((object, name) => void);
    objectByUuid: ((uuid) => Object3D | undefined);
    orthographicCamera: THREE.OrthographicCamera;
    perspectiveCamera: THREE.PerspectiveCamera;
    removeObject: ((object) => void);
    scene: THREE.Scene;
    selectById: ((id) => void);
    selectByUuid: ((uuid) => void);
    selected: Object3D[];
    selector: Selector;
    setCamera: ((camera) => void);
    setScene: ((scene) => void);
    signals: EditorSignals;
    spatialHashGrid: SpatialHashGrid;
    toggleDebug() => void;
} & Pick<History, "execute" | "undo" | "redo"> & Pick<Selector, "select" | "deselect"> & SerializableObject & Test

The Editor is the meat of the application. It holds the scene, the camera, the signals, the loader manager, the selector, the debugger and the config.

Type declaration

  • addObject: ((object, parent?, index?) => void)
      • (object, parent?, index?): void

      • Add an object to the parent or scene.

        Parameters

        • object: Object3D

          Object to be added

        • Optional parent: Object3D

          Parent of the object. Fallback to scene if not provided.

        • Optional index: number

          Index of the object to be added in the parent

        Returns void

  • camera: THREE.Camera
  • Optional config?: Config
  • debugger: Debugger | null
  • focus: ((object) => void)
      • (object): void

      • Focus on an object.

        Parameters

        Returns void

  • gisHelper: GISHelper
  • loaderManager: LoaderManager
  • moveObject: ((object, parent?, before?) => void)
      • (object, parent?, before?): void

      • Move an object to the parent or scene.s Remove the object from the original parent if it exists.

        Parameters

        Returns void

  • nameObject: ((object, name) => void)
      • (object, name): void

      • Rename an object.

        Parameters

        • object: Object3D

          Object to be renamed

        • name: string

          New name of the object

        Returns void

  • objectByUuid: ((uuid) => Object3D | undefined)
      • (uuid): Object3D | undefined

      • Get an object by its uuid.

        Parameters

        • uuid: string

          UUID of the object

        Returns Object3D | undefined

        Object with the given uuid

  • orthographicCamera: THREE.OrthographicCamera
  • perspectiveCamera: THREE.PerspectiveCamera
  • removeObject: ((object) => void)
      • (object): void

      • Remove an object from its parent.

        Parameters

        Returns void

  • scene: THREE.Scene
  • selectById: ((id) => void)
      • (id): void

      • Select an object by its id.

        Parameters

        • id: number

          Id of the object to be selected

        Returns void

  • selectByUuid: ((uuid) => void)
      • (uuid): void

      • Select an object by its uuid.

        Parameters

        • uuid: string

          uuid of the object to be selected

        Returns void

  • selected: Object3D[]
  • selector: Selector
  • setCamera: ((camera) => void)
      • (camera): void

      • Set the Camera to be used. This will switch the camera internally and dispatch a signal.

        Parameters

        Returns void

  • setScene: ((scene) => void)
      • (scene): void

      • Set the THREE.Scene | Scene to be rendered.

        Parameters

        • scene: THREE.Scene

          THREE.Scene | Scene to be rendered.

        Returns void

  • signals: EditorSignals
  • spatialHashGrid: SpatialHashGrid
  • toggleDebug:function

Settings

Member Visibility

Theme

Generated using TypeDoc