Class ComplexTimelineObject3D

A specific THREE.Object3D that has complex timeline features. When changing the timeline, not only can the transformation, rotation, and scale be changed; but also the geometry and material.

The ComplexTimelineObject3D allows you to change the children throughout the timeline.

Use this class if you don't want to use extensions.

Hierarchy

TimelineObject3D
- ComplexTimelineObject3D

Index

Constructors

constructor

Constructors

constructor

new ComplexTimelineObject3D(date?): ComplexTimelineObject3D
Parameters
- Optional date: Date
Returns ComplexTimelineObject3D
Overrides TimelineObject3D.constructor
- Defined in src/ComplexTimelineObject3D.ts:15

Properties

animations

animations: AnimationClip[]

Array with object's animation clips.

Default Value

[]

castShadow

castShadow: boolean

Whether the object gets rendered into shadow map.

Default Value

false

children

children: Object3D<Object3DEventMap>[]

Array with object's children.

See

THREE.Object3DGroup | Group for info on manually grouping objects.

Default Value

[]

`Optional` customDepthMaterial

customDepthMaterial?: Material

Custom depth material to be used when rendering to the depth map.

Remarks

Can only be used in context of meshes.

Default Value

undefined

`Optional` customDistanceMaterial

customDistanceMaterial?: Material

Same as customDepthMaterial, but used with THREE.Object3DPointLight | PointLight.

Default Value

undefined

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 Value

true

`Readonly` hasTimeline

hasTimeline: boolean

`Readonly` id

id: number

Unique number for this Object3D instance.

Remarks

Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

initTimeline

initTimeline: ((this, date?) => void) = initTimeline

Type declaration

- (this, date?): void
- Parameters
  - this: Object3D<Object3DEventMap>
  - date: Date = ...
  Returns void

`Readonly` isComplexTimeline

isComplexTimeline: boolean = true

`Readonly` isObject3D

isObject3D: true

Flag to check if a given object is of type Object3D.

Remarks

This is a constant value

Default Value

true

layers

layers: Layers

The layer membership of the object.

Remarks

The object is only visible if it has at least one layer in common with the THREE.Object3DCamera | Camera in use.

Default Value

new THREE.Layers()

matrix

matrix: Matrix4

The local transform matrix.

Default Value

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 Value

DEFAULT_MATRIX_AUTO_UPDATE - that is (true).

matrixWorld

matrixWorld: Matrix4

The global transform of the object.

Remarks

If the Object3D has no parent, then it's identical to the local transform .matrix.

Default Value

new THREE.Matrix4()

matrixWorldAutoUpdate

matrixWorldAutoUpdate: boolean

If set, then the renderer checks every frame if the object and its children need matrix updates. When it isn't, then you have to maintain all matrices in the object and its children yourself.

Default Value

DEFAULT_MATRIX_WORLD_AUTO_UPDATE - that is (true).

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

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

Default Value

false

`Readonly` modelViewMatrix

modelViewMatrix: Matrix4

Default Value

new THREE.Matrix4()

name

name: string

Optional name of the object

Remarks

(doesn't need to be unique).

Default Value

""

`Readonly` normalMatrix

normalMatrix: Matrix3

Default Value

new THREE.Matrix3()

onAfterRender

onAfterRender: ((renderer, scene, camera, geometry, material, group) => void)

Type declaration

- (renderer, scene, camera, geometry, material, group): void
- An optional callback that is executed immediately after a 3D object is rendered.
  Parameters
  - renderer: WebGLRenderer
  - scene: Scene
  - camera: Camera
  - geometry: BufferGeometry<NormalBufferAttributes>
  - material: Material
  - group: Group<Object3DEventMap>
  Returns void
  
  Remarks
  This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
  
  Default Value
  () => {}

onBeforeRender

onBeforeRender: ((renderer, scene, camera, geometry, material, group) => void)

Type declaration

- (renderer, scene, camera, geometry, material, group): void
- An optional callback that is executed immediately before a 3D object is rendered.
  Parameters
  - renderer: WebGLRenderer
  - scene: Scene
  - camera: Camera
  - geometry: BufferGeometry<NormalBufferAttributes>
  - material: Material
  - group: Group<Object3DEventMap>
  Returns void
  
  Remarks
  This function is called with the following parameters: renderer, scene, camera, geometry, material, group.
  
  Default Value
  () => {}

parent

parent: null | Object3D<Object3DEventMap>

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

`Readonly` position

position: Vector3

Object's local position.

Default Value

new THREE.Vector3() - that is (0, 0, 0).

`Readonly` quaternion

quaternion: Quaternion

Object's local rotation as a THREE.Quaternion | Quaternion.

Default Value

new THREE.Quaternion() - that is (0, 0, 0, 1).

receiveShadow

receiveShadow: boolean

Whether the material receives shadows.

Default Value

false

renderOrder

renderOrder: number

This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently.

Remarks

When this property is set for an instance of Group | Group, all descendants objects will be sorted and rendered together.

Default Value

0

`Readonly` rotation

rotation: Euler

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

Default Value

new THREE.Euler() - that is (0, 0, 0, Euler.DEFAULT_ORDER).

`Readonly` scale

scale: Vector3

The object's local scale.

Default Value

new THREE.Vector3( 1, 1, 1 )

setTimelineDate

setTimelineDate: ((this, date) => void) = setTimelineDate

Type declaration

- (this, date): void
- Parameters
  - this: Object3D<Object3DEventMap>
  - date: Date
  Returns void

timeline

timeline: TimelineObject[]

timelineDate

timelineDate: Date

`Readonly` type

type: string

A Read-only string to check this object type.

Remarks

This can be used to find a specific type of Object3D in a scene.

Default Value

Object3D

up

up: Vector3

This is used by the lookAt method, for example, to determine the orientation of the result.

Default Value

Object3D.DEFAULT_UP - that is (0, 1, 0).

updateTimeline

updateTimeline: ((this) => void) = updateTimeline

Type declaration

- (this): void
- Parameters
  - this: Object3D<Object3DEventMap>
  Returns void

userData

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

An object that can be used to store custom data about the Object3D.

Type declaration

[key: string]: any

Remarks

It should not hold references to functions as these will not be cloned.

Default

{}

uuid

uuid: string

UUID of this object instance.

Remarks

This gets automatically assigned and shouldn't be edited.

visible

visible: boolean

Object gets rendered if true.

Default Value

true

`Static` DEFAULT_MATRIX_AUTO_UPDATE

DEFAULT_MATRIX_AUTO_UPDATE: boolean

The default setting for matrixAutoUpdate for newly created Object3Ds.

Default Value

true

`Static` DEFAULT_MATRIX_WORLD_AUTO_UPDATE

DEFAULT_MATRIX_WORLD_AUTO_UPDATE: boolean

The default setting for matrixWorldAutoUpdate for newly created Object3Ds.

Default Value

true

`Static` DEFAULT_UP

DEFAULT_UP: Vector3

The default up direction for objects, also used as the default position for THREE.DirectionalLight | DirectionalLight, THREE.HemisphereLight | HemisphereLight and THREE.Spotlight | Spotlight (which creates lights shining from the top down).

Default Value

new THREE.Vector3( 0, 1, 0)

Methods

add

add(...object): ComplexTimelineObject3D
Adds another Object3D as child of this Object3D.
Parameters
- Rest ...object: Object3D<Object3DEventMap>[]
Returns ComplexTimelineObject3D
Remarks
An arbitrary number of objects may be added

See
- attach
- THREE.Group | Group for info on manually grouping objects.
Overrides TimelineObject3D.add
- Defined in src/ComplexTimelineObject3D.ts:19

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Object3DEventMap[T], T, ComplexTimelineObject3D>
  
  The function that gets called when the event is fired.
Returns void
Inherited from TimelineObject3D.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, ComplexTimelineObject3D>
Returns void
Inherited from TimelineObject3D.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:56

applyMatrix4

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

applyQuaternion

applyQuaternion(quaternion): ComplexTimelineObject3D
Applies the rotation represented by the quaternion to the object.
Parameters
- quaternion: Quaternion
Returns ComplexTimelineObject3D
Inherited from TimelineObject3D.applyQuaternion
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:295

attach

attach(object): ComplexTimelineObject3D
Adds a Object3D as a child of this, while maintaining the object's world transform.
Parameters
- object: Object3D<Object3DEventMap>
Returns ComplexTimelineObject3D

Remarks
Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

See
add
Inherited from TimelineObject3D.attach
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:445

clear

clear(): ComplexTimelineObject3D
Removes all child objects.

Returns ComplexTimelineObject3D
Inherited from TimelineObject3D.clear
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:437

clone

clone(recursive?): ComplexTimelineObject3D
Returns a clone of this object and optionally all descendants.
Parameters
- Optional recursive: boolean
  
  If true, descendants of the object are also cloned. Default true
Returns ComplexTimelineObject3D
Inherited from TimelineObject3D.clone
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:566

copy

copy(source, recursive?): ComplexTimelineObject3D
Copy the given object into this object
Parameters
- source: ComplexTimelineObject3D
- Optional recursive: boolean
  
  If true, descendants of the object are also copied. Default true
Returns ComplexTimelineObject3D

Remarks
Note: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Inherited from TimelineObject3D.copy
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:574

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- event: BaseEvent<T> & Object3DEventMap[T]
  
  The event that gets fired.
Returns void
Inherited from TimelineObject3D.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:84

getObjectById

getObjectById(id): undefined | Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a matching id.
Parameters
- id: number
  
  Unique number of the object instance. Expects a Integer
Returns undefined | Object3D<Object3DEventMap>

Remarks
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

See
id
Inherited from TimelineObject3D.getObjectById
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:453

getObjectByName

getObjectByName(name): undefined | Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a matching name.
Parameters
- name: string
  
  String to match to the children's Object3D.name property.
Returns undefined | Object3D<Object3DEventMap>

Remarks
Note that for most objects the name is an empty string by default
Inherited from TimelineObject3D.getObjectByName
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:461

getObjectByProperty

getObjectByProperty(name, value): undefined | Object3D<Object3DEventMap>
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
Parameters
- name: string
  
  the property name to search for.
- value: any
  
  value of the given property.
Returns undefined | Object3D<Object3DEventMap>
Inherited from TimelineObject3D.getObjectByProperty
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:470

getObjectsByProperty

getObjectsByProperty(name, value): Object3D<Object3DEventMap>[]
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
Parameters
- name: string
  
  The property name to search for.
- value: any
  
  Value of the given property.
Returns Object3D<Object3DEventMap>[]
Inherited from TimelineObject3D.getObjectsByProperty
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:478

getWorldDirection

getWorldDirection(target): Vector3
Returns a vector representing the direction of object's positive z-axis in world space.
Parameters
- target: Vector3
  
  The result will be copied into this Vector3.
Returns Vector3
Inherited from TimelineObject3D.getWorldDirection
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:502

getWorldPosition

getWorldPosition(target): Vector3
Returns a vector representing the position of the object in world space.
Parameters
- target: Vector3
  
  The result will be copied into this Vector3.
Returns Vector3
Inherited from TimelineObject3D.getWorldPosition
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:484

getWorldQuaternion

getWorldQuaternion(target): Quaternion
Returns a quaternion representing the rotation of the object in world space.
Parameters
- target: Quaternion
  
  The result will be copied into this Quaternion.
Returns Quaternion
Inherited from TimelineObject3D.getWorldQuaternion
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:490

getWorldScale

getWorldScale(target): Vector3
Returns a vector of the scaling factors applied to the object for each axis in world space.
Parameters
- target: Vector3
  
  The result will be copied into this Vector3.
Returns Vector3
Inherited from TimelineObject3D.getWorldScale
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:496

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<Object3DEventMap[T], T, ComplexTimelineObject3D>
  
  The function that gets called when the event is fired.
Returns boolean
Inherited from TimelineObject3D.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, ComplexTimelineObject3D>
Returns boolean
Inherited from TimelineObject3D.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:67

localToWorld

localToWorld(vector): Vector3
Converts the vector from this object's local space to world space.
Parameters
- vector: Vector3
  
  A vector representing a position in this object's local space.
Returns Vector3
Inherited from TimelineObject3D.localToWorld
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:388

lookAt

lookAt(vector): void
Rotates the object to face a point in world space.
Parameters
- vector: Vector3
  
  A vector representing a position in world space to look at.
Returns void

Remarks
This method does not support objects having non-uniformly-scaled parent(s).
Inherited from TimelineObject3D.lookAt
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:401
lookAt(x, y, z): void
Rotates the object to face a point in world space.
Parameters
- x: number
  
  Expects a Float
- y: number
  
  Expects a Float
- z: number
  
  Expects a Float
Returns void

Remarks
This method does not support objects having non-uniformly-scaled parent(s).
Inherited from TimelineObject3D.lookAt
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:409

raycast

raycast(raycaster, intersects): void
Abstract (empty) method to get intersections between a casted ray and this object
Parameters
- raycaster: Raycaster
- intersects: Intersection<Object3D<Object3DEventMap>>[]
Returns void

Remarks
Subclasses such as THREE.Mesh | Mesh, THREE.Line | Line, and THREE.Points | Points implement this method in order to use raycasting.

See
THREE.Raycaster | Raycaster

Default Value
() => {}
Inherited from TimelineObject3D.raycast
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:512

remove

remove(...object): ComplexTimelineObject3D
Removes a Object3D as child of this Object3D.
Parameters
- Rest ...object: Object3D<Object3DEventMap>[]
Returns ComplexTimelineObject3D

Remarks
An arbitrary number of objects may be removed.

See
THREE.Group | Group for info on manually grouping objects.
Inherited from TimelineObject3D.remove
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:427

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends keyof Object3DEventMap
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<Object3DEventMap[T], T, ComplexTimelineObject3D>
  
  The listener function that gets removed.
Returns void
Inherited from TimelineObject3D.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, ComplexTimelineObject3D>
Returns void
Inherited from TimelineObject3D.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:78

removeFromParent

removeFromParent(): ComplexTimelineObject3D
Removes this object from its current parent.

Returns ComplexTimelineObject3D
Inherited from TimelineObject3D.removeFromParent
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:432

rotateOnAxis

rotateOnAxis(axis, angle): ComplexTimelineObject3D
Rotate an object along an axis in object space.
Parameters
- axis: Vector3
  
  A normalized vector in object space.
- angle: number
  
  The angle in radians. Expects a Float
Returns ComplexTimelineObject3D

Remarks
The axis is assumed to be normalized.
Inherited from TimelineObject3D.rotateOnAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:329

rotateOnWorldAxis

rotateOnWorldAxis(axis, angle): ComplexTimelineObject3D
Rotate an object along an axis in world space.
Parameters
- axis: Vector3
  
  A normalized vector in world space.
- angle: number
  
  The angle in radians. Expects a Float
Returns ComplexTimelineObject3D

Remarks
The axis is assumed to be normalized
Inherited from TimelineObject3D.rotateOnWorldAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:338

rotateX

rotateX(angle): ComplexTimelineObject3D
Rotates the object around x axis in local space.
Parameters
- angle: number
Returns ComplexTimelineObject3D
Inherited from TimelineObject3D.rotateX
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:344

rotateY

rotateY(angle): ComplexTimelineObject3D
Rotates the object around y axis in local space.
Parameters
- angle: number
Returns ComplexTimelineObject3D
Inherited from TimelineObject3D.rotateY
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:350

rotateZ

rotateZ(angle): ComplexTimelineObject3D
Rotates the object around z axis in local space.
Parameters
- angle: number
Returns ComplexTimelineObject3D
Inherited from TimelineObject3D.rotateZ
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:356

setRotationFromAxisAngle

setRotationFromAxisAngle(axis, angle): void
Calls THREE.Quaternion.setFromAxisAngle | setFromAxisAngle(axis, angle) on the .quaternion.
Parameters
- axis: Vector3
  
  A normalized vector in object space.
- angle: number
  
  Angle in radians. Expects a Float
Returns void
Inherited from TimelineObject3D.setRotationFromAxisAngle
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:302

setRotationFromEuler

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

setRotationFromMatrix

setRotationFromMatrix(m): void
Calls THREE.Quaternion.setFromRotationMatrix | setFromRotationMatrix(m) on the .quaternion.
Parameters
- m: Matrix4
  
  Rotate the quaternion by the rotation component of the matrix.
Returns void

Remarks
Note that this assumes that the upper 3x3 of m is a pure rotation matrix (i.e, unscaled).
Inherited from TimelineObject3D.setRotationFromMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:315

setRotationFromQuaternion

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

toJSON

toJSON(meta?): any
Convert the object to three.js JSON Object/Scene format.
Parameters
- Optional meta: {
      geometries: any;
      images: any;
      materials: any;
      textures: any;
  }
  
  Object containing metadata such as materials, textures or images for the object.
  - geometries: any
  - images: any
  - materials: any
  - textures: any
Returns any
Inherited from TimelineObject3D.toJSON
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:560

translateOnAxis

translateOnAxis(axis, distance): ComplexTimelineObject3D
Translate an object by distance along an axis in object space
Parameters
- axis: Vector3
  
  A normalized vector in object space.
- distance: number
  
  The distance to translate. Expects a Float
Returns ComplexTimelineObject3D

Remarks
The axis is assumed to be normalized.
Inherited from TimelineObject3D.translateOnAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:364

translateX

translateX(distance): ComplexTimelineObject3D
Translates object along x axis in object space by distance units.
Parameters
- distance: number
  
  Expects a Float
Returns ComplexTimelineObject3D
Inherited from TimelineObject3D.translateX
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:370

translateY

translateY(distance): ComplexTimelineObject3D
Translates object along y axis in object space by distance units.
Parameters
- distance: number
  
  Expects a Float
Returns ComplexTimelineObject3D
Inherited from TimelineObject3D.translateY
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:376

translateZ

translateZ(distance): ComplexTimelineObject3D
Translates object along z axis in object space by distance units.
Parameters
- distance: number
  
  Expects a Float
Returns ComplexTimelineObject3D
Inherited from TimelineObject3D.translateZ
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:382

traverse

traverse(callback): void
Executes the callback on this object and all descendants.
Parameters
- callback: ((object) => any)
  
  A function with as first argument an Object3D object.
  - - (object): any
    - Parameters
      
      object: Object3D<Object3DEventMap>
      
      Returns any
Returns void

Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Inherited from TimelineObject3D.traverse
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:519

traverseAncestors

traverseAncestors(callback): void
Executes the callback on all ancestors.
Parameters
- callback: ((object) => any)
  
  A function with as first argument an Object3D object.
  - - (object): any
    - Parameters
      
      object: Object3D<Object3DEventMap>
      
      Returns any
Returns void

Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Inherited from TimelineObject3D.traverseAncestors
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:534

traverseVisible

traverseVisible(callback): void
Like traverse, but the callback will only be executed for visible objects
Parameters
- callback: ((object) => any)
  
  A function with as first argument an Object3D object.
  - - (object): any
    - Parameters
      
      object: Object3D<Object3DEventMap>
      
      Returns any
Returns void

Remarks
Descendants of invisible objects are not traversed.
Inherited from TimelineObject3D.traverseVisible
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:527

updateMatrix

updateMatrix(): void
Updates local transform.

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

updateMatrixWorld

updateMatrixWorld(force?): void
Updates the global transform of the object. And will update the object descendants if .matrixWorldNeedsUpdate is set to true or if the force parameter is set to true.
Parameters
- Optional force: boolean
  
  A boolean that can be used to bypass .matrixWorldAutoUpdate, to recalculate the world matrix of the object and descendants on the current frame. Useful if you cannot wait for the renderer to update it on the next frame, assuming .matrixWorldAutoUpdate set to true.
Returns void
Inherited from TimelineObject3D.updateMatrixWorld
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:547

updateWorldMatrix

updateWorldMatrix(updateParents, updateChildren): 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 TimelineObject3D.updateWorldMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:554

worldToLocal

worldToLocal(vector): Vector3
Converts the vector from world space to this object's local space.
Parameters
- vector: Vector3
  
  A vector representing a position in world space.
Returns Vector3
Inherited from TimelineObject3D.worldToLocal
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:394

Class ComplexTimelineObject3D

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional date: Date

Returns ComplexTimelineObject3D

Properties

animations

Default Value

castShadow

Default Value

children

See

Default Value

Optional customDepthMaterial

Remarks

Default Value

Optional customDistanceMaterial

Default Value

frustumCulled

Default Value

Readonly hasTimeline

Readonly id

Remarks

initTimeline

Type declaration

Parameters

this: Object3D<Object3DEventMap>

date: Date = ...

Returns void

Readonly isComplexTimeline

Readonly isObject3D

Remarks

Default Value

layers

Remarks

Default Value

matrix

Default Value

matrixAutoUpdate

Default Value

matrixWorld

Remarks

Default Value

matrixWorldAutoUpdate

Default Value

matrixWorldNeedsUpdate

Default Value

Readonly modelViewMatrix

Default Value

name

Remarks

Default Value

Readonly normalMatrix

Default Value

onAfterRender

Type declaration

Parameters

renderer: WebGLRenderer

scene: Scene

camera: Camera

geometry: BufferGeometry<NormalBufferAttributes>

material: Material

group: Group<Object3DEventMap>

Returns void

Remarks

Default Value

onBeforeRender

Type declaration

Parameters

renderer: WebGLRenderer

scene: Scene

camera: Camera

geometry: BufferGeometry<NormalBufferAttributes>

material: Material

`Optional` date: Date

`Optional` customDepthMaterial

`Optional` customDistanceMaterial

`Readonly` hasTimeline

`Readonly` id

`Readonly` isComplexTimeline

`Readonly` isObject3D

`Readonly` modelViewMatrix

`Readonly` normalMatrix

`Readonly` position

`Readonly` quaternion

`Readonly` rotation

`Readonly` scale

`Readonly` type

`Static` DEFAULT_MATRIX_AUTO_UPDATE

`Static` DEFAULT_MATRIX_WORLD_AUTO_UPDATE

`Static` DEFAULT_UP

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