thothbot.parallax.core.client.renderers

Class WebGLRenderer

java.lang.Object

thothbot.parallax.core.client.renderers.AbstractRenderer

thothbot.parallax.core.client.renderers.WebGLRenderer

All Implemented Interfaces:

HasEventBus

public class WebGLRenderer
extends AbstractRenderer
implements HasEventBus

The WebGL renderer displays your beautifully crafted Scenes using WebGL, if your device supports it.

Field Summary

Fields

Modifier and Type	Field and Description
Frustum	_frustum
boolean	_logarithmicDepthBuffer
Shader.PRECISION	_precision
java.util.Map<java.lang.String,Shader>	_programs
Matrix4	_projScreenMatrix
Matrix4	_projScreenMatrixPS
Vector3	_vector3
java.util.Map<java.lang.String,java.util.List<WebGLObject>>	_webglObjects
java.util.List<WebGLObject>	_webglObjectsImmediate
double	devicePixelRatio
java.util.List<WebGLObject>	opaqueObjects
java.util.List<WebGLObject>	transparentObjects

Fields inherited from interface thothbot.parallax.core.client.events.HasEventBus

EVENT_BUS

Constructor Summary

Constructors

Constructor and Description
WebGLRenderer(WebGLRenderingContext gl, int width, int height) The constructor will create renderer for the Canvas3d widget.

Method Summary

Modifier and Type	Method and Description
double	_devicePixelRatio()
void	addPlugin(Plugin plugin)
void	clear()
void	clear(boolean color, boolean depth, boolean stencil) Tells the renderer to clear its color, depth or stencil drawing buffer(s).
void	clearColor()
void	clearDepth()
void	clearStencil()
void	clearTarget(RenderTargetTexture renderTarget, boolean color, boolean depth, boolean stencil) Clear RenderTargetTexture and GL buffers.
void	deletePlugin(Plugin plugin)
void	enableScissorTest(boolean enable) Enable the scissor test.
Material	getBufferMaterial(GeometryObject object, Geometry geometry)
Material	getBufferMaterial(GeometryObject object, GeometryGroup geometryGroup)
WebGLRenderingContext	getGL() Gets the WebGL context from the Canvas3d widget.
WebGlRendererInfo	getInfo() Gets WebGlRendererInfo instance with debug information.
int	getMaxAnisotropy()
Shader.PRECISION	getPrecision()
int	getTextureUnit()
void	initGeometryGroups(Object3D scene, Mesh object, Geometry geometry)
boolean	isAutoClearColor() Gets setAutoClearColor(boolean) flag.
boolean	isAutoClearDepth() Gets setAutoClearDepth(boolean) flag.
boolean	isAutoClearStencil() Gets setAutoClearStencil(boolean) flag.
boolean	isAutoUpdateObjects() Gets setAutoUpdateObjects(boolean) flag.
boolean	isAutoUpdateScene() Gets setAutoUpdateScene(boolean) flag.
boolean	isGammaInput()
boolean	isGammaOutput()
boolean	isSortObjects() Gets setSortObjects(boolean) flag.
java.util.List<GeometryGroup>	makeGroups(Geometry geometry, boolean usesFaceMaterial)
void	render(Scene scene, Camera camera)
void	render(Scene scene, Camera camera, RenderTargetTexture renderTarget)
void	render(Scene scene, Camera camera, RenderTargetTexture renderTarget, boolean forceClear) Rendering.
void	renderBuffer(Camera camera, java.util.List<Light> lights, AbstractFog fog, Material material, WebGLGeometry geometry, GeometryObject object) Buffer rendering.
void	renderBufferDirect(Camera camera, java.util.List<Light> lights, AbstractFog fog, Material material, BufferGeometry geometry, GeometryObject object)
void	renderBufferImmediate(GeometryObject object, Shader program, Material material)
void	renderImmediateObject(Camera camera, java.util.List<Light> lights, AbstractFog fog, Material material, GeometryObject object)
void	renderObjectsImmediate(java.util.List<WebGLObject> renderList, java.lang.Boolean isTransparentMaterial, Camera camera, java.util.List<Light> lights, AbstractFog fog, boolean useBlending, Material overrideMaterial)
void	resetGLState()
void	setAutoClearColor(boolean isAutoClearColor) Defines whether the renderer should clear the color buffer.
void	setAutoClearDepth(boolean isAutoClearDepth) Defines whether the renderer should clear the depth buffer.
void	setAutoClearStencil(boolean isAutoClearStencil) Defines whether the renderer should clear the stencil buffer.
void	setAutoUpdateObjects(boolean isAutoUpdateObjects) Defines whether the renderer should auto update objects.
void	setAutoUpdateScene(boolean isAutoUpdateScene) Defines whether the renderer should auto update the scene.
void	setBlending(Material.BLENDING blending)
void	setClearColor(Color color, double alpha) Sets the the background color, using Color for the color and alpha for the opacity.
void	setDepthTest(boolean depthTest)
void	setDepthWrite(boolean depthWrite)
void	setGammaInput(boolean isGammaInput)
void	setGammaOutput(boolean isGammaOutput)
void	setMaterialFaces(Material material)
void	setRenderTarget(RenderTargetTexture renderTarget) Setup render target
void	setScissor(int x, int y, int width, int height) Sets the scissor area from (x, y) to (x + absoluteWidth, y + absoluteHeight).
void	setSize(int width, int height) Sets the sizes and also sets setViewport(int, int, int, int) size.
void	setSortObjects(boolean isSortObjects) Defines whether the renderer should sort objects.
void	setTexture(Texture texture, int slot)
void	setViewport(int x, int y, int width, int height) Sets the viewport to render from (X, Y) to (X + absoluteWidth, Y + absoluteHeight).
boolean	supportsBlendMinMax()
boolean	supportsCompressedTexturePVRTC()
boolean	supportsCompressedTextureS3TC()
boolean	supportsFloatTextures()
boolean	supportsStandardDerivatives()
boolean	supportsVertexTextures()
void	updateObject(GeometryObject object, Object3D scene)

Methods inherited from class thothbot.parallax.core.client.renderers.AbstractRenderer

getAbsoluteAspectRation, getAbsoluteHeight, getAbsoluteWidth, getClearAlpha, getClearColor, isAutoClear, setAutoClear, setClearColor, setClearColor, setClearColor

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_webglObjects

public java.util.Map<java.lang.String,java.util.List<WebGLObject>> _webglObjects

_webglObjectsImmediate

public java.util.List<WebGLObject> _webglObjectsImmediate

opaqueObjects

public java.util.List<WebGLObject> opaqueObjects

transparentObjects

public java.util.List<WebGLObject> transparentObjects

devicePixelRatio

public double devicePixelRatio

_logarithmicDepthBuffer

public boolean _logarithmicDepthBuffer

_precision

public Shader.PRECISION _precision

_programs

public java.util.Map<java.lang.String,Shader> _programs

_frustum

public Frustum _frustum

_projScreenMatrix

public Matrix4 _projScreenMatrix

_projScreenMatrixPS

public Matrix4 _projScreenMatrixPS

_vector3

public Vector3 _vector3

Constructor Detail

WebGLRenderer

public WebGLRenderer(WebGLRenderingContext gl,
                     int width,
                     int height)

The constructor will create renderer for the Canvas3d widget.

Parameters:

gl - the WebGLRenderingContext

width - the viewport width

height - the viewport height

Method Detail

_devicePixelRatio

public final double _devicePixelRatio()

addPlugin

public void addPlugin(Plugin plugin)

deletePlugin

public void deletePlugin(Plugin plugin)

supportsVertexTextures

public boolean supportsVertexTextures()

supportsFloatTextures

public boolean supportsFloatTextures()

supportsStandardDerivatives

public boolean supportsStandardDerivatives()

supportsCompressedTextureS3TC

public boolean supportsCompressedTextureS3TC()

supportsCompressedTexturePVRTC

public boolean supportsCompressedTexturePVRTC()

supportsBlendMinMax

public boolean supportsBlendMinMax()

getMaxAnisotropy

public int getMaxAnisotropy()

getPrecision

public Shader.PRECISION getPrecision()

isAutoClearColor

public boolean isAutoClearColor()

Gets setAutoClearColor(boolean) flag.

setAutoClearColor

public void setAutoClearColor(boolean isAutoClearColor)

Defines whether the renderer should clear the color buffer. Default is true.

Parameters:

isAutoClearColor - false or true

isAutoClearDepth

public boolean isAutoClearDepth()

Gets setAutoClearDepth(boolean) flag.

setAutoClearDepth

public void setAutoClearDepth(boolean isAutoClearDepth)

Defines whether the renderer should clear the depth buffer. Default is true.

Parameters:

isAutoClearDepth - false or true

isAutoClearStencil

public boolean isAutoClearStencil()

Gets setAutoClearStencil(boolean) flag.

setAutoClearStencil

public void setAutoClearStencil(boolean isAutoClearStencil)

Defines whether the renderer should clear the stencil buffer. Default is true.

Parameters:

isAutoClearStencil - false or true

isSortObjects

public boolean isSortObjects()

Gets setSortObjects(boolean) flag.

setSortObjects

public void setSortObjects(boolean isSortObjects)

Defines whether the renderer should sort objects. Default is true.

Parameters:

isSortObjects - false or true

isAutoUpdateObjects

public boolean isAutoUpdateObjects()

Gets setAutoUpdateObjects(boolean) flag.

setAutoUpdateObjects

public void setAutoUpdateObjects(boolean isAutoUpdateObjects)

Defines whether the renderer should auto update objects. Default is true.

Parameters:

isAutoUpdateObjects - false or true

isAutoUpdateScene

public boolean isAutoUpdateScene()

Gets setAutoUpdateScene(boolean) flag.

isGammaInput

public boolean isGammaInput()

setGammaInput

public void setGammaInput(boolean isGammaInput)

isGammaOutput

public boolean isGammaOutput()

setGammaOutput

public void setGammaOutput(boolean isGammaOutput)

setAutoUpdateScene

public void setAutoUpdateScene(boolean isAutoUpdateScene)

Defines whether the renderer should auto update the scene. Default is true.

Parameters:

isAutoUpdateScene - false or true

getInfo

public WebGlRendererInfo getInfo()

Gets WebGlRendererInfo instance with debug information.

Returns:

the WebGlRendererInfo instance

getGL

public WebGLRenderingContext getGL()

Gets the WebGL context from the Canvas3d widget.

Returns:

the underlying context implementation for drawing onto the Canvas3d.

setSize

public void setSize(int width,
                    int height)

Sets the sizes and also sets setViewport(int, int, int, int) size.

Overrides:

setSize in class AbstractRenderer

Parameters:

width - the Canvas3d width.

height - the Canvas3d height.

setViewport

public void setViewport(int x,
                        int y,
                        int width,
                        int height)

Sets the viewport to render from (X, Y) to (X + absoluteWidth, Y + absoluteHeight). By default X and Y = 0.

setScissor

public void setScissor(int x,
                       int y,
                       int width,
                       int height)

Sets the scissor area from (x, y) to (x + absoluteWidth, y + absoluteHeight).

enableScissorTest

public void enableScissorTest(boolean enable)

Enable the scissor test. When this is enabled, only the pixels within the defined scissor area will be affected by further renderer actions.

setClearColor

public void setClearColor(Color color,
                          double alpha)

Description copied from class: AbstractRenderer

Sets the the background color, using Color for the color and alpha for the opacity.

Specified by:

setClearColor in class AbstractRenderer

Parameters:

color - the Color instance.

alpha - the opacity of the scene's background color, range 0.0 (invisible) to 1.0 (opaque).

clear

public void clear()

Specified by:

clear in class AbstractRenderer

clear

public void clear(boolean color,
                  boolean depth,
                  boolean stencil)

Tells the renderer to clear its color, depth or stencil drawing buffer(s). If no parameters are passed, no buffer will be cleared.

Parameters:

color - is it should clear color

depth - is it should clear depth

stencil - is it should clear stencil

clearColor

public void clearColor()

clearDepth

public void clearDepth()

clearStencil

public void clearStencil()

clearTarget

public void clearTarget(RenderTargetTexture renderTarget,
                        boolean color,
                        boolean depth,
                        boolean stencil)

Clear RenderTargetTexture and GL buffers.

resetGLState

public void resetGLState()

renderBufferImmediate

public void renderBufferImmediate(GeometryObject object,
                                  Shader program,
                                  Material material)

renderBufferDirect

public void renderBufferDirect(Camera camera,
                               java.util.List<Light> lights,
                               AbstractFog fog,
                               Material material,
                               BufferGeometry geometry,
                               GeometryObject object)

makeGroups

public java.util.List<GeometryGroup> makeGroups(Geometry geometry,
                                                boolean usesFaceMaterial)

initGeometryGroups

public void initGeometryGroups(Object3D scene,
                               Mesh object,
                               Geometry geometry)

getBufferMaterial

public Material getBufferMaterial(GeometryObject object,
                                  GeometryGroup geometryGroup)

getBufferMaterial

public Material getBufferMaterial(GeometryObject object,
                                  Geometry geometry)

updateObject

public void updateObject(GeometryObject object,
                         Object3D scene)

render

public void render(Scene scene,
                   Camera camera)

Specified by:

render in class AbstractRenderer

render

public void render(Scene scene,
                   Camera camera,
                   RenderTargetTexture renderTarget)

render

public void render(Scene scene,
                   Camera camera,
                   RenderTargetTexture renderTarget,
                   boolean forceClear)

Rendering.

Parameters:

scene - the Scene object.

renderTarget - optional

forceClear - optional

renderObjectsImmediate

public void renderObjectsImmediate(java.util.List<WebGLObject> renderList,
                                   java.lang.Boolean isTransparentMaterial,
                                   Camera camera,
                                   java.util.List<Light> lights,
                                   AbstractFog fog,
                                   boolean useBlending,
                                   Material overrideMaterial)

renderImmediateObject

public void renderImmediateObject(Camera camera,
                                  java.util.List<Light> lights,
                                  AbstractFog fog,
                                  Material material,
                                  GeometryObject object)

renderBuffer

public void renderBuffer(Camera camera,
                         java.util.List<Light> lights,
                         AbstractFog fog,
                         Material material,
                         WebGLGeometry geometry,
                         GeometryObject object)

Buffer rendering. Render GeometryObject with material.

getTextureUnit

public int getTextureUnit()

setMaterialFaces

public void setMaterialFaces(Material material)

setDepthTest

public void setDepthTest(boolean depthTest)

setDepthWrite

public void setDepthWrite(boolean depthWrite)

setBlending

public void setBlending(Material.BLENDING blending)

setTexture

public void setTexture(Texture texture,
                       int slot)

setRenderTarget

public void setRenderTarget(RenderTargetTexture renderTarget)

Setup render target

Parameters:

renderTarget - the render target