Class Warehouse3D`Abstract`

Hierarchy

Implements

Index

Constructors

constructor

Constructors

constructor

new Warehouse3D(): Warehouse3D
Returns Warehouse3D
Inherited from Core.constructor
- Defined in node_modules/eventemitter3/index.d.ts:88

Properties

`Readonly` $$isEmitter

$$isEmitter: true

`Private` _lastHighlight

_lastHighlight: WikAnimationExports = null

`Readonly` camera

camera: PerspectiveCamera = null

`Readonly` center

center: Vector3 = ...

`Readonly` controls

controls: IControl = null

`Readonly` event

event: WarehouseEvent = ...

`Readonly` frameOptions

frameOptions: FrameCallFuncOptions[] = []

`Readonly` frames

frames: FrameCallFunc[] = []

use in threejs or pixijs

`Readonly` globalConst

globalConst: GlobalConstManager

`Readonly` ground

ground: Mesh<BufferGeometry, Material | Material[]> = null

`Readonly` injector

injector: IInjector

isClickEventFireCancelled

isClickEventFireCancelled: boolean

`Readonly` layouted

layouted: boolean = false

`Readonly` modeManager

modeManager: IModeManager

`Readonly` mounted

mounted: boolean = false

noEmit

noEmit: boolean

set it True, the follow emit will be ignore and then set it False.

`Readonly` options

options: Warehouse3DOptions = ...

`Readonly` renderer

renderer: Renderer = null

`Readonly` root

root: Scene

`Readonly` selectionManager

selectionManager: ISelectionManager

`Abstract` size

size: number

`Readonly` types

types: Map<string, Object3DList<Object3D<Event>>> = ...

`Readonly` updateDeps

updateDeps: Record<string, any> = {}

Methods

$set

$set(pairs: string | Record<string, any>, value?: any, context?: object): void
Parameters
- pairs: string | Record<string, any>
- Optional value: any
- Optional context: object
Returns void
Inherited from Core.$set
- Defined in src/model/basic/Core.class.ts:7

$type

$type<O>(type: string): Object3DList<O>
Type Parameters
- O extends Object3D<Event, O>
Parameters
- type: string
Returns Object3DList<O>
Implementation of IWarehouse.$type
- Defined in src/3d/Warehouse.class.ts:614

$untype

$untype(type: string): void
Parameters
- type: string
Returns void
Implementation of IWarehouse.$untype
- Defined in src/3d/Warehouse.class.ts:627

[iterator]

[iterator](): Iterator<Object3D<Event>, any, undefined>
Returns Iterator<Object3D<Event>, any, undefined>
Implementation of IWarehouse.__@iterator@1048
- Defined in src/3d/Warehouse.class.ts:691

add

add<M>(type: string, item: M): void
Type Parameters
- M extends Object3D<Event, M> = Object3D<Event>
Parameters
- type: string
- item: M
Returns void
Implementation of IWarehouse.add
- Defined in src/3d/Warehouse.class.ts:654

applyBehavior

applyBehavior(type: string, target: Object3D<Event>, event?: any): void
Parameters
- type: string
- target: Object3D<Event>
- Optional event: any
Returns void
- Defined in src/3d/Warehouse.class.ts:72

cancelClickEventFire

cancelClickEventFire(): void
Returns void
Inherited from WithClickCancel.cancelClickEventFire
- Defined in src/model/basic/ClickCancel.ts:22

clear

clear(type: string): void
Parameters
- type: string
Returns void
- Defined in src/3d/Warehouse.class.ts:666

configModes

configModes(): Record<string, IBehavior[]>
default is empty, you can overrides it.

Returns Record<string, IBehavior[]>
Implementation of IWarehouse.configModes
- Defined in src/3d/Warehouse.class.ts:680

create

create<C>(ctor: C, ...args: ConstructorParameters<C>): InstanceType<C>
Type Parameters
- C extends Constructor<object, C>
Parameters
- ctor: C
- Rest ...args: ConstructorParameters<C>
Returns InstanceType<C>
Implementation of IWarehouse.create
- Defined in src/3d/Warehouse.class.ts:684

createFlashing

createFlashing(obj: Mesh<BufferGeometry, Material | Material[]>, dur: number, mi?: number): WikAnimationExports
Parameters
- obj: Mesh<BufferGeometry, Material | Material[]>
- dur: number
- mi: number = null
Returns WikAnimationExports
- Defined in src/3d/Warehouse.class.ts:185

createHighlight

createHighlight(obj: Mesh<BufferGeometry, Material | Material[]>, dur: number, pos?: Vector3): WikAnimationExports
Parameters
- obj: Mesh<BufferGeometry, Material | Material[]>
- dur: number
- Optional pos: Vector3
Returns WikAnimationExports
- Defined in src/3d/Warehouse.class.ts:246

createRotation

createRotation(obj: Object3D<Event>, toQ: Quaternion, dur?: number): WikAnimationExports
Parameters
- obj: Object3D<Event>
- toQ: Quaternion
- dur: number = 0
Returns WikAnimationExports
- Defined in src/3d/Warehouse.class.ts:320

createTranslation

createTranslation(obj: Object3D<Event>, to: Partial<Position>, dur: number): WikAnimationExports
Parameters
- obj: Object3D<Event>
- to: Partial<Position>
- dur: number
Returns WikAnimationExports
- Defined in src/3d/Warehouse.class.ts:102

dispose

dispose(): void
Returns void
Implementation of IDisposable.dispose
- Defined in src/3d/Warehouse.class.ts:604

each

each(fn: ((item: GraphicObject, type: string) => void), type?: string): void
Parameters
- fn: ((item: GraphicObject, type: string) => void)
  - - (item: GraphicObject, type: string): void
    - Parameters
      
      item: GraphicObject
      
      type: string
      
      Returns void
- Optional type: string
Returns void
Implementation of IWarehouse.each
- Defined in src/3d/Warehouse.class.ts:638

fire

fire<T>(event: T, payload?: PlainObject): boolean
Type Parameters
- T extends string
Parameters
- event: T
- Optional payload: PlainObject
Returns boolean
Inherited from Core.fire
- Defined in src/model/basic/Emitter.ts:147

fire$n

fire$n(event: string, payload?: PlainObject): Warehouse3D
split fire
Parameters
- event: string
- Optional payload: PlainObject
Returns Warehouse3D
Inherited from Core.fire$n
- Defined in src/model/basic/Emitter.ts:151

first

first<M>(type: string): M
Type Parameters
- M extends GraphicObject
Parameters
- type: string
Returns M
Implementation of IWarehouse.first
- Defined in src/3d/Warehouse.class.ts:642

getLayoutData

getLayoutData(): Promise<any>
retains the data for layouting ,which is the initial data. default is null, you can overrides it in subclass.

Returns Promise<any>
Implementation of IWarehouse.getLayoutData
- Defined in src/3d/Warehouse.class.ts:673

`Protected` iniCRS

iniCRS(): void
Returns void
- Defined in src/3d/Warehouse.class.ts:468

`Protected` iniGround

iniGround(): void
Returns void
- Defined in src/3d/Warehouse.class.ts:433

`Protected` iniLights

iniLights(): void
Returns void
- Defined in src/3d/Warehouse.class.ts:452

`Protected` iniModes

iniModes(): void
Returns void
- Defined in src/3d/Warehouse.class.ts:490

`Protected` iniSkybox

iniSkybox(): void
Returns void
- Defined in src/3d/Warehouse.class.ts:405

item

item(type: string, id: string): GraphicObject
Parameters
- type: string
- id: string
Returns GraphicObject
Implementation of IWarehouse.item
- Defined in src/3d/Warehouse.class.ts:646

`Abstract` layout

layout(data?: unknown): void | Promise<void>
Parameters
- Optional data: unknown
Returns void | Promise<void>
Implementation of IWarehouse.layout
- Defined in src/3d/Warehouse.class.ts:70

listen

listen<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): Warehouse3D
on
Type Parameters
- T extends string
Parameters
- event: T
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
- Optional context: any
Returns Warehouse3D
Inherited from Core.listen
- Defined in src/model/basic/Emitter.ts:155

listen$1

listen$1<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): Warehouse3D
once
Type Parameters
- T extends string
Parameters
- event: T
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
- Optional context: any
Returns Warehouse3D
Inherited from Core.listen$1
- Defined in src/model/basic/Emitter.ts:172

listen$n

listen$n(event: string, fn: ((event: WikEvent<any, any>) => void)): Warehouse3D
split on
Parameters
- event: string
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns Warehouse3D
Inherited from Core.listen$n
- Defined in src/model/basic/Emitter.ts:159

`Protected` loopRun

loopRun(): void
Returns void
- Defined in src/3d/Warehouse.class.ts:502

mount

mount(root: Scene, renderer: Renderer, camera: Camera): void
Parameters
- root: Scene
- renderer: Renderer
- camera: Camera
Returns void
Implementation of IWarehouse.mount
- Defined in src/3d/Warehouse.class.ts:561

onAdd

onAdd(item: GraphicObject): void
Parameters
- item: GraphicObject
Returns void
Inherited from IWarehouseOptional.onAdd
- Defined in src/model/IWarehouse.ts:47

onClick

onClick(item: GraphicObject, evt: unknown): void
Parameters
- item: GraphicObject
- evt: unknown
Returns void
Inherited from IWarehouseOptional.onClick
- Defined in src/model/IWarehouse.ts:38

onContextMenu

onContextMenu(item: GraphicObject, evt: unknown): void
Parameters
- item: GraphicObject
- evt: unknown
Returns void
Inherited from IWarehouseOptional.onContextMenu
- Defined in src/model/IWarehouse.ts:43

onDblClick

onDblClick(item: GraphicObject, evt: unknown): void
Parameters
- item: GraphicObject
- evt: unknown
Returns void
Inherited from IWarehouseOptional.onDblClick
- Defined in src/model/IWarehouse.ts:39

onEachFrame

onEachFrame(delta: number, elapse: number): void
Todo
rename perFrame
Parameters
- delta: number
- elapse: number
Returns void
Inherited from IWarehouse3DExtra.onEachFrame
- Defined in src/3d/Warehouse.class.ts:559

onHover

onHover(item: GraphicObject, evt: unknown): void
Parameters
- item: GraphicObject
- evt: unknown
Returns void
Inherited from IWarehouseOptional.onHover
- Defined in src/model/IWarehouse.ts:41

onLayouted

onLayouted(): void
Returns void
Inherited from IWarehouseOptional.onLayouted
- Defined in src/model/IWarehouse.ts:45

onMounted

onMounted(): void
Returns void
Inherited from IWarehouseOptional.onMounted
- Defined in src/model/IWarehouse.ts:44

onPress

onPress(item: GraphicObject, evt: unknown): void
Parameters
- item: GraphicObject
- evt: unknown
Returns void
Inherited from IWarehouseOptional.onPress
- Defined in src/model/IWarehouse.ts:40

onRemove

onRemove(item: GraphicObject): void
Parameters
- item: GraphicObject
Returns void
Inherited from IWarehouseOptional.onRemove
- Defined in src/model/IWarehouse.ts:48

onUnHover

onUnHover(item: GraphicObject, evt: unknown): void
Parameters
- item: GraphicObject
- evt: unknown
Returns void
Inherited from IWarehouseOptional.onUnHover
- Defined in src/model/IWarehouse.ts:42

onUpdate

onUpdate(item: GraphicObject, data: any): void
Parameters
- item: GraphicObject
- data: any
Returns void
Inherited from IWarehouseOptional.onUpdate
- Defined in src/model/IWarehouse.ts:49

onframe

onframe(frameCall: FrameCallFunc, options?: FrameCallFuncOptions): void
Parameters
- frameCall: FrameCallFunc
- options: FrameCallFuncOptions = null
Returns void
- Defined in src/3d/Warehouse.class.ts:90

perMs

perMs(ms: number, elapse: number): void
Todo
Parameters
- ms: number
- elapse: number
Returns void
- Defined in src/3d/Warehouse.class.ts:556

perSec

perSec(s: number, elapse: number): void
Todo
Parameters
- s: number
- elapse: number
Returns void
- Defined in src/3d/Warehouse.class.ts:554

query

query(type: string, predicate: ((item: unknown) => boolean)): unknown[]
Parameters
- type: string
- predicate: ((item: unknown) => boolean)
  - - (item: unknown): boolean
    - Parameters
      
      item: unknown
      
      Returns boolean
Returns unknown[]
Implementation of IWarehouse.query
- Defined in src/3d/Warehouse.class.ts:650

queryList

queryList(type: string): IList<GraphicObject>
Parameters
- type: string
Returns IList<GraphicObject>
Implementation of IWarehouse.queryList
- Defined in src/3d/Warehouse.class.ts:610

queryListAll

queryListAll(): {
type: string;
value: IList<GraphicObject>;
}[]
Returns {
type: string;
value: IList<GraphicObject>;
}[]
Implementation of IWarehouse.queryListAll
- Defined in src/3d/Warehouse.class.ts:606

readOnly

readOnly<V>(key: string, value: V): void
Type Parameters
- V = any
Parameters
- key: string
- value: V
Returns void
Inherited from Core.readOnly
- Defined in src/model/basic/Core.class.ts:22

remove

remove(type: string, item: string | Object3D<Event>): void
Parameters
- type: string
- item: string | Object3D<Event>
Returns void
Implementation of IWarehouse.remove
- Defined in src/3d/Warehouse.class.ts:662

resetCenter

resetCenter(): void
Returns void
- Defined in src/3d/Warehouse.class.ts:401

setCenter

setCenter(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
- Defined in src/3d/Warehouse.class.ts:383

setEventChild

setEventChild(child: WithEmitter<string>, off?: boolean): Warehouse3D
Create parent-child relationships of two evented objects manually. Because this method not mounted on evented object.
Parameters
- child: WithEmitter<string>
- Optional off: boolean
Returns Warehouse3D
Inherited from Core.setEventChild
- Defined in src/model/basic/Emitter.ts:178

setEventParent

setEventParent(parent: WithEmitter<string>): Warehouse3D
Parameters
- parent: WithEmitter<string>
Returns Warehouse3D
Inherited from Core.setEventParent
- Defined in src/model/basic/Emitter.ts:180

unframe

unframe(frameCall: FrameCallFunc): void
Parameters
- frameCall: FrameCallFunc
Returns void
- Defined in src/3d/Warehouse.class.ts:96

unlisten

unlisten<T>(event: T, fn?: ((event: WikEvent<any, any>) => void)): Warehouse3D
off
Type Parameters
- T extends string
Parameters
- event: T
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns Warehouse3D
Inherited from Core.unlisten
- Defined in src/model/basic/Emitter.ts:163

unlisten$n

unlisten$n(event: string, fn?: ((event: WikEvent<any, any>) => void)): Warehouse3D
split off
Parameters
- event: string
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns Warehouse3D
Inherited from Core.unlisten$n
- Defined in src/model/basic/Emitter.ts:167

unmount

unmount(): void
Returns void
Implementation of IWarehouse.unmount
- Defined in src/3d/Warehouse.class.ts:603

update

update(type: string, item: Object3D<Event>, data: any): void
Parameters
- type: string
- item: Object3D<Event>
- data: any
Returns void
Implementation of IWarehouse.update
- Defined in src/3d/Warehouse.class.ts:658

Class Warehouse3DAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Warehouse3D

Properties

Readonly $$isEmitter

Private _lastHighlight

Readonly camera

Readonly center

Readonly controls

Readonly event

Readonly frameOptions

Readonly frames

Readonly globalConst

Readonly ground

Readonly injector

isClickEventFireCancelled

Readonly layouted

Readonly modeManager

Readonly mounted

noEmit

Readonly options

Readonly renderer

Readonly root

Readonly selectionManager

Abstract size

Readonly types

Readonly updateDeps

Methods

$set

Parameters

pairs: string | Record<string, any>

Optional value: any

Optional context: object

Returns void

$type

Type Parameters

O extends Object3D<Event, O>

Parameters

type: string

Returns Object3DList<O>

$untype

Parameters

type: string

Returns void

[iterator]

Returns Iterator<Object3D<Event>, any, undefined>

add

Type Parameters

M extends Object3D<Event, M> = Object3D<Event>

Parameters

type: string

item: M

Returns void

applyBehavior

Parameters

type: string

target: Object3D<Event>

Optional event: any

Returns void

cancelClickEventFire

Returns void

clear

Parameters

type: string

Returns void

configModes

Returns Record<string, IBehavior[]>

create

Type Parameters

C extends Constructor<object, C>

Parameters

ctor: C

Rest ...args: ConstructorParameters<C>

Class Warehouse3D`Abstract`

`Readonly` $$isEmitter

`Private` _lastHighlight

`Readonly` camera

`Readonly` center

`Readonly` controls

`Readonly` event

`Readonly` frameOptions

`Readonly` frames

`Readonly` globalConst

`Readonly` ground

`Readonly` injector

`Readonly` layouted

`Readonly` modeManager

`Readonly` mounted

`Readonly` options

`Readonly` renderer

`Readonly` root

`Readonly` selectionManager

`Abstract` size

`Readonly` types

`Readonly` updateDeps

`Optional` value: any

`Optional` context: object

`Optional` event: any

`Rest` ...args: ConstructorParameters<C>

`Optional` pos: Vector3

`Optional` type: string

`Optional` payload: PlainObject

`Optional` payload: PlainObject

`Protected` iniCRS

`Protected` iniGround

`Protected` iniLights

`Protected` iniModes

`Protected` iniSkybox