Skip to main content

Class: Shadow

A shadow that is just a circle underneath an object that scales smaller with distance. Shadows ignore fluids.

Hierarchy​

  • Mesh

    ↳ Shadow

Constructors​

constructor​

• new Shadow(world, options?): Shadow

Create a shadow instance.

Parameters​

NameTypeDescription
worldWorld<any>The world to cast shadows in.
optionsPartial<ShadowOptions>The options of the shadow.

Returns​

Shadow

Overrides​

Mesh.constructor

Properties​

GEOMETRY​

▪ Static Readonly GEOMETRY: CircleGeometry

The shared geometry for all shadows.

MATERIAL​

▪ Static Readonly MATERIAL: MeshBasicMaterial

The shared material for all shadows.

Y_OFFSET​

▪ Static Readonly Y_OFFSET: 0.01

The y-offset of the shadow from the ground.

options​

• options: ShadowOptions

The options of the shadow.

world​

• world: World<any>

The world to cast shadows in.

Methods​

update​

▸ update(): void

This raycasts from the shadow's parent to the ground and determines the shadow's scale by the distance.

Returns​

void