<–Home

class ProbeGrid

An uniform grid of light-probes.

class ProbeGrid extends IndirectLight

Inheritance IndirectLight –> ProbeGrid

Name	Description
Constructors
ProbeGrid()	Creates a new ProbeGrid.
Properties
coverageMin	minimum position of the grid coverage
coverageMax	maximum position of the grid coverage
divisions	number of divisions along each axis
ypower	a distribution bending factor along y-axis
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
getDivisions	Get the number of divisions along each axis
setDivisions	Set the number of divisions along each axis

Constructors

ProbeGrid()

ProbeGrid()

Creates a new ProbeGrid.

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.

divisions

.divisions: Object

The number of divisions along each axis.

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

ypower

.ypower: Number

A distribution bending factor along y-axis.

Readable and writable. Default value is 1.0.

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.

getDivisions()

.getDivisions(divisions: Vector3) : Vector3

Copy the value of .divisions into divisions.

setDivisions()

.setDivisions(divisions: Vector3): undefined

Set the value of .divisions according to divisions.