Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Node<DataType>

Type parameters

  • DataType

Hierarchy

  • Mesh
    • Node

Implements

Index

Constructors

constructor

Properties

castShadow

castShadow: boolean

Gets rendered into shadow map.

children

children: Object3D[]

Array with object's children.

customDepthMaterial

customDepthMaterial: 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: Material

Same as customDepthMaterial, but used with PointLight.

data

data: DataType

drawMode

drawMode: TrianglesDrawModes

force

force: Vector3

frustumCulled

frustumCulled: boolean

When this is set, it checks every frame if the object is in the frustum of the camera. Otherwise the object gets drawn every frame even if it isn't visible.

geometry

geometry: Geometry | BufferGeometry

id

id: number

Unique number of this object instance.

isMesh

isMesh: true

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.

label

label: string

layers

layers: Layers

material

material: Material | Material[]

matrix

matrix: Matrix4

Local transform.

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.

matrixWorld

matrixWorld: Matrix4

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

matrixWorldNeedsUpdate

matrixWorldNeedsUpdate: boolean

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

modelViewMatrix

modelViewMatrix: Matrix4

Optional morphTargetDictionary

morphTargetDictionary: object

Type declaration

  • [key: string]: number

Optional morphTargetInfluences

morphTargetInfluences: number[]

name

name: string

normalMatrix

normalMatrix: Matrix3

onAfterRender

onAfterRender: function

Calls after rendering object

Type declaration

    • (renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: Geometry | BufferGeometry, material: Material, group: Group): void
    • Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: Geometry | BufferGeometry
      • material: Material
      • group: Group

      Returns void

onBeforeRender

onBeforeRender: function

Calls before rendering object

Type declaration

    • (renderer: WebGLRenderer, scene: Scene, camera: Camera, geometry: Geometry | BufferGeometry, material: Material, group: Group): void
    • Parameters

      • renderer: WebGLRenderer
      • scene: Scene
      • camera: Camera
      • geometry: Geometry | BufferGeometry
      • material: Material
      • group: Group

      Returns void

opt

opt: MeshParameters<Node<DataType>>

parent

parent: Object3D | null

Object's parent in the scene graph.

position

position: Vector3

Object's local position.

quaternion

quaternion: Quaternion

Global rotation.

receiveShadow

receiveShadow: boolean

Material gets baked in shadow receiving.

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.

rotation

rotation: Euler

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

scale

scale: Vector3

Object's local scale.

type

type: string

up

up: Vector3

Up direction.

userData

userData: object

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.

Type declaration

  • [key: string]: any

uuid

uuid: string

visible

visible: boolean

Object gets rendered if true.

Static DefaultMatrixAutoUpdate

DefaultMatrixAutoUpdate: boolean

Static DefaultUp

DefaultUp: Vector3

Methods

add

  • add(...object: Object3D[]): this
  • Adds object as child of this object.

    Parameters

    • Rest ...object: Object3D[]

    Returns this

addEventListener

  • addEventListener(type: string, listener: function): void
  • Adds a listener to an event type.

    Parameters

    • type: string

      The type of event to listen to.

    • listener: function

      The function that gets called when the event is fired.

        • (event: Event): void
        • Parameters

          • event: Event

          Returns void

    Returns void

applyMatrix

  • applyMatrix(matrix: Matrix4): void
  • This updates the position, rotation and scale with the matrix.

    Parameters

    • matrix: Matrix4

    Returns void

applyQuaternion

  • applyQuaternion(quaternion: Quaternion): this
  • Parameters

    • quaternion: Quaternion

    Returns this

attach

  • attach(object: Object3D): this
  • Adds object as a child of this, while maintaining the object's world transform.

    Parameters

    • object: Object3D

    Returns this

clone

  • clone(recursive?: boolean): this
  • Parameters

    • Optional recursive: boolean

    Returns this

copy

  • copy(source: this, recursive?: boolean): this
  • Parameters

    • source: this
    • Optional recursive: boolean

    Returns this

dispatchEvent

  • dispatchEvent(event: object): void
  • Fire an event type.

    Parameters

    • event: object
      • [attachment: string]: any
      • type: string

    Returns void

getObjectById

  • getObjectById(id: number): Object3D | undefined
  • 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 | undefined

getObjectByName

  • getObjectByName(name: string): Object3D | undefined
  • 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 | undefined

getObjectByProperty

  • getObjectByProperty(name: string, value: string): Object3D | undefined
  • Parameters

    • name: string
    • value: string

    Returns Object3D | undefined

getWorldDirection

  • getWorldDirection(target: Vector3): Vector3
  • Parameters

    • target: Vector3

    Returns Vector3

getWorldPosition

  • getWorldPosition(target: Vector3): Vector3
  • Parameters

    • target: Vector3

    Returns Vector3

getWorldQuaternion

  • getWorldQuaternion(target: Quaternion): Quaternion
  • Parameters

    • target: Quaternion

    Returns Quaternion

getWorldScale

  • getWorldScale(target: Vector3): Vector3
  • Parameters

    • target: Vector3

    Returns Vector3

hasEventListener

  • hasEventListener(type: string, listener: function): boolean
  • Checks if listener is added to an event type.

    Parameters

    • type: string

      The type of event to listen to.

    • listener: function

      The function that gets called when the event is fired.

        • (event: Event): void
        • Parameters

          • event: Event

          Returns void

    Returns boolean

localToWorld

  • localToWorld(vector: Vector3): Vector3
  • Updates the vector from local space to world space.

    Parameters

    • vector: Vector3

      A local vector.

    Returns Vector3

lookAt

  • lookAt(vector: Vector3 | number, y?: number, z?: number): void
  • Rotates object to face point in space.

    Parameters

    • vector: Vector3 | number

      A world vector to look at.

    • Optional y: number
    • Optional z: number

    Returns void

raycast

  • raycast(raycaster: Raycaster, intersects: Intersection[]): void
  • Parameters

    • raycaster: Raycaster
    • intersects: Intersection[]

    Returns void

remove

  • remove(...object: Object3D[]): this
  • Removes object as child of this object.

    Parameters

    • Rest ...object: Object3D[]

    Returns this

removeEventListener

  • removeEventListener(type: string, listener: function): void
  • Removes a listener from an event type.

    Parameters

    • type: string

      The type of the listener that gets removed.

    • listener: function

      The listener function that gets removed.

        • (event: Event): void
        • Parameters

          • event: Event

          Returns void

    Returns void

rotateOnAxis

  • rotateOnAxis(axis: Vector3, angle: number): this
  • Rotate an object along an axis in object space. The axis is assumed to be normalized.

    Parameters

    • axis: Vector3

      A normalized vector in object space.

    • angle: number

      The angle in radians.

    Returns this

rotateOnWorldAxis

  • rotateOnWorldAxis(axis: Vector3, angle: number): this
  • Rotate an object along an axis in world space. The axis is assumed to be normalized. Method Assumes no rotated parent.

    Parameters

    • axis: Vector3

      A normalized vector in object space.

    • angle: number

      The angle in radians.

    Returns this

rotateX

  • rotateX(angle: number): this
  • Parameters

    • angle: number

    Returns this

rotateY

  • rotateY(angle: number): this
  • Parameters

    • angle: number

    Returns this

rotateZ

  • rotateZ(angle: number): this
  • Parameters

    • angle: number

    Returns this

setDrawMode

  • setDrawMode(drawMode: TrianglesDrawModes): void
  • Parameters

    • drawMode: TrianglesDrawModes

    Returns void

setRotationFromAxisAngle

  • setRotationFromAxisAngle(axis: Vector3, angle: number): void
  • Parameters

    • axis: Vector3
    • angle: number

    Returns void

setRotationFromEuler

  • setRotationFromEuler(euler: Euler): void
  • Parameters

    • euler: Euler

    Returns void

setRotationFromMatrix

  • setRotationFromMatrix(m: Matrix4): void
  • Parameters

    • m: Matrix4

    Returns void

setRotationFromQuaternion

  • setRotationFromQuaternion(q: Quaternion): void
  • Parameters

    • q: Quaternion

    Returns void

toJSON

  • toJSON(meta?: object): any
  • Parameters

    • Optional meta: object
      • geometries: any
      • images: any
      • materials: any
      • textures: any

    Returns any

translateOnAxis

  • translateOnAxis(axis: Vector3, distance: number): this
  • Parameters

    • axis: Vector3

      A normalized vector in object space.

    • distance: number

      The distance to translate.

    Returns this

translateX

  • translateX(distance: number): this
  • Translates object along x axis by distance.

    Parameters

    • distance: number

      Distance.

    Returns this

translateY

  • translateY(distance: number): this
  • Translates object along y axis by distance.

    Parameters

    • distance: number

      Distance.

    Returns this

translateZ

  • translateZ(distance: number): this
  • Translates object along z axis by distance.

    Parameters

    • distance: number

      Distance.

    Returns this

traverse

  • traverse(callback: function): void
  • Parameters

    • callback: function
        • (object: Object3D): any
        • Parameters

          • object: Object3D

          Returns any

    Returns void

traverseAncestors

  • traverseAncestors(callback: function): void
  • Parameters

    • callback: function
        • (object: Object3D): any
        • Parameters

          • object: Object3D

          Returns any

    Returns void

traverseVisible

  • traverseVisible(callback: function): void
  • Parameters

    • callback: function
        • (object: Object3D): any
        • Parameters

          • object: Object3D

          Returns any

    Returns void

updateMatrix

  • updateMatrix(): void
  • Updates local transform.

    Returns void

updateMatrixWorld

  • updateMatrixWorld(force?: boolean): void
  • Updates global transform of the object and its children.

    Parameters

    • Optional force: boolean

    Returns void

updateMorphTargets

  • updateMorphTargets(): void
  • Returns void

updateWorldMatrix

  • updateWorldMatrix(updateParents: boolean, updateChildren: boolean): void
  • Parameters

    • updateParents: boolean
    • updateChildren: boolean

    Returns void

worldToLocal

  • worldToLocal(vector: Vector3): Vector3
  • Updates the vector from world space to local space.

    Parameters

    • vector: Vector3

      A world vector.

    Returns Vector3

Generated using TypeDoc