Skip to main content

Interface: ICamera<TOptions, TCamera, TControls>

Core-API.ICamera

Type parameters

NameType
TOptionsextends ICameraOptions = ICameraOptions
TCameraany
TControlsany

Hierarchy

Implemented by

Methods

addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameTypeDescription
typestringThe type of event to listen to.
listener(event: IEvent<string>) => voidThe function that gets called when the event is fired.

Returns

void

Inherited from

IModel.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:14


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameTypeDescription
typestringThe type of event to listen to.
listener(event: IEvent<string>) => voidThe function that gets called when the event is fired.

Returns

boolean

Inherited from

IModel.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:21


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameTypeDescription
typestringThe type of the listener that gets removed.
listener(event: IEvent<string>) => voidThe listener function that gets removed.

Returns

void

Inherited from

IModel.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:28


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<string>

Returns

void

Inherited from

IModel.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:34


dispose

Optional dispose(): void

Returns

void

Inherited from

IModel.dispose

Defined in

webgi/src/interfaces.ts:40


updateShaderProperties

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

Parameters

NameType
materialObject
material.definesRecord<string, undefined | string | number>
material.uniformsObject

Returns

ICamera<TOptions, TCamera, TControls>

Inherited from

IShaderPropertiesUpdater.updateShaderProperties

Defined in

webgi/src/interfaces.ts:117


setDirty

setDirty(options?): void

Parameters

NameType
options?AnyOptions

Returns

void

Overrides

IModel.setDirty

Defined in

webgi/src/interfaces.ts:256


activateMain

activateMain(): void

Returns

void

Defined in

webgi/src/interfaces.ts:260


deactivateMain

deactivateMain(): void

Returns

void

Defined in

webgi/src/interfaces.ts:262


positionUpdated

positionUpdated(): void

Returns

void

Defined in

webgi/src/interfaces.ts:268


targetUpdated

targetUpdated(): void

Returns

void

Defined in

webgi/src/interfaces.ts:269


refreshTarget

refreshTarget(): void

Returns

void

Defined in

webgi/src/interfaces.ts:271


getCameraOptions

getCameraOptions(): TOptions

Returns

TOptions

Defined in

webgi/src/interfaces.ts:278


setCameraOptions

setCameraOptions(value, setDirty?): void

Parameters

NameType
valuePartial<TOptions>
setDirty?boolean

Returns

void

Defined in

webgi/src/interfaces.ts:280


setMaterial

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

Parameters

NameType
materialundefined | IMaterial<any> | IMaterial<any>[]

Returns

IMaterial<any>[]

Inherited from

IModel.setMaterial

Defined in

webgi/src/interfaces.ts:309


setGeometry

Optional setGeometry(geometry, force?): any

returns the old geometry.

Parameters

NameType
geometryany
force?boolean

Returns

any

Inherited from

IModel.setGeometry

Defined in

webgi/src/interfaces.ts:315


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

IJSONSerializable.toJSON

Defined in

webgi/src/interfaces.ts:443


fromJSON

fromJSON(data, meta?): null | ICamera<TOptions, TCamera, TControls> | Promise<null | ICamera<TOptions, TCamera, TControls>>

Parameters

NameType
dataany
meta?any

Returns

null | ICamera<TOptions, TCamera, TControls> | Promise<null | ICamera<TOptions, TCamera, TControls>>

Inherited from

IJSONSerializable.fromJSON

Defined in

webgi/src/interfaces.ts:444

Properties

near

near: number

Defined in

webgi/src/interfaces.ts:253


far

far: number

Defined in

webgi/src/interfaces.ts:254


isActiveCamera

isActiveCamera: boolean

Defined in

webgi/src/interfaces.ts:258


cameraObject

cameraObject: TCamera

Defined in

webgi/src/interfaces.ts:264


controls

controls: undefined | TControls

Defined in

webgi/src/interfaces.ts:265


target

target: any

Defined in

webgi/src/interfaces.ts:273


position

position: any

Defined in

webgi/src/interfaces.ts:274


interactionsEnabled

interactionsEnabled: boolean

Defined in

webgi/src/interfaces.ts:276


name

name: string

Inherited from

IModel.name

Defined in

webgi/src/interfaces.ts:294


uuid

Readonly uuid: string

Inherited from

IModel.uuid

Defined in

webgi/src/interfaces.ts:295


visible

visible: boolean

Inherited from

IModel.visible

Defined in

webgi/src/interfaces.ts:296


assetType

assetType: "model"

Inherited from

IModel.assetType

Defined in

webgi/src/interfaces.ts:298


modelObject

modelObject: any

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

Inherited from

IModel.modelObject

Defined in

webgi/src/interfaces.ts:302


material

Optional Readonly material: IMaterial<any> | IMaterial<any>[]

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

Inherited from

IModel.material

Defined in

webgi/src/interfaces.ts:307


geometry

Optional Readonly geometry: any

Inherited from

IModel.geometry

Defined in

webgi/src/interfaces.ts:308


userData

userData: any

Inherited from

IModel.userData

Defined in

webgi/src/interfaces.ts:317


uiConfig

Optional uiConfig: UiObjectConfig<any, string>

Inherited from

IModel.uiConfig

Defined in

webgi/src/interfaces.ts:557