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.

Implements

Editor

Constructors

constructor

new AbstractEditor(__namedParameters?: EditorParams): 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: Object3D, parent?: Object3D, index?: number): void
Add an object to the parent or scene.
Parameters
- object: Object3D
  Object to be added
- Optionalparent: Object3D
  Parent of the object. Fallback to scene if not provided.
- Optionalindex: number
  Index of the object to be added in the parent
Returns void
Implementation of Editor.addObject
- Defined in src/editor/AbstractEditor.ts:183

deselect

deselect(object?: Object3D<Object3DEventMap>): void
Deselect the selected object.
Parameters
- Optionalobject: Object3D<Object3DEventMap>
  object to be selected
Returns void
Implementation of Editor.deselect
- Defined in src/editor/AbstractEditor.ts:267

execute

execute(command: Command, optionalName?: string): void
Execute a Command.
Parameters
- command: Command
  Command to be executed
- OptionaloptionalName: string
  Optional name of the command
Returns void
Implementation of Editor.execute
- Defined in src/editor/AbstractEditor.ts:275

focus

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

fromJSON

fromJSON(json: EditorJSON): void
Creates a new instance of this class based on the given JSON.
Parameters
- json: EditorJSON
Returns void
Implementation of Editor.fromJSON
- Defined in src/editor/AbstractEditor.ts:287

moveObject

moveObject(object: Object3D, parent?: Object3D, before?: Object3D): void
Move an object to the parent or scene.s Remove the object from the original parent if it exists.
Parameters
- object: Object3D
  Object to be moved
- Optionalparent: Object3D
  New parent of the object. Fallback to scene if not provided.
- Optionalbefore: Object3D
  Previous parent of the object.
Returns void
Implementation of Editor.moveObject
- Defined in src/editor/AbstractEditor.ts:199

nameObject

nameObject(object: Object3D, name: string): void
Rename an object.
Parameters
- object: Object3D
  Object to be renamed
- name: string
  New name of the object
Returns void
Implementation of Editor.nameObject
- Defined in src/editor/AbstractEditor.ts:219

objectByUuid

objectByUuid(uuid: string): undefined | Object3D
Get an object by its uuid.
Parameters
- uuid: string
  UUID of the object
Returns undefined | Object3D
Object with the given uuid
Implementation of Editor.objectByUuid
- Defined in src/editor/AbstractEditor.ts:271

redo

redo(): void
Redo the last executed command Will fail if something goes wrong with the command.

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

removeObject

removeObject(object: Object3D): void
Remove an object from its parent.
Parameters
- object: Object3D
  Object to be removed
Returns void
Implementation of Editor.removeObject
- Defined in src/editor/AbstractEditor.ts:226

select

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

selectById

selectById(id: number): void
Select an object by its id.
Parameters
- id: number
  Id of the object to be selected
Returns void
Implementation of Editor.selectById
- Defined in src/editor/AbstractEditor.ts:239

selectByUuid

selectByUuid(uuid: string, traverse?: boolean): void
Select an object by its uuid.
Parameters
- uuid: string
  uuid of the object to be selected
- traverse: boolean = false
Returns void
Implementation of Editor.selectByUuid
- Defined in src/editor/AbstractEditor.ts:255

setCamera

setCamera(camera: SupportedCameras): void
Set the Camera to be used. This will switch the camera internally and dispatch a signal.
Parameters
- camera: SupportedCameras
  Camera to be set
Returns void
Implementation of Editor.setCamera
- Defined in src/editor/AbstractEditor.ts:347

setScene

setScene(scene: Scene): void
Set the THREE.Scene | Scene to be rendered.
Parameters
- scene: Scene
  THREE.Scene | Scene to be rendered.
Returns void
Implementation of Editor.setScene
- Defined in src/editor/AbstractEditor.ts:150

test

test(): boolean
E2E test method.

This method should return true if the test passes, and false if it fails. Check the method itself for more information.

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

toggleDebug

toggleDebug(): void
Whether to show the debug panel.

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

toJSON

toJSON(): EditorJSON
Returns a JSON representation of this class.

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

undo

undo(): undefined | Command
Undo the last executed command. Will fail if something goes wrong with the command.

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

Class AbstractEditorAbstract

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AbstractEditor

Properties

camera

Optionalconfig

debugger

gisHelper

history

loaderManager

OptionalmobileUtils

Type declaration

isMobile: boolean

isOS: null | RegExpMatchArray

isTouch: boolean

orthographicCamera

perspectiveCamera

scene

selected

selector

signals

spatialHashGrid

Optionalstorage

Methods

addObject

Parameters

Returns void

deselect

Parameters

Returns void

execute

Parameters

Returns void

focus

Parameters

Returns void

fromJSON

Parameters

Returns void

moveObject

Parameters

Returns void

nameObject

Parameters

Returns void

objectByUuid

Parameters

Returns undefined | Object3D

redo

Returns void

removeObject

Parameters

Returns void

select

Parameters

Returns void

selectById

Parameters

Returns void

selectByUuid

Parameters

Returns void

setCamera

Parameters

Returns void

setScene

Parameters

Returns void

test

Returns boolean

toggleDebug

Returns void

toJSON

Class AbstractEditor`Abstract`

`Optional`config

`Optional`mobileUtils

`Optional`storage