Interface: ICamera<TOptions, TCamera, TControls>

Core-API.ICamera

Type parameters

Name	Type
TOptions	extends ICameraOptions = ICameraOptions
TCamera	any
TControls	any

Hierarchy

• IModel<TCamera>

• IShaderPropertiesUpdater

  ↳ ICamera

Implemented by

• CameraController

Methods

updateShaderProperties

▸ updateShaderProperties(material): ICamera<TOptions, TCamera, TControls>

Parameters

Name	Type
material	Object
material.defines	Record<string, undefined | string | number>
material.uniforms	Object

Returns

ICamera<TOptions, TCamera, TControls>

Inherited from

IShaderPropertiesUpdater.updateShaderProperties

---

setDirty

▸ setDirty(options?): void

Parameters

Name	Type
options?	AnyOptions

Returns

void

Overrides

IModel.setDirty

---

activateMain

▸ activateMain(): void

Returns

void

---

deactivateMain

▸ deactivateMain(): void

Returns

void

---

positionUpdated

▸ positionUpdated(): void

Returns

void

---

targetUpdated

▸ targetUpdated(): void

Returns

void

---

refreshTarget

▸ refreshTarget(): void

Returns

void

---

setInteractions

▸ setInteractions(enabled, by): void

Parameters

Name	Type
enabled	boolean
by	string

Returns

void

---

getCameraOptions

▸ getCameraOptions(): TOptions

Returns

TOptions

---

setCameraOptions

▸ setCameraOptions(value, setDirty?): void

Parameters

Name	Type
value	Partial<TOptions>
setDirty?	boolean

Returns

void

---

setMaterial

▸ Optional setMaterial(material): IMaterial<any, IMaterialEventMap>[]

Parameters

Name	Type
material	undefined | IMaterial<any, IMaterialEventMap> | IMaterial<any, IMaterialEventMap>[]

Returns

IMaterial<any, IMaterialEventMap>[]

Inherited from

IModel.setMaterial

---

setGeometry

▸ Optional setGeometry(geometry, force?): any

returns the old geometry.

Parameters

Name	Type
geometry	any
force?	boolean

Returns

any

Inherited from

IModel.setGeometry

Properties

near

• near: number

---

far

• far: number

---

isActiveCamera

• isActiveCamera: boolean

---

cameraObject

• cameraObject: TCamera

---

controls

• controls: undefined | TControls

---

target

• target: any

---

position

• position: any

---

interactionsEnabled

• interactionsEnabled: boolean

deprecated

---

name

• name: string

Inherited from

IModel.name

---

uuid

• Readonly uuid: string

Inherited from

IModel.uuid

---

visible

• visible: boolean

Inherited from

IModel.visible

---

assetType

• assetType: "model" | "widget" | "light"

Inherited from

IModel.assetType

---

modelObject

• modelObject: TCamera

Internal three.js Object3D instance (like Mesh, Group, etc)

Inherited from

IModel.modelObject

---

material

• Optional Readonly material: IMaterial<any, IMaterialEventMap> | IMaterial<any, IMaterialEventMap>[]

Use setMaterial to change the material Get one or more materials applied to an object

Inherited from

IModel.material

---

geometry

• Optional Readonly geometry: any

Inherited from

IModel.geometry

---

userData

• userData: any

Inherited from

IModel.userData

---

uiConfig

• Optional uiConfig: UiObjectConfig<any, string>

Inherited from

IModel.uiConfig