PlaneReflectionProbe - Verge3D User Manual - Soft8Soft
Description: Learn how to use PlaneReflectionProbe in your interactive 3D apps made with Verge3D

Object3D →

# PlaneReflectionProbe

A light probe that applies planar reflections to the near objects, like a mirror.

## Code Example

`const probe = new v3d.PlaneReflectionProbe(); probe.update(scene, camera, renderer); app.scene.add(probe);`

## Constructor

### PlaneReflectionProbe()

Creates a new PlaneReflectionProbe.

## Properties

See the base Object3D class for inherited properties.

### # .influenceDistance : Float

Controls how big is the distance of influence. Default is `1`.

### # .falloff : Float

Plane influence falloff factor. Default is `0.5`.

### # .matrixWorldInverse : Matrix4

The inverse of matrixWorld.

### # .probeClipStart : Float

Objects located closer than this value won't appear on the probe's map. Default is `0.1`.

### # .renderTarget : WebGLRenderTarget

A WebGLRenderTarget instance containing the rendered environment map. Default is `null`. Updated automatically after calling the .update method.

### # .type : String

A string `"PlaneReflectionProbe"`. This can be used to find all PlaneReflectionProbe objects. Shouldn't be changed.

### # .visibilityGroup : String

If not `null`, only objects from this group are rendered into the plane map (see also Object3D.groupNames). Default is `null`, which means no visibility group is used and the probe renders all scene objects.

### # .visibilityGroupInv : Boolean

If .visibilityGroup is not `null` this option (if `true`) makes it so only objects that don't belong to the specified .visibilityGroup are rendered into the environment map. Default is `false`.

## Methods

See the base Object3D class for inherited methods.

### # .dispose()

Remove resources related to the render targets used by this object from memory.

### # .intersectsMesh(mesh : Mesh) → Boolean

mesh — a Mesh object to test intersections with.

Check if there's any intersection between the probe's influence volume (see .influenceDistance) and the given mesh object. Returns the checking result.

### # .setSize(size : Integer)

size — new map size.

Set the plane map size.

### # .update(scene : Scene, camera : Camera, renderer : WebGLRenderer)

- scene — a scene to render.
- camera — a camera to render.
- renderer — a WebGLRenderer instance.

Render the given scene into the probe's map. The rendering result will be in the .renderTarget property.

## Source

For more info on how to obtain the source code of this module see this page.