Interface IObject3D<E, ET>

Type Parameters

E extends Event = IObject3DEvent
ET = IObject3DEventTypes

Hierarchy

Object3D<E, ET>
IUiConfigContainer
IDisposable
- IObject3D
  - ICamera
  - IScene

Properties

`Optional` _currentGeometry

_currentGeometry?: null | IGeometry<NormalBufferAttributes>

`Optional` _currentMaterial

_currentMaterial?: null | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

`Optional` _onGeometryUpdate

_onGeometryUpdate?: ((e) => void)

Type declaration

- (e): void
- Parameters
  - e: IGeometryEvent<"geometryUpdate">
  Returns void

assetType

assetType: "model" | "light" | "camera" | "widget"

children

children: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

`Optional` geometry

geometry?: IGeometry<NormalBufferAttributes>

`Optional` isCamera

isCamera?: boolean

`Optional` isLight

isLight?: boolean

`Optional` isLine

isLine?: boolean

`Optional` isMesh

isMesh?: boolean

`Readonly` isObject3D

isObject3D: true

`Optional` isScene

isScene?: boolean

`Optional` isWidget

isWidget?: boolean

`Optional` material

material?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

`Optional` `Readonly` materials

materials?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

Same as material but always returns an array.

modelObject

modelObject: IObject3D<E, ET>

Deprecated

use object directly

`Optional` morphTargetDictionary

morphTargetDictionary?: Record<string, number>

`Optional` morphTargetInfluences

morphTargetInfluences?: number[]

`Optional` objectProcessor

objectProcessor?: IObjectProcessor

parent

parent: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

`Optional` parentRoot

parentRoot?: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parent/Ancestor of this object to bubble events to. This is set internally by setupObject3D.

`Optional` uiConfig

uiConfig?: UiObjectConfig<any, string, any>

userData

userData: IObject3DUserData

Methods

add

add(...object): IObject3D<E, ET>
Parameters
- Rest ...object: Object3D<Event, string>[]
Returns IObject3D<E, ET>
Overrides Object3D.add
- Defined in src/core/IObject.ts:230

`Optional` autoCenter

autoCenter<T>(setDirty?): T
Default
```
true
```
Type Parameters
- T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T>
Parameters
- Optional setDirty: boolean
  
  calls setDirty
Returns T
- Defined in src/core/IObject.ts:200

`Optional` autoScale

autoScale<T>(autoScaleRadius?, isCentered?, setDirty?): T
Type Parameters
- T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T>
Parameters
- Optional autoScaleRadius: number
  
  optional (taken from userData.autoScaleRadius by default)
- Optional isCentered: boolean
  
  optional (taken from userData.isCentered by default)
- Optional setDirty: boolean
  
  true by default
Returns T
- Defined in src/core/IObject.ts:194

clone

clone(recursive?): IObject3D<E, ET>
Parameters
- Optional recursive: boolean
Returns IObject3D<E, ET>
Overrides Object3D.clone
- Defined in src/core/IObject.ts:229

copy

copy(source, recursive?, ...args): IObject3D<E, ET>
Parameters
- source: IObject3D<E, ET>
- Optional recursive: boolean
- Rest ...args: any[]
Returns IObject3D<E, ET>
Overrides Object3D.copy
- Defined in src/core/IObject.ts:228

dispose

dispose(removeFromParent?): void
Parameters
- Optional removeFromParent: boolean
  
  remove from parent. Default true
Returns void
Overrides IDisposable.dispose
- Defined in src/core/IObject.ts:218

getObjectById

getObjectById<T>(id): undefined | T
Type Parameters
- T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Parameters
- id: number
Returns undefined | T
Overrides Object3D.getObjectById
- Defined in src/core/IObject.ts:225

getObjectByName

getObjectByName<T>(name): undefined | T
Type Parameters
- T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Parameters
- name: string
Returns undefined | T
Overrides Object3D.getObjectByName
- Defined in src/core/IObject.ts:226

getObjectByProperty

getObjectByProperty<T>(name, value): undefined | T
Type Parameters
- T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Parameters
- name: string
- value: string
Returns undefined | T
Overrides Object3D.getObjectByProperty
- Defined in src/core/IObject.ts:227

refreshUi

refreshUi(): void
Returns void
- Defined in src/core/IObject.ts:183

remove

remove(...object): IObject3D<E, ET>
Parameters
- Rest ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]
Returns IObject3D<E, ET>
Overrides Object3D.remove
- Defined in src/core/IObject.ts:231

setDirty

setDirty(e?): void
Dispatches 'objectUpdate' event on object.
Parameters
- Optional e: IObjectSetDirtyOptions
Returns void
- Defined in src/core/IObject.ts:175

traverse

traverse(callback): void
Parameters
- callback: ((object) => void)
  - - (object): void
    - Parameters
      
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      
      Returns void
Returns void
Overrides Object3D.traverse
- Defined in src/core/IObject.ts:222

traverseAncestors

traverseAncestors(callback): void
Parameters
- callback: ((object) => void)
  - - (object): void
    - Parameters
      
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      
      Returns void
Returns void
Overrides Object3D.traverseAncestors
- Defined in src/core/IObject.ts:224

traverseVisible

traverseVisible(callback): void
Parameters
- callback: ((object) => void)
  - - (object): void
    - Parameters
      
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      
      Returns void
Returns void
Overrides Object3D.traverseVisible
- Defined in src/core/IObject.ts:223

`Optional` updateMorphTargets

updateMorphTargets(): void
Returns void
- Defined in src/core/IObject.ts:166

Interface IObject3D<E, ET>

Type Parameters

E extends Event = IObject3DEvent

ET = IObject3DEventTypes

Hierarchy

Index

Properties

Methods

Properties

Optional _currentGeometry

Optional _currentMaterial

Optional _onGeometryUpdate

Type declaration

Parameters

e: IGeometryEvent<"geometryUpdate">

Returns void

assetType

children

Optional geometry

Optional isCamera

Optional isLight

Optional isLine

Optional isMesh

Readonly isObject3D

Optional isScene

Optional isWidget

Optional material

Optional Readonly materials

modelObject

Deprecated

Optional morphTargetDictionary

Optional morphTargetInfluences

Optional objectProcessor

parent

Optional parentRoot

Optional uiConfig

userData

Methods

add

Parameters

Rest ...object: Object3D<Event, string>[]

Returns IObject3D<E, ET>

Optional autoCenter

Default

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T>

Parameters

Optional setDirty: boolean

Returns T

Optional autoScale

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T>

Parameters

Optional autoScaleRadius: number

Optional isCentered: boolean

Optional setDirty: boolean

Returns T

clone

Parameters

Optional recursive: boolean

Returns IObject3D<E, ET>

copy

Parameters

source: IObject3D<E, ET>

Optional recursive: boolean

Rest ...args: any[]

Returns IObject3D<E, ET>

dispose

Parameters

Optional removeFromParent: boolean

Returns void

getObjectById

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

id: number

Returns undefined | T

getObjectByName

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

`Optional` _currentGeometry

`Optional` _currentMaterial

`Optional` _onGeometryUpdate

`Optional` geometry

`Optional` isCamera

`Optional` isLight

`Optional` isLine

`Optional` isMesh

`Readonly` isObject3D

`Optional` isScene

`Optional` isWidget

`Optional` material

`Optional` `Readonly` materials

`Optional` morphTargetDictionary

`Optional` morphTargetInfluences

`Optional` objectProcessor

`Optional` parentRoot

`Optional` uiConfig

`Rest` ...object: Object3D<Event, string>[]

`Optional` autoCenter

`Optional` setDirty: boolean

`Optional` autoScale

`Optional` autoScaleRadius: number

`Optional` isCentered: boolean

`Optional` setDirty: boolean

`Optional` recursive: boolean

`Optional` recursive: boolean

`Rest` ...args: any[]

`Optional` removeFromParent: boolean

`Rest` ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

`Optional` e: IObjectSetDirtyOptions

`Optional` updateMorphTargets