Class AbstractEditor`Abstract`

Abstract class for all viewers.

Each method begins with some manipulation of the scene, the objects or the camera. This means that the arguments are sometimes mutated. This is fine. This is by design.

Finally, when everything is ok - a signal is dispatched. Check the methods' implementations for more details.

Hierarchy

AbstractEditor

Implements

Editor

Constructors

constructor

new AbstractEditor(__namedParameters?): AbstractEditor
Parameters
- __namedParameters: EditorParams = {}
Returns AbstractEditor
- Defined in src/editor/AbstractEditor.ts:117

Properties

camera

camera: Camera

`Optional` config

config?: Config

debugger

debugger: null | Debugger

gisHelper

gisHelper: GISHelper

history

history: History

loaderManager

loaderManager: LoaderManager

`Optional` mobileUtils

mobileUtils?: {
    isMobile: boolean;
    isOS: null | RegExpMatchArray;
    isTouch: boolean;
}

Type declaration

isMobile: boolean

Determines if the current device is a mobile device
isOS: null | RegExpMatchArray
isTouch: boolean

orthographicCamera

orthographicCamera: OrthographicCamera

perspectiveCamera

perspectiveCamera: PerspectiveCamera

scene

scene: Scene

selected

selected: Object3D[]

selector

selector: AbstractSelector

signals

signals: EditorSignals

spatialHashGrid

spatialHashGrid: SpatialHashGrid

`Optional` storage

storage?: Storage

Methods

addObject

addObject(object, parent?, index?): void
Parameters
- object: Object3D
- Optional parent: Object3D
- Optional index: number
Returns void
Implementation of Editor.addObject
- Defined in src/editor/AbstractEditor.ts:183

deselect

deselect(object?): void
Parameters
- Optional object: Object3D<Object3DEventMap>
Returns void
Implementation of Editor.deselect
- Defined in src/editor/AbstractEditor.ts:267

execute

execute(command, optionalName?): void
Parameters
- command: Command
- Optional optionalName: string
Returns void
Implementation of Editor.execute
- Defined in src/editor/AbstractEditor.ts:275

focus

focus(object): void
Parameters
- object: Object3D
Returns void
Implementation of Editor.focus
- Defined in src/editor/AbstractEditor.ts:316

fromJSON

fromJSON(json): void
Parameters
- json: EditorJSON
Returns void
Implementation of Editor.fromJSON
- Defined in src/editor/AbstractEditor.ts:287

moveObject

moveObject(object, parent?, before?): void
Parameters
- object: Object3D
- Optional parent: Object3D
- Optional before: Object3D
Returns void
Implementation of Editor.moveObject
- Defined in src/editor/AbstractEditor.ts:199

nameObject

nameObject(object, name): void
Parameters
- object: Object3D
- name: string
Returns void
Implementation of Editor.nameObject
- Defined in src/editor/AbstractEditor.ts:219

objectByUuid

objectByUuid(uuid): undefined | Object3D
Parameters
- uuid: string
Returns undefined | Object3D
Implementation of Editor.objectByUuid
- Defined in src/editor/AbstractEditor.ts:271

redo

redo(): void
Returns void
Implementation of Editor.redo
- Defined in src/editor/AbstractEditor.ts:283

removeObject

removeObject(object): void
Parameters
- object: Object3D
Returns void
Implementation of Editor.removeObject
- Defined in src/editor/AbstractEditor.ts:226

select

select(object): void
Parameters
- object: Object3D | Object3D[]
Returns void
Implementation of Editor.select
- Defined in src/editor/AbstractEditor.ts:235

selectById

selectById(id): void
Parameters
- id: number
Returns void
Implementation of Editor.selectById
- Defined in src/editor/AbstractEditor.ts:239

selectByUuid

selectByUuid(uuid, traverse?): void
Parameters
- uuid: string
- traverse: boolean = false
Returns void
Implementation of Editor.selectByUuid
- Defined in src/editor/AbstractEditor.ts:255

setCamera

setCamera(camera): void
Parameters
- camera: SupportedCameras
Returns void
Implementation of Editor.setCamera
- Defined in src/editor/AbstractEditor.ts:347

setScene

setScene(scene): void
Parameters
- scene: Scene
Returns void
Implementation of Editor.setScene
- Defined in src/editor/AbstractEditor.ts:150

test

test(): boolean
Returns boolean
Implementation of Editor.test
- Defined in src/editor/AbstractEditor.ts:322

toJSON

toJSON(): EditorJSON
Returns EditorJSON
Implementation of Editor.toJSON
- Defined in src/editor/AbstractEditor.ts:307

toggleDebug

toggleDebug(): void
Returns void
Implementation of Editor.toggleDebug
- Defined in src/editor/AbstractEditor.ts:352

undo

undo(): undefined | Command
Returns undefined | Command
Implementation of Editor.undo
- Defined in src/editor/AbstractEditor.ts:279

Class AbstractEditorAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: EditorParams = {}

Returns AbstractEditor

Properties

camera

Optional config

debugger

gisHelper

history

loaderManager

Optional mobileUtils

Type declaration

isMobile: boolean

isOS: null | RegExpMatchArray

isTouch: boolean

orthographicCamera

perspectiveCamera

scene

selected

selector

signals

spatialHashGrid

Optional storage

Methods

addObject

Parameters

object: Object3D

Optional parent: Object3D

Optional index: number

Returns void

deselect

Parameters

Optional object: Object3D<Object3DEventMap>

Returns void

execute

Parameters

command: Command

Optional optionalName: string

Returns void

focus

Parameters

object: Object3D

Returns void

fromJSON

Parameters

json: EditorJSON

Returns void

moveObject

Parameters

object: Object3D

Optional parent: Object3D

Optional before: Object3D

Returns void

nameObject

Parameters

object: Object3D

name: string

Returns void

objectByUuid

Parameters

uuid: string

Returns undefined | Object3D

redo

Returns void

removeObject

Parameters

object: Object3D

Returns void

select

Parameters

object: Object3D | Object3D[]

Class AbstractEditor`Abstract`

`Optional` config

`Optional` mobileUtils

`Optional` storage

`Optional` parent: Object3D

`Optional` index: number

`Optional` object: Object3D<Object3DEventMap>

`Optional` optionalName: string

`Optional` parent: Object3D

`Optional` before: Object3D