Interface: ICamera<TOptions, TCamera, TControls>
Core-API.ICamera
Type parameters
Name | Type |
---|---|
TOptions | extends ICameraOptions = ICameraOptions |
TCamera | any |
TControls | any |
Hierarchy
Implemented by
Methods
addEventListener
▸ addEventListener(type
, listener
): void
Adds a listener to an event type.
Parameters
Name | Type | Description |
---|---|---|
type | string | The type of event to listen to. |
listener | (event : IEvent <string >) => void | The function that gets called when the event is fired. |
Returns
void
Inherited from
Defined in
webgi/src/helpers/EventDispatcher.ts:14
hasEventListener
▸ hasEventListener(type
, listener
): boolean
Checks if listener is added to an event type.
Parameters
Name | Type | Description |
---|---|---|
type | string | The type of event to listen to. |
listener | (event : IEvent <string >) => void | The function that gets called when the event is fired. |
Returns
boolean
Inherited from
Defined in
webgi/src/helpers/EventDispatcher.ts:21
removeEventListener
▸ removeEventListener(type
, listener
): void
Removes a listener from an event type.
Parameters
Name | Type | Description |
---|---|---|
type | string | The type of the listener that gets removed. |
listener | (event : IEvent <string >) => void | The listener function that gets removed. |
Returns
void
Inherited from
Defined in
webgi/src/helpers/EventDispatcher.ts:28
dispatchEvent
▸ dispatchEvent(event
): void
Fire an event type.
Parameters
Name | Type |
---|---|
event | IEvent <string > |
Returns
void
Inherited from
Defined in
webgi/src/helpers/EventDispatcher.ts:34
dispose
▸ Optional
dispose(): void
Returns
void
Inherited from
Defined in
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
Defined in
setDirty
▸ setDirty(options?
): void
Parameters
Name | Type |
---|---|
options? | AnyOptions |
Returns
void
Overrides
Defined in
activateMain
▸ activateMain(): void
Returns
void
Defined in
deactivateMain
▸ deactivateMain(): void
Returns
void
Defined in
positionUpdated
▸ positionUpdated(): void
Returns
void
Defined in
targetUpdated
▸ targetUpdated(): void
Returns
void
Defined in
refreshTarget
▸ refreshTarget(): void
Returns
void
Defined in
getCameraOptions
▸ getCameraOptions(): TOptions
Returns
TOptions
Defined in
setCameraOptions
▸ setCameraOptions(value
, setDirty?
): void
Parameters
Name | Type |
---|---|
value | Partial <TOptions > |
setDirty? | boolean |
Returns
void
Defined in
setMaterial
▸ Optional
setMaterial(material
): IMaterial
<any
>[]
Parameters
Name | Type |
---|---|
material | undefined | IMaterial <any > | IMaterial <any >[] |
Returns
IMaterial
<any
>[]
Inherited from
Defined in
setGeometry
▸ Optional
setGeometry(geometry
, force?
): any
returns the old geometry.
Parameters
Name | Type |
---|---|
geometry | any |
force? | boolean |
Returns
any
Inherited from
Defined in
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Inherited from
Defined in
fromJSON
▸ fromJSON(data
, meta?
): null
| ICamera
<TOptions
, TCamera
, TControls
> | Promise
<null
| ICamera
<TOptions
, TCamera
, TControls
>>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| ICamera
<TOptions
, TCamera
, TControls
> | Promise
<null
| ICamera
<TOptions
, TCamera
, TControls
>>
Inherited from
Defined in
Properties
near
• near: number
Defined in
far
• far: number
Defined in
isActiveCamera
• isActiveCamera: boolean
Defined in
cameraObject
• cameraObject: TCamera
Defined in
controls
• controls: undefined
| TControls
Defined in
target
• target: any
Defined in
position
• position: any
Defined in
interactionsEnabled
• interactionsEnabled: boolean
Defined in
name
• name: string
Inherited from
Defined in
uuid
• Readonly
uuid: string
Inherited from
Defined in
visible
• visible: boolean
Inherited from
Defined in
assetType
• assetType: "model"
Inherited from
Defined in
modelObject
• modelObject: any
Internal three.js Object3D instance (like Mesh, Group, etc)
Inherited from
Defined in
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
Defined in
geometry
• Optional
Readonly
geometry: any
Inherited from
Defined in
userData
• userData: any
Inherited from
Defined in
uiConfig
• Optional
uiConfig: UiObjectConfig
<any
, string
>