Class BillboardPlane

A mesh-based billboard class that uses image files as texture sources with optional camera following.

This class extends Three.js Mesh and provides a plane-based billboard that can optionally rotate to face the camera horizontally. Unlike the Sprite-based Billboard class, BillboardPlane uses PlaneGeometry and can be manipulated like any other Mesh object.

Key Features

Mesh-based rendering: Uses PlaneGeometry with MeshBasicMaterial for reliable billboard display
Camera chasing: Optional horizontal rotation to face the camera via CameraChaser
Standard mesh operations: Supports Three.js Mesh features like transformations and positioning
Consistent API: Shares the same interface as Billboard for easy switching

When to Use BillboardPlane vs Billboard

Use BillboardPlane when:

You need mesh-specific features (transformations, positioning, etc.)
You want partial camera following (Y-axis rotation only)
You need to integrate with mesh-based workflows
You require more control over geometry positioning and rotation

Use Billboard when:

You need automatic full camera facing (all axes)
You want simpler sprite-based rendering
You need pixel-perfect dot-by-dot display with sizeAttenuation = false
Performance is critical and you don't need mesh features

Camera Chaser Functionality

The integrated CameraChaser provides horizontal-only camera following:

Rotates around Y-axis only (no X-axis or Z-axis rotation)
Must be explicitly enabled via cameraChaser.isLookingCameraHorizontal = true
Useful for UI elements or signs that should face the camera horizontally

Example

// Create a basic plane billboard
const planeBillboard = new BillboardPlane("./texture.png", 1.0);
scene.add(planeBillboard);

// Enable horizontal camera chasing
planeBillboard.cameraChaser.isLookingCameraHorizontal = true;

// Set custom scale
planeBillboard.imageScale = 0.01;

// Create with custom texture filtering
const planeBillboard = new BillboardPlane("./texture.png", 1.0, {
  minFilter: NearestFilter
});

// Access mesh-specific features (transformations, positioning)
planeBillboard.position.y = 2.0;
planeBillboard.rotation.z = Math.PI / 4;

Hierarchy

Mesh
- BillboardPlane

Index

Constructors

constructor

Accessors

imageScale

Constructors

constructor

new BillboardPlane(
    url: string,
    imageScale: number,
    option?: BillboardOptions,
): BillboardPlane
Creates a new BillboardPlane instance.

The constructor initializes the plane billboard synchronously, but texture loading is performed asynchronously. The plane will be initially invisible and become visible once the texture loads successfully.

A CameraChaser instance is automatically created but must be manually enabled by setting isLookingCameraHorizontal = true.
Parameters
- url: string
  URL of the texture image file to load
- imageScale: number
  Initial scale factor for the image
- Optionaloption: BillboardOptions
  Optional configuration for texture filtering and other settings
Returns BillboardPlane
Example
```
// Basic usage
const plane = new BillboardPlane("./image.png", 1.0);

// With camera chasing enabled
const plane = new BillboardPlane("./image.png", 1.0);
plane.cameraChaser.isLookingCameraHorizontal = true;
```
Overrides Mesh.constructor
- Defined in src/BillboardPlane.ts:101

Properties

animations

animations: AnimationClip[]

Array with object's animation clips.

Default Value

[]

cameraChaser

cameraChaser: CameraChaser

Camera chaser instance that provides optional horizontal camera following. Set isLookingCameraHorizontal = true to enable camera chasing.

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

[]

count

count: number

The number of instances of this mesh. Can only be used with WebGPURenderer.

Default

`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. When shadow-casting with a THREE.DirectionalLight | DirectionalLight or THREE.SpotLight | SpotLight, if you are modifying vertex positions in the vertex shader you must specify a customDepthMaterial for proper shadows.

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

geometry

geometry: BufferGeometry

An instance of THREE.BufferGeometry | BufferGeometry (or derived classes), defining the object's structure.

Default Value

THREE.BufferGeometry | new THREE.BufferGeometry().

`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. Expects a Integer

`Readonly`isMesh

isMesh: true

Read-only flag to check if a given object is of type Mesh.

Remarks

This is a constant value

Default Value

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. This property can also be used to filter out unwanted objects in ray-intersection tests when using THREE.Raycaster | Raycaster.

Default Value

new THREE.Layers()

material

material: Material | Material[]

An instance of material derived from the THREE.Material | Material base class or an array of materials, defining the object's appearance.

Default Value

THREE.MeshBasicMaterial | new THREE.MeshBasicMaterial().

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 THREE.Object3D.matrix | .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()

`Optional`morphTargetDictionary

morphTargetDictionary?: { [key: string]: number }

A dictionary of morphTargets based on the morphTarget.name property.

Default Value

undefined, but rebuilt by .updateMorphTargets().

`Optional`morphTargetInfluences

morphTargetInfluences?: number[]

An array of weights typically from 0-1 that specify how much of the morph is applied.

Default Value

undefined, but reset to a blank array by .updateMorphTargets().

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()

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. Sorting is from lowest to highest renderOrder.

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 )

`Readonly`type

type: string

Default Value

Mesh

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).

userData

userData: Record<string, any>

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

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)

Accessors

imageScale

get imageScale(): number
Gets the current image scale factor.

Returns number
The current scale factor applied to the image
- Defined in src/BillboardPlane.ts:117
set imageScale(value: number): void
Sets the image scale factor.

The scale factor determines how the image is sized relative to its original dimensions in Three.js coordinate system units (meters by default).

Scale Factor Behavior for Mesh Objects
For BillboardPlane (Mesh-based), the scale factor is applied directly to the object's scale property. The PlaneGeometry is created with pixel dimensions, and the scale factor modifies the overall size.
- Scale = 1.0: The plane size matches the source image pixel dimensions directly
- Scale = 0.5: The plane becomes half the pixel dimensions
- Scale = 2.0: The plane becomes twice the pixel dimensions
Parameters
- value: number
  The scale factor to apply to the image
Returns void
Example
```
// Scale to 50% of original pixel dimensions
planeBillboard.imageScale = 0.5;

// Direct pixel-to-unit mapping (64px image = 64 units)
planeBillboard.imageScale = 1.0;

// Set appropriate scale for scene
planeBillboard.imageScale = 0.01;
```
- Defined in src/BillboardPlane.ts:150

Methods

add

add(...object: Object3D<Object3DEventMap>[]): this
Adds another Object3D as child of this Object3D.
Parameters
- ...object: Object3D<Object3DEventMap>[]
Returns this
Remarks
An arbitrary number of objects may be added Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.
See
- attach
- THREE.Group | Group for info on manually grouping objects.
Inherited from Mesh.add
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:515

addEventListener

addEventListener<T extends keyof Object3DEventMap>(
type: T,
listener: EventListener<Object3DEventMap[T], T, BillboardPlane>,
): 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, BillboardPlane>
  The function that gets called when the event is fired.
Returns void
Inherited from Mesh.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:52

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 Mesh.applyMatrix4
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:385

applyQuaternion

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

attach

attach(object: Object3D): this
Adds a Object3D as a child of this, while maintaining the object's world transform.
Parameters
- object: Object3D
Returns this
Remarks
Note: This method does not support scene graphs having non-uniformly-scaled nodes(s).

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

clear

clear(): this
Removes all child objects.

Returns this
Inherited from Mesh.clear
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:533

clone

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

copy

copy(object: Object3D, recursive?: boolean): this
Copies the given object into this object.
Parameters
- object: Object3D
- Optionalrecursive: boolean
  If set to true, descendants of the object are copied next to the existing ones. If set to false, descendants are left unchanged. Default is true.
Returns this
Remarks
Event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Inherited from Mesh.copy
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:673

dispatchEvent

dispatchEvent<T extends keyof Object3DEventMap>(
event: BaseEvent<T> & Object3DEventMap[T],
): 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 Mesh.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:81

getObjectById

getObjectById(id: number): 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 Mesh.getObjectById
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:549

getObjectByName

getObjectByName(name: string): 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 You will have to set it manually to make use of this method.
Inherited from Mesh.getObjectByName
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:557

getObjectByProperty

getObjectByProperty(
name: string,
value: any,
): 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 Mesh.getObjectByProperty
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:566

getObjectsByProperty

getObjectsByProperty(
    name: string,
    value: any,
    optionalTarget?: Object3D<Object3DEventMap>[],
): 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.
- OptionaloptionalTarget: Object3D<Object3DEventMap>[]
  target to set the result. Otherwise a new Array is instantiated. If set, you must clear this array prior to each call (i.e., array.length = 0;).
Returns Object3D<Object3DEventMap>[]
Inherited from Mesh.getObjectsByProperty
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:576

getVertexPosition

getVertexPosition(index: number, target: Vector3): Vector3
Get the local-space position of the vertex at the given index, taking into account the current animation state of both morph targets and skinning.
Parameters
- index: number
  Expects a Integer
- target: Vector3
Returns Vector3
Inherited from Mesh.getVertexPosition
- Defined in node_modules/@types/three/src/objects/Mesh.d.ts:99

getWorldDirection

getWorldDirection(target: Vector3): 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 Mesh.getWorldDirection
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:600

getWorldPosition

getWorldPosition(target: Vector3): 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 Mesh.getWorldPosition
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:582

getWorldQuaternion

getWorldQuaternion(target: Quaternion): 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 Mesh.getWorldQuaternion
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:588

getWorldScale

getWorldScale(target: Vector3): 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 Mesh.getWorldScale
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:594

hasEventListener

hasEventListener<T extends keyof Object3DEventMap>(
type: T,
listener: EventListener<Object3DEventMap[T], T, BillboardPlane>,
): 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, BillboardPlane>
  The function that gets called when the event is fired.
Returns boolean
Inherited from Mesh.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:62

localToWorld

localToWorld(vector: Vector3): 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 Mesh.localToWorld
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:484

lookAt

lookAt(vector: Vector3): 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 Mesh.lookAt
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:497
lookAt(x: number, y: number, z: number): 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 Mesh.lookAt
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:505

onAfterRender

onAfterRender(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    material: Material,
    group: Group,
): void
An optional callback that is executed immediately after a 3D object is rendered.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry
- material: Material
- group: Group
Returns void
Remarks
This function is called with the following parameters: renderer, scene, camera, geometry, material, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.
Inherited from Mesh.onAfterRender
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:353

onAfterShadow

onAfterShadow(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    shadowCamera: Camera,
    geometry: BufferGeometry,
    depthMaterial: Material,
    group: Group,
): void
An optional callback that is executed immediately after a 3D object is rendered to a shadow map.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- shadowCamera: Camera
- geometry: BufferGeometry
- depthMaterial: Material
- group: Group
Returns void
Remarks
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.
Inherited from Mesh.onAfterShadow
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:318

onBeforeRender

onBeforeRender(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    geometry: BufferGeometry,
    material: Material,
    group: Group,
): void
An optional callback that is executed immediately before a 3D object is rendered.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- geometry: BufferGeometry
- material: Material
- group: Group
Returns void
Remarks
This function is called with the following parameters: renderer, scene, camera, geometry, material, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.
Inherited from Mesh.onBeforeRender
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:336

onBeforeShadow

onBeforeShadow(
    renderer: WebGLRenderer,
    scene: Scene,
    camera: Camera,
    shadowCamera: Camera,
    geometry: BufferGeometry,
    depthMaterial: Material,
    group: Group,
): void
An optional callback that is executed immediately before a 3D object is rendered to a shadow map.
Parameters
- renderer: WebGLRenderer
- scene: Scene
- camera: Camera
- shadowCamera: Camera
- geometry: BufferGeometry
- depthMaterial: Material
- group: Group
Returns void
Remarks
This function is called with the following parameters: renderer, scene, camera, shadowCamera, geometry, depthMaterial, group. Please notice that this callback is only executed for renderable 3D objects. Meaning 3D objects which define their visual appearance with geometries and materials like instances of Mesh, Line, Points or Sprite. Instances of Object3D, Group or Bone are not renderable and thus this callback is not executed for such objects.
Inherited from Mesh.onBeforeShadow
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:299

raycast

raycast(
raycaster: Raycaster,
intersects: Intersection<Object3D<Object3DEventMap>>[],
): 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 Mesh.raycast
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:610

remove

remove(...object: Object3D<Object3DEventMap>[]): this
Removes a Object3D as child of this Object3D.
Parameters
- ...object: Object3D<Object3DEventMap>[]
Returns this
Remarks
An arbitrary number of objects may be removed.

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

removeEventListener

removeEventListener<T extends keyof Object3DEventMap>(
type: T,
listener: EventListener<Object3DEventMap[T], T, BillboardPlane>,
): 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, BillboardPlane>
  The listener function that gets removed.
Returns void
Inherited from Mesh.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:72

removeFromParent

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

Returns this
Inherited from Mesh.removeFromParent
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:528

rotateOnAxis

rotateOnAxis(axis: Vector3, angle: number): this
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 this
Remarks
The axis is assumed to be normalized.
Inherited from Mesh.rotateOnAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:425

rotateOnWorldAxis

rotateOnWorldAxis(axis: Vector3, angle: number): this
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 this
Remarks
The axis is assumed to be normalized Method Assumes no rotated parent.
Inherited from Mesh.rotateOnWorldAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:434

rotateX

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

rotateY

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

rotateZ

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

setRotationFromAxisAngle

setRotationFromAxisAngle(axis: Vector3, angle: number): 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 Mesh.setRotationFromAxisAngle
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:398

setRotationFromEuler

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

setRotationFromMatrix

setRotationFromMatrix(m: Matrix4): 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 Mesh.setRotationFromMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:411

setRotationFromQuaternion

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

toJSON

toJSON(meta?: JSONMeta): MeshJSON
Convert the object to three.js JSON Object/Scene format.
Parameters
- Optionalmeta: JSONMeta
  Object containing metadata such as materials, textures or images for the object.
Returns MeshJSON
Inherited from Mesh.toJSON
- Defined in node_modules/@types/three/src/objects/Mesh.d.ts:101

translateOnAxis

translateOnAxis(axis: Vector3, distance: number): this
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 this
Remarks
The axis is assumed to be normalized.
Inherited from Mesh.translateOnAxis
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:460

translateX

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

translateY

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

translateZ

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

traverse

traverse(callback: (object: Object3D) => any): void
Executes the callback on this object and all descendants.
Parameters
- callback: (object: Object3D) => any
  A function with as first argument an Object3D object.
Returns void
Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Inherited from Mesh.traverse
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:617

traverseAncestors

traverseAncestors(callback: (object: Object3D) => any): void
Executes the callback on all ancestors.
Parameters
- callback: (object: Object3D) => any
  A function with as first argument an Object3D object.
Returns void
Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Inherited from Mesh.traverseAncestors
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:632

traverseVisible

traverseVisible(callback: (object: Object3D) => any): void
Like traverse, but the callback will only be executed for visible objects
Parameters
- callback: (object: Object3D) => any
  A function with as first argument an Object3D object.
Returns void
Remarks
Descendants of invisible objects are not traversed. Note: Modifying the scene graph inside the callback is discouraged.
Inherited from Mesh.traverseVisible
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:625

updateMatrix

updateMatrix(): void
Updates local transform.

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

updateMatrixWorld

updateMatrixWorld(force?: boolean): 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
- Optionalforce: 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 Mesh.updateMatrixWorld
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:645

updateMorphTargets

updateMorphTargets(): void
Updates the morphTargets to have no influence on the object

Returns void
Remarks
Resets the morphTargetInfluences and morphTargetDictionary properties.
Inherited from Mesh.updateMorphTargets
- Defined in node_modules/@types/three/src/objects/Mesh.d.ts:91

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 Mesh.updateWorldMatrix
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:652

worldToLocal

worldToLocal(vector: Vector3): 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 Mesh.worldToLocal
- Defined in node_modules/@types/three/src/core/Object3D.d.ts:490

Class BillboardPlane

Key Features

When to Use BillboardPlane vs Billboard

Camera Chaser Functionality

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BillboardPlane

Example

Properties

animations

Default Value

cameraChaser

castShadow

Default Value

children

See

Default Value

count

Default

OptionalcustomDepthMaterial

Remarks

Default Value

OptionalcustomDistanceMaterial

Default Value

frustumCulled

Default Value

geometry

Default Value

Readonlyid

Remarks

ReadonlyisMesh

Remarks

Default Value

ReadonlyisObject3D

Remarks

Default Value

layers

Remarks

Default Value

material

Default Value

matrix

Default Value

matrixAutoUpdate

Default Value

matrixWorld

Remarks

Default Value

matrixWorldAutoUpdate

Default Value

matrixWorldNeedsUpdate

Default Value

ReadonlymodelViewMatrix

Default Value

OptionalmorphTargetDictionary

Default Value

OptionalmorphTargetInfluences

Default Value

name

Remarks

Default Value

ReadonlynormalMatrix

Default Value

parent

Remarks

Default Value

Readonlyposition

Default Value

Readonlyquaternion

Default Value

receiveShadow

Default Value

`Optional`customDepthMaterial

`Optional`customDistanceMaterial

`Readonly`id

`Readonly`isMesh

`Readonly`isObject3D

`Readonly`modelViewMatrix

`Optional`morphTargetDictionary

`Optional`morphTargetInfluences

`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