Class Audio<NodeType>

Base class for scene graph objects

Type Parameters

NodeType extends AudioNode = GainNode

Hierarchy

Object3D
- Audio
  - PositionalAudio

Index

Constructors

constructor

Methods

add addEventListener applyMatrix4 applyQuaternion attach clear clone connect copy disconnect dispatchEvent getDetune getFilter getFilters getLoop getObjectById getObjectByName getObjectByProperty getOutput getPlaybackRate getVolume getWorldDirection getWorldPosition getWorldQuaternion getWorldScale hasEventListener load localToWorld lookAt onEnded pause play raycast remove removeEventListener removeFromParent rotateOnAxis rotateOnWorldAxis rotateX rotateY rotateZ setBuffer setDetune setFilter setFilters setLoop setLoopEnd setLoopStart setMediaElementSource setMediaStreamSource setNodeSource setPlaybackRate setRotationFromAxisAngle setRotationFromEuler setRotationFromMatrix setRotationFromQuaternion setVolume stop toJSON translateOnAxis translateX translateY translateZ traverse traverseAncestors traverseVisible updateMatrix updateMatrixWorld updateWorldMatrix worldToLocal

Constructors

constructor

new Audio<NodeType>(listener: AudioListener): Audio<NodeType>
Type Parameters
- NodeType extends AudioNode<NodeType> = GainNode
Parameters
- listener: AudioListener
Returns Audio<NodeType>
Overrides Object3D.constructor
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:8

Properties

animations

animations: AnimationClip[]

Array with animation clips.

Default

[]

autoplay

autoplay: boolean

Default

false

buffer

buffer: AudioBuffer

castShadow

castShadow: boolean

Gets rendered into shadow map.

Default

false

children

children: Object3D<Event>[]

Array with object's children.

Default

[]

context

context: AudioContext

customDepthMaterial

customDepthMaterial: THREE.Material

Custom depth material to be used when rendering to the depth map. Can only be used in context of meshes. When shadow-casting with a DirectionalLight or SpotLight, if you are (a) modifying vertex positions in the vertex shader, (b) using a displacement map, (c) using an alpha map with alphaTest, or (d) using a transparent texture with alphaTest, you must specify a customDepthMaterial for proper shadows.

customDistanceMaterial

customDistanceMaterial: THREE.Material

Same as customDepthMaterial, but used with PointLight.

detune

detune: number

Default

duration

duration: number

Default

undefined

filters

filters: AudioNode[]

Default

[]

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera before rendering the object. If set to false the object gets rendered every frame even if it is not in the frustum of the camera.

Default

true

gain

gain: GainNode

hasPlaybackControl

hasPlaybackControl: boolean

Default

true

id

id: number

Unique number of this object instance.

`Readonly` isObject3D

isObject3D: true

Used to check whether this or derived classes are Object3Ds. Default is true. You should not change this, as it is used internally for optimisation.

isPlaying

isPlaying: boolean

Default

false

layers

layers: Layers

Default

new THREE.Layers()

listener

listener: AudioListener

loop

loop: boolean

Default

false

loopEnd

loopEnd: number

Default

loopStart

loopStart: number

Default

matrix

matrix: Matrix4

Local transform.

Default

new THREE.Matrix4()

matrixAutoUpdate

matrixAutoUpdate: boolean

When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the matrixWorld property.

Default

THREE.Object3D.DefaultMatrixAutoUpdate

matrixWorld

matrixWorld: Matrix4

The global transform of the object. If the Object3d has no parent, then it's identical to the local transform.

Default

new THREE.Matrix4()

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

When this is set, it calculates the matrixWorld in that frame and resets this property to false.

Default

false

`Readonly` modelViewMatrix

modelViewMatrix: Matrix4

Default

new THREE.Matrix4()

name

name: string

Optional name of the object (doesn't need to be unique).

Default

`Readonly` normalMatrix

normalMatrix: Matrix3

Default

new THREE.Matrix3()

offset

offset: number

Default

onAfterRender

onAfterRender: ((renderer: WebGLRenderer, scene: THREE.Scene, camera: THREE.Camera, geometry: BufferGeometry, material: THREE.Material, group: THREE.Group) => void)

Type declaration

- (renderer: WebGLRenderer, scene: THREE.Scene, camera: THREE.Camera, geometry: BufferGeometry, material: THREE.Material, group: THREE.Group): void
- Calls after rendering object
  Parameters
  - renderer: WebGLRenderer
  - scene: THREE.Scene
  - camera: THREE.Camera
  - geometry: BufferGeometry
  - material: THREE.Material
  - group: THREE.Group
  Returns void

onBeforeRender

onBeforeRender: ((renderer: WebGLRenderer, scene: THREE.Scene, camera: THREE.Camera, geometry: BufferGeometry, material: THREE.Material, group: THREE.Group) => void)

Type declaration

- (renderer: WebGLRenderer, scene: THREE.Scene, camera: THREE.Camera, geometry: BufferGeometry, material: THREE.Material, group: THREE.Group): void
- Calls before rendering object
  Parameters
  - renderer: WebGLRenderer
  - scene: THREE.Scene
  - camera: THREE.Camera
  - geometry: BufferGeometry
  - material: THREE.Material
  - group: THREE.Group
  Returns void

parent

parent: Object3D<Event>

Object's parent in the scene graph.

Default

null

playbackRate

playbackRate: number

Default

`Readonly` position

position: THREE.Vector3

Object's local position.

Default

new THREE.Vector3()

`Readonly` quaternion

quaternion: Quaternion

Object's local rotation as a Quaternion.

Default

new THREE.Quaternion()

receiveShadow

receiveShadow: boolean

Material gets baked in shadow receiving.

Default

false

renderOrder

renderOrder: number

Overrides the default rendering order of scene graph objects, from lowest to highest renderOrder. Opaque and transparent objects remain sorted independently though. When this property is set for an instance of Group, all descendants objects will be sorted and rendered together.

Default

`Readonly` rotation

rotation: Euler

Object's local rotation (Euler angles), in radians.

Default

new THREE.Euler()

`Readonly` scale

scale: THREE.Vector3

Object's local scale.

Default

new THREE.Vector3()

source

source: AudioBufferSourceNode

sourceType

sourceType: string

Default

'empty'

type

type: "Audio"

Default

'Object3D'

up

up: THREE.Vector3

Up direction.

Default

THREE.Object3D.DefaultUp.clone()

userData

userData: {
[key: string]: any;
}

An object that can be used to store custom data about the Object3d. It should not hold references to functions as these will not be cloned.

Default

Type declaration

[key: string]: any

uuid

uuid: string

visible

visible: boolean

Object gets rendered if true.

Default

true

`Static` DefaultMatrixAutoUpdate

DefaultMatrixAutoUpdate: boolean

`Static` DefaultUp

DefaultUp: THREE.Vector3

Methods

add

add(...object: Object3D<Event>[]): Audio<NodeType>
Adds object as child of this object.
Parameters
- Rest ...object: Object3D<Event>[]
Returns Audio<NodeType>
Inherited from Object3D.add
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:332

addEventListener

addEventListener<T>(type: T, listener: EventListener<Event, T, Audio<NodeType>>): void
Adds a listener to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, Audio<NodeType>>
  
  The function that gets called when the event is fired.
Returns void
Inherited from Object3D.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:30

applyMatrix4

applyMatrix4(matrix: Matrix4): void
Applies the matrix transform to the object and updates the object's position, rotation and scale.
Parameters
- matrix: Matrix4
Returns void
Inherited from Object3D.applyMatrix4
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:217

applyQuaternion

applyQuaternion(quaternion: Quaternion): Audio<NodeType>
Applies the rotation represented by the quaternion to the object.
Parameters
- quaternion: Quaternion
Returns Audio<NodeType>
Inherited from Object3D.applyQuaternion
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:222

attach

attach(object: Object3D<Event>): Audio<NodeType>
Adds object as a child of this, while maintaining the object's world transform.
Parameters
- object: Object3D<Event>
Returns Audio<NodeType>
Inherited from Object3D.attach
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:352

clear

clear(): Audio<NodeType>
Removes all child objects.

Returns Audio<NodeType>
Inherited from Object3D.clear
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:347

clone

clone(recursive?: boolean): Audio<NodeType>
Parameters
- Optional recursive: boolean
Returns Audio<NodeType>
Inherited from Object3D.clone
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:400

connect

connect(): Audio<NodeType>
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:86

copy

copy(source: Audio<NodeType>, recursive?: boolean): Audio<NodeType>
Parameters
- source: Audio<NodeType>
- Optional recursive: boolean
Returns Audio<NodeType>
Inherited from Object3D.copy
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:407

disconnect

disconnect(): Audio<NodeType>
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:87

dispatchEvent

dispatchEvent(event: Event): void
Fire an event type.
Parameters
- event: Event
Returns void
Inherited from Object3D.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:50

getDetune

getDetune(): number
Returns number
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:89

getFilter

getFilter(): AudioNode
Returns AudioNode
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:92

getFilters

getFilters(): AudioNode[]
Returns AudioNode[]
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:90

getLoop

getLoop(): boolean
Returns boolean
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:96

getObjectById

getObjectById(id: number): Object3D<Event>
Searches through the object's children and returns the first with a matching id.
Parameters
- id: number
  
  Unique number of the object instance
Returns Object3D<Event>
Inherited from Object3D.getObjectById
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:358

getObjectByName

getObjectByName(name: string): Object3D<Event>
Searches through the object's children and returns the first with a matching name.
Parameters
- name: string
  
  String to match to the children's Object3d.name property.
Returns Object3D<Event>
Inherited from Object3D.getObjectByName
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:364

getObjectByProperty

getObjectByProperty(name: string, value: string): Object3D<Event>
Parameters
- name: string
- value: string
Returns Object3D<Event>
Inherited from Object3D.getObjectByProperty
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:366

getOutput

getOutput(): NodeType
Returns NodeType
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:77

getPlaybackRate

getPlaybackRate(): number
Returns number
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:95

getVolume

getVolume(): number
Returns number
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:100

getWorldDirection

getWorldDirection(target: THREE.Vector3): THREE.Vector3
Parameters
- target: THREE.Vector3
Returns THREE.Vector3
Inherited from Object3D.getWorldDirection
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:371

getWorldPosition

getWorldPosition(target: THREE.Vector3): THREE.Vector3
Parameters
- target: THREE.Vector3
Returns THREE.Vector3
Inherited from Object3D.getWorldPosition
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:368

getWorldQuaternion

getWorldQuaternion(target: Quaternion): Quaternion
Parameters
- target: Quaternion
Returns Quaternion
Inherited from Object3D.getWorldQuaternion
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:369

getWorldScale

getWorldScale(target: THREE.Vector3): THREE.Vector3
Parameters
- target: THREE.Vector3
Returns THREE.Vector3
Inherited from Object3D.getWorldScale
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:370

hasEventListener

hasEventListener<T>(type: T, listener: EventListener<Event, T, Audio<NodeType>>): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Event, T, Audio<NodeType>>
  
  The function that gets called when the event is fired.
Returns boolean
Inherited from Object3D.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:37

load

load(file: string): Audio<GainNode>
Deprecated
Use AudioLoader instead.
Parameters
- file: string
Returns Audio<GainNode>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:105

localToWorld

localToWorld(vector: THREE.Vector3): THREE.Vector3
Updates the vector from local space to world space.
Parameters
- vector: THREE.Vector3
  
  A local vector.
Returns THREE.Vector3
Inherited from Object3D.localToWorld
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:313

lookAt

lookAt(vector: number | THREE.Vector3, y?: number, z?: number): void
Optionally, the x, y and z components of the world space position. Rotates the object to face a point in world space. This method does not support objects having non-uniformly-scaled parent(s).
Parameters
- vector: number | THREE.Vector3
  
  A world vector to look at.
- Optional y: number
- Optional z: number
Returns void
Inherited from Object3D.lookAt
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:327

onEnded

onEnded(): void
Returns void
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:83

pause

pause(): Audio<NodeType>
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:84

play

play(delay?: number): Audio<NodeType>
Parameters
- Optional delay: number
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:82

raycast

raycast(raycaster: THREE.Raycaster, intersects: Intersection<Object3D<Event>>[]): void
Parameters
- raycaster: THREE.Raycaster
- intersects: Intersection<Object3D<Event>>[]
Returns void
Inherited from Object3D.raycast
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:373

remove

remove(...object: Object3D<Event>[]): Audio<NodeType>
Removes object as child of this object.
Parameters
- Rest ...object: Object3D<Event>[]
Returns Audio<NodeType>
Inherited from Object3D.remove
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:337

removeEventListener

removeEventListener<T>(type: T, listener: EventListener<Event, T, Audio<NodeType>>): void
Removes a listener from an event type.
Type Parameters
- T extends string
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<Event, T, Audio<NodeType>>
  
  The listener function that gets removed.
Returns void
Inherited from Object3D.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:44

removeFromParent

removeFromParent(): Audio<NodeType>
Removes this object from its current parent.

Returns Audio<NodeType>
Inherited from Object3D.removeFromParent
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:342

rotateOnAxis

rotateOnAxis(axis: THREE.Vector3, angle: number): Audio<NodeType>
Rotate an object along an axis in object space. The axis is assumed to be normalized.
Parameters
- axis: THREE.Vector3
  
  A normalized vector in object space.
- angle: number
  
  The angle in radians.
Returns Audio<NodeType>
Inherited from Object3D.rotateOnAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:257

rotateOnWorldAxis

rotateOnWorldAxis(axis: THREE.Vector3, angle: number): Audio<NodeType>
Rotate an object along an axis in world space. The axis is assumed to be normalized. Method Assumes no rotated parent.
Parameters
- axis: THREE.Vector3
  
  A normalized vector in object space.
- angle: number
  
  The angle in radians.
Returns Audio<NodeType>
Inherited from Object3D.rotateOnWorldAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:264

rotateX

rotateX(angle: number): Audio<NodeType>
Rotates the object around x axis in local space.
Parameters
- angle: number
  
  the angle to rotate in radians.
Returns Audio<NodeType>
Inherited from Object3D.rotateX
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:270

rotateY

rotateY(angle: number): Audio<NodeType>
Rotates the object around y axis in local space.
Parameters
- angle: number
  
  the angle to rotate in radians.
Returns Audio<NodeType>
Inherited from Object3D.rotateY
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:276

rotateZ

rotateZ(angle: number): Audio<NodeType>
Rotates the object around z axis in local space.
Parameters
- angle: number
  
  the angle to rotate in radians.
Returns Audio<NodeType>
Inherited from Object3D.rotateZ
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:282

setBuffer

setBuffer(audioBuffer: AudioBuffer): Audio<NodeType>
Parameters
- audioBuffer: AudioBuffer
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:81

setDetune

setDetune(value: number): Audio<NodeType>
Parameters
- value: number
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:88

setFilter

setFilter(filter: AudioNode): Audio<NodeType>
Parameters
- filter: AudioNode
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:93

setFilters

setFilters(value: AudioNode[]): Audio<NodeType>
Parameters
- value: AudioNode[]
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:91

setLoop

setLoop(value: boolean): Audio<NodeType>
Parameters
- value: boolean
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:97

setLoopEnd

setLoopEnd(value: number): Audio<NodeType>
Parameters
- value: number
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:99

setLoopStart

setLoopStart(value: number): Audio<NodeType>
Parameters
- value: number
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:98

setMediaElementSource

setMediaElementSource(mediaElement: HTMLMediaElement): Audio<NodeType>
Parameters
- mediaElement: HTMLMediaElement
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:79

setMediaStreamSource

setMediaStreamSource(mediaStream: MediaStream): Audio<NodeType>
Parameters
- mediaStream: MediaStream
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:80

setNodeSource

setNodeSource(audioNode: AudioBufferSourceNode): Audio<NodeType>
Parameters
- audioNode: AudioBufferSourceNode
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:78

setPlaybackRate

setPlaybackRate(value: number): Audio<NodeType>
Parameters
- value: number
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:94

setRotationFromAxisAngle

setRotationFromAxisAngle(axis: THREE.Vector3, angle: number): void
axis -- A normalized vector in object space. angle -- angle in radians
Parameters
- axis: THREE.Vector3
  
  A normalized vector in object space.
- angle: number
  
  angle in radians
Returns void
Inherited from Object3D.setRotationFromAxisAngle
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:230

setRotationFromEuler

setRotationFromEuler(euler: Euler): void
Calls setRotationFromEuler(euler) on the .quaternion.
Parameters
- euler: Euler
  
  Euler angle specifying rotation amount.
Returns void
Inherited from Object3D.setRotationFromEuler
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:236

setRotationFromMatrix

setRotationFromMatrix(m: Matrix4): void
Calls setFromRotationMatrix(m) on the .quaternion.

Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
Parameters
- m: Matrix4
  
  rotate the quaternion by the rotation component of the matrix.
Returns void
Inherited from Object3D.setRotationFromMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:244

setRotationFromQuaternion

setRotationFromQuaternion(q: Quaternion): void
Copy the given quaternion into .quaternion.
Parameters
- q: Quaternion
  
  normalized Quaternion
Returns void
Inherited from Object3D.setRotationFromQuaternion
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:250

setVolume

setVolume(value: number): Audio<NodeType>
Parameters
- value: number
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:101

stop

stop(): Audio<NodeType>
Returns Audio<NodeType>
- Defined in node_modules/@types/three/src/audio/Audio.d.ts:85

toJSON

toJSON(meta?: {
    geometries: any;
    images: any;
    materials: any;
    textures: any;
}): any
Parameters
- Optional meta: {
      geometries: any;
      images: any;
      materials: any;
      textures: any;
  }
  - geometries: any
  - images: any
  - materials: any
  - textures: any
Returns any
Inherited from Object3D.toJSON
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:398

translateOnAxis

translateOnAxis(axis: THREE.Vector3, distance: number): Audio<NodeType>
Translate an object by distance along an axis in object space. The axis is assumed to be normalized.
Parameters
- axis: THREE.Vector3
  
  A normalized vector in object space.
- distance: number
  
  The distance to translate.
Returns Audio<NodeType>
Inherited from Object3D.translateOnAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:289

translateX

translateX(distance: number): Audio<NodeType>
Translates object along x axis by distance.
Parameters
- distance: number
  
  Distance.
Returns Audio<NodeType>
Inherited from Object3D.translateX
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:295

translateY

translateY(distance: number): Audio<NodeType>
Translates object along y axis by distance.
Parameters
- distance: number
  
  Distance.
Returns Audio<NodeType>
Inherited from Object3D.translateY
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:301

translateZ

translateZ(distance: number): Audio<NodeType>
Translates object along z axis by distance.
Parameters
- distance: number
  
  Distance.
Returns Audio<NodeType>
Inherited from Object3D.translateZ
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:307

traverse

traverse(callback: ((object: Object3D<Event>) => any)): void
Parameters
- callback: ((object: Object3D<Event>) => any)
  - - (object: Object3D<Event>): any
    - Parameters
      
      object: Object3D<Event>
      
      Returns any
Returns void
Inherited from Object3D.traverse
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:375

traverseAncestors

traverseAncestors(callback: ((object: Object3D<Event>) => any)): void
Parameters
- callback: ((object: Object3D<Event>) => any)
  - - (object: Object3D<Event>): any
    - Parameters
      
      object: Object3D<Event>
      
      Returns any
Returns void
Inherited from Object3D.traverseAncestors
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:379

traverseVisible

traverseVisible(callback: ((object: Object3D<Event>) => any)): void
Parameters
- callback: ((object: Object3D<Event>) => any)
  - - (object: Object3D<Event>): any
    - Parameters
      
      object: Object3D<Event>
      
      Returns any
Returns void
Inherited from Object3D.traverseVisible
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:377

updateMatrix

updateMatrix(): void
Updates local transform.

Returns void
Inherited from Object3D.updateMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:384

updateMatrixWorld

updateMatrixWorld(force?: boolean): void
Updates global transform of the object and its children.
Parameters
- Optional force: boolean
Returns void
Inherited from Object3D.updateMatrixWorld
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:389

updateWorldMatrix

updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void
Updates the global transform of the object.
Parameters
- updateParents: boolean
  
  recursively updates global transform of ancestors.
- updateChildren: boolean
  
  recursively updates global transform of descendants.
Returns void
Inherited from Object3D.updateWorldMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:396

worldToLocal

worldToLocal(vector: THREE.Vector3): THREE.Vector3
Updates the vector from world space to local space.
Parameters
- vector: THREE.Vector3
  
  A world vector.
Returns THREE.Vector3
Inherited from Object3D.worldToLocal
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:319

Class Audio<NodeType>

Type Parameters

NodeType extends AudioNode = GainNode

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

NodeType extends AudioNode<NodeType> = GainNode

Parameters

listener: AudioListener

Returns Audio<NodeType>

Properties

animations

Default

autoplay

Default

buffer

castShadow

Default

children

Default

context

customDepthMaterial

customDistanceMaterial

detune

Default

duration

Default

filters

Default

frustumCulled

Default

gain

hasPlaybackControl

Default

id

Readonly isObject3D

isPlaying

Default

layers

Default

listener

loop

Default

loopEnd

Default

loopStart

Default

matrix

Default

matrixAutoUpdate

Default

matrixWorld

Default

matrixWorldNeedsUpdate

Default

Readonly modelViewMatrix

Default

name

Default

Readonly normalMatrix

Default

offset

Default

onAfterRender

Type declaration

Parameters

renderer: WebGLRenderer

scene: THREE.Scene

camera: THREE.Camera

geometry: BufferGeometry

material: THREE.Material

group: THREE.Group

Returns void

onBeforeRender

Type declaration

`Readonly` isObject3D

`Readonly` modelViewMatrix

`Readonly` normalMatrix

`Readonly` position

`Readonly` quaternion

`Readonly` rotation

`Readonly` scale

`Static` DefaultMatrixAutoUpdate

`Static` DefaultUp

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

`Optional` recursive: boolean