LightProbe (jMonkeyEngine3)

java.lang.Object
- com.jme3.light.Light
- - com.jme3.light.LightProbe

All Implemented Interfaces:

Savable, java.lang.Cloneable
```
public class LightProbe
extends Light
implements Savable
```
A LightProbe is not exactly a light. It holds environment map information used for Image Based Lighting. This is used for indirect lighting in the Physically Based Rendering pipeline. A light probe has a position in world space. This is the position from where the Environment Map are rendered. There are two environment data structure held by the LightProbe : - The irradiance spherical harmonics factors (used for indirect diffuse lighting in the PBR pipeline). - The prefiltered environment map (used for indirect specular lighting and reflection in the PBE pipeline). Note that when instantiating the LightProbe, both of those structures are null. To compute them see LightProbeFactory.makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Spatial) and EnvironmentCamera. The light probe has an area of effect centered on its position. It can have a Spherical area or an Oriented Box area A LightProbe will only be taken into account when it's marked as ready and enabled. A light probe is ready when it has valid environment map data set. Note that you should never call setReady yourself.

See Also:

LightProbeFactory, EnvironmentCamera

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LightProbe.AreaType
- Nested classes/interfaces inherited from class com.jme3.light.Light
  Light.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`LightProbe.AreaType`

Field Summary

Fields
Modifier and Type Field and Description

static Matrix4f FALLBACK_MATRIX
- Fields inherited from class com.jme3.light.Light
  color, enabled, lastDistance, name

Fields
Modifier and Type	Field and Description
`static Matrix4f`	`FALLBACK_MATRIX`

Constructor Summary

Constructors
Constructor and Description

LightProbe()
Empty constructor used for serialization.

Constructors
Constructor and Description
`LightProbe()` Empty constructor used for serialization.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`computeLastDistance(Spatial owner)` Used internally to compute the last distance value.
`ProbeArea`	`getArea()`
`LightProbe.AreaType`	`getAreaType()`
`BoundingVolume`	`getBounds()` Deprecated. use `getArea()`
`int`	`getNbMipMaps()`
`Vector3f`	`getPosition()` Returns the position of the LightProbe in world space
`TextureCubeMap`	`getPrefilteredEnvMap()` returns the prefiltered environment map texture of this light probe Note that this Texture may not have image data yet if the LightProbe is not ready
`Vector3f[]`	`getShCoeffs()`
`Light.Type`	`getType()` Returns the light type
`Matrix4f`	`getUniformMatrix()` Returns the data to send to the shader.
`boolean`	`intersectsBox(BoundingBox box, TempVars vars)` Determines if the light intersects with the given bounding box.
`boolean`	`intersectsFrustum(Camera camera, TempVars vars)` Determines if the light intersects with the given camera frustum.
`boolean`	`intersectsSphere(BoundingSphere sphere, TempVars vars)` Determines if the light intersects with the given bounding sphere.
`boolean`	`isReady()` return true if the LightProbe is ready, meaning the Environment maps have been loaded or rnedered and are ready to be used by a material
`void`	`read(JmeImporter im)`
`void`	`setAreaType(LightProbe.AreaType type)`
`void`	`setBounds(BoundingVolume bounds)` Deprecated.
`void`	`setNbMipMaps(int nbMipMaps)`
`void`	`setPosition(Vector3f position)` Sets the position of the LightProbe in world space
`void`	`setPrefilteredMap(TextureCubeMap prefileteredEnvMap)` Sets the prefiltered environment map
`void`	`setReady(boolean ready)` Don't call this method directly.
`void`	`setShCoeffs(Vector3f[] shCoeffs)`
`java.lang.String`	`toString()`
`void`	`write(JmeExporter ex)`

Methods inherited from class com.jme3.light.Light
clone, getColor, getName, isEnabled, isFrustumCheckNeeded, isIntersectsFrustum, setColor, setEnabled, setFrustumCheckNeeded, setIntersectsFrustum, setName

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FALLBACK_MATRIX
```
public static final Matrix4f FALLBACK_MATRIX
```
- Constructor Detail
  - LightProbe
```
public LightProbe()
```
    Empty constructor used for serialization. You should never call it, use LightProbeFactory.makeProbe(com.jme3.environment.EnvironmentCamera, com.jme3.scene.Spatial) instead.
- Method Detail
  - getPrefilteredEnvMap
```
public TextureCubeMap getPrefilteredEnvMap()
```
    returns the prefiltered environment map texture of this light probe Note that this Texture may not have image data yet if the LightProbe is not ready
    
    Returns:
    
    the prefiltered environment map
  - setPrefilteredMap
```
public void setPrefilteredMap(TextureCubeMap prefileteredEnvMap)
```
    Sets the prefiltered environment map
    
    Parameters:
    
    prefileteredEnvMap - the prefiltered environment map
  - getUniformMatrix
```
public Matrix4f getUniformMatrix()
```
    Returns the data to send to the shader. This is a column major matrix that is not a classic transform matrix, it's laid out in a particular way // 3x3 rot mat| // 0 1 2 | 3 // 0 | ax bx cx | px | ) // 1 | ay by cy | py | probe position // 2 | az bz cz | pz | ) // --|----------| // 3 | sx sy sz sp | 1/probe radius + nbMipMaps // --scale--
    (ax, ay, az) is the pitch rotation axis (bx, by, bz) is the yaw rotation axis (cx, cy, cz) is the roll rotation axis Like in a standard 3x3 rotation matrix. It's also the valid rotation matrix of the probe in world space. Note that for the Spherical Probe area this part is a 3x3 identity matrix.
    (px, py, pz) is the position of the center of the probe in world space Like in a valid 4x4 transform matrix.
    (sx, sy, sy) is the extent of the probe ( the scale ) In a standard transform matrix the scale is applied to the rotation matrix part. In the shader we need the rotation and the scale to be separated, doing this avoid to extract the scale from a classic transform matrix in the shader
    (sp) is a special entry, it contains the packed number of mip maps of the probe and the inverse radius for the probe. since the inverse radius in lower than 1, it's packed in the decimal part of the float. The number of mip maps is packed in the integer part of the float. (ie: for 6 mip maps and a radius of 3, sp= 6.3333333)
    The radius is obvious for a SphereProbeArea, but in the case of a OrientedBoxProbeArea it's the max of the extent vector's components.
    
    Returns:
    
    the pre-existing matrix
  - write
```
public void write(JmeExporter ex)
           throws java.io.IOException
```
    Specified by:
    
    write in interface Savable
    
    Overrides:
    
    write in class Light
    
    Throws:
    
    java.io.IOException
  - read
```
public void read(JmeImporter im)
          throws java.io.IOException
```
    Specified by:
    
    read in interface Savable
    
    Overrides:
    
    read in class Light
    
    Throws:
    
    java.io.IOException
  - getBounds
```
@Deprecated
public BoundingVolume getBounds()
```
    Deprecated. use getArea()
    
    returns the bounding volume of this LightProbe
    
    Returns:
    
    a bounding volume.
  - setBounds
```
@Deprecated
public void setBounds(BoundingVolume bounds)
```
    Deprecated.
    
    Sets the bounds of this LightProbe Note that for now only BoundingSphere is supported and this method will throw an UnsupportedOperationException with any other BoundingVolume type
    
    Parameters:
    
    bounds - the bounds of the LightProbe
  - getArea
```
public ProbeArea getArea()
```
  - setAreaType
```
public void setAreaType(LightProbe.AreaType type)
```
  - getAreaType
```
public LightProbe.AreaType getAreaType()
```
  - isReady
```
public boolean isReady()
```
    return true if the LightProbe is ready, meaning the Environment maps have been loaded or rnedered and are ready to be used by a material
    
    Returns:
    
    the LightProbe ready state
  - setReady
```
public void setReady(boolean ready)
```
    Don't call this method directly. It's meant to be called by additional systems that will load or render the Environment maps of the LightProbe
    
    Parameters:
    
    ready - the ready state of the LightProbe.
  - getShCoeffs
```
public Vector3f[] getShCoeffs()
```
  - setShCoeffs
```
public void setShCoeffs(Vector3f[] shCoeffs)
```
  - getPosition
```
public Vector3f getPosition()
```
    Returns the position of the LightProbe in world space
    
    Returns:
    
    the wolrd space position
  - setPosition
```
public void setPosition(Vector3f position)
```
    Sets the position of the LightProbe in world space
    
    Parameters:
    
    position - the wolrd space position
  - getNbMipMaps
```
public int getNbMipMaps()
```
  - setNbMipMaps
```
public void setNbMipMaps(int nbMipMaps)
```
  - intersectsBox
```
public boolean intersectsBox(BoundingBox box,
                             TempVars vars)
```
    Description copied from class: Light
    
    Determines if the light intersects with the given bounding box.
    For non-local lights, such as directional lights, ambient lights, or point lights without influence radius, this method should always return true.
    
    Specified by:
    
    intersectsBox in class Light
    
    Parameters:
    
    box - The box to check intersection against.
    
    vars - TempVars in case it is needed.
    
    Returns:
    
    True if the light intersects the box, false otherwise.
  - intersectsFrustum
```
public boolean intersectsFrustum(Camera camera,
                                 TempVars vars)
```
    Description copied from class: Light
    
    Determines if the light intersects with the given camera frustum. For non-local lights, such as directional lights, ambient lights, or point lights without influence radius, this method should always return true.
    
    Specified by:
    
    intersectsFrustum in class Light
    
    Parameters:
    
    camera - The camera frustum to check intersection against.
    
    vars - TempVars in case it is needed.
    
    Returns:
    
    True if the light intersects the frustum, false otherwise.
  - intersectsSphere
```
public boolean intersectsSphere(BoundingSphere sphere,
                                TempVars vars)
```
    Description copied from class: Light
    
    Determines if the light intersects with the given bounding sphere.
    For non-local lights, such as directional lights, ambient lights, or point lights without influence radius, this method should always return true.
    
    Specified by:
    
    intersectsSphere in class Light
    
    Parameters:
    
    sphere - The sphere to check intersection against.
    
    vars - TempVars in case it is needed.
    
    Returns:
    
    True if the light intersects the sphere, false otherwise.
  - computeLastDistance
```
protected void computeLastDistance(Spatial owner)
```
    Description copied from class: Light
    
    Used internally to compute the last distance value.
    
    Specified by:
    
    computeLastDistance in class Light
    
    Parameters:
    
    owner - the Spatial whose distance is to be determined
  - getType
```
public Light.Type getType()
```
    Description copied from class: Light
    
    Returns the light type
    
    Specified by:
    
    getType in class Light
    
    Returns:
    
    the light type
    
    See Also:
    
    Light.Type
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class LightProbe

Nested Class Summary

Nested classes/interfaces inherited from class com.jme3.light.Light

Field Summary

Fields inherited from class com.jme3.light.Light

Constructor Summary

Method Summary

Methods inherited from class com.jme3.light.Light

Methods inherited from class java.lang.Object

Field Detail

FALLBACK_MATRIX

Constructor Detail

LightProbe

Method Detail

getPrefilteredEnvMap

setPrefilteredMap

getUniformMatrix

write

read

getBounds

setBounds

getArea

setAreaType

getAreaType

isReady

setReady

getShCoeffs

setShCoeffs

getPosition

setPosition

getNbMipMaps

setNbMipMaps

intersectsBox

intersectsFrustum

intersectsSphere

computeLastDistance

getType

toString