Three.V8

3D rendering engine using JavaScript as user script.

View on GitHub

<–Home

class LODProbeGrid

A mixed resolution grid of light-probes.

class LODProbeGrid extends IndirectLight

Inheritance IndirectLight –> LODProbeGrid

Name Description
Constructors  
LODProbeGrid() Creates a new LODProbeGrid.
Properties  
coverageMin minimum position of the grid coverage
coverageMax maximum position of the grid coverage
baseDivisions number of divisions of the base-level of the grid
subDivisionLevel number of sub-division levels
numberOfProbes number of probes in the grid
normalBias bias used for sampling visibility information
perPrimitive whether using per-primitive interpolation for better performance
Methods  
getCoverageMin Get the minimum position of the grid coverage
setCoverageMin Set the minimum position of the grid coverage
getCoverageMax Get the maximum position of the grid coverage
setCoverageMax Set the maximum position of the grid coverage
getBaseDivisions Get the number of divisions of the base-level of the grid
setBaseDivisions Set the number of divisions of the base-level of the grid
toProbeGrid Convert to uniform grid

Constructors

LODProbeGrid()

LODProbeGrid()

Creates a new LODProbeGrid.

Properties

coverageMin

.coverageMin: Object

The minimum position of the grid coverage.

Read-only. Use the method .setCoverageMin to modify this property.

coverageMax

.coverageMax: Object

The maximum position of the grid coverage.

Read-only. Use the method .setCoverageMax to modify this property.

baseDivisions

.baseDivisions: Object

The number of divisions of the base-level of the grid.

Read-only. Use the method .setBaseDivisions to modify this property.

subDivisionLevel

.subDivisionLevel: Number

Number of sub-division levels.

Readable and writable. Default value is 2.

numberOfProbes

.numberOfProbes: Number

Number of probes in the grid.

ReadOnly.

normalBias

.normalBias: Number

The bias used for sampling visibility information.

Readable and writable. Default value is 0.2.

perPrimitive

.perPrimitive: Boolean

Whether using per-primitive interpolation for better performance

Readable and writable. Default value is false.

Methods

getCoverageMin()

.getCoverageMin(coverage_min: Vector3) : Vector3

Copy the value of .coverageMin into coverage_min.

setCoverageMin()

.setCoverageMin(coverage_min: Vector3): undefined

Set the value of .coverageMin according to coverage_min.

getCoverageMax()

.getCoverageMax(coverage_max: Vector3) : Vector3

Copy the value of .coverageMax into coverage_max.

setCoverageMax()

.setCoverageMax(coverage_max: Vector3): undefined

Set the value of .coverageMax according to coverage_max.

getBaseDivisions()

.getBaseDivisions(divisions: Vector3) : Vector3

Copy the value of .baseDivisions into divisions.

setBaseDivisions()

.setBaseDivisions(divisions: Vector3): undefined

Set the value of .baseDivisions according to divisions.

toProbeGrid()

.toProbeGrid(scene: Scene) : ProbeGrid

Convert the mixed resoluion grid of light probes to an uniform grid of light probes.

Needs the scene paramter for reconstructing missing visibility information.