com.eteks.sweethome3d.j3d

Class AbstractPhotoRenderer

java.lang.Object

com.eteks.sweethome3d.j3d.AbstractPhotoRenderer

Direct Known Subclasses:

PhotoRenderer, YafarayRenderer

public abstract class AbstractPhotoRenderer
extends java.lang.Object

A renderer able to create a photo realistic image of a home.

Author:

Emmanuel Puybaret, Frédéric Mantegazza (Sun location algorithm)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractPhotoRenderer.Quality

Constructor Summary

Constructors

Constructor and Description
AbstractPhotoRenderer(Home home, AbstractPhotoRenderer.Quality quality)

Method Summary

Modifier and Type	Method and Description
static AbstractPhotoRenderer	createInstance(java.lang.String rendererClassName, Home home, Object3DFactory object3dFactory, AbstractPhotoRenderer.Quality quality) Returns an instance of the rendering engine of class renderingEngineClass if available or a default instance of PhotoRenderer class.
abstract void	dispose() Disposes temporary data that may be required to run this renderer.
static java.util.List<java.lang.String>	getAvailableRenderers()
Home	getHome() Returns the rendered home.
abstract java.lang.String	getName()
AbstractPhotoRenderer.Quality	getQuality() Returns the quality used to render a home.
protected java.lang.String	getRenderingParameterValue(java.lang.String parameterName) Returns the value of the given rendering parameter.
boolean	isAvailable() Returns true if this render is able to run in the current environment.
void	render(java.awt.image.BufferedImage image, Camera camera, java.awt.image.ImageObserver observer) Renders home in image at the given camera location and image size.
abstract void	render(java.awt.image.BufferedImage image, Camera camera, java.util.List<? extends Selectable> updatedItems, java.awt.image.ImageObserver observer) Renders home in image at the given camera location and image size.
abstract void	stop() Stops the rendering process.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPhotoRenderer

public AbstractPhotoRenderer(Home home,
                             AbstractPhotoRenderer.Quality quality)

Method Detail

createInstance

public static AbstractPhotoRenderer createInstance(java.lang.String rendererClassName,
                                                   Home home,
                                                   Object3DFactory object3dFactory,
                                                   AbstractPhotoRenderer.Quality quality)

Returns an instance of the rendering engine of class renderingEngineClass if available or a default instance of PhotoRenderer class.

Parameters:

rendererClassName - the name of a renderer class with a constructor taking in parameters home, object3dFactory and quality.

getAvailableRenderers

public static java.util.List<java.lang.String> getAvailableRenderers()

isAvailable

public boolean isAvailable()

Returns true if this render is able to run in the current environment.

getName

public abstract java.lang.String getName()

getHome

public Home getHome()

Returns the rendered home.

getQuality

public AbstractPhotoRenderer.Quality getQuality()

Returns the quality used to render a home.

render

public void render(java.awt.image.BufferedImage image,
                   Camera camera,
                   java.awt.image.ImageObserver observer)
            throws java.io.IOException

Renders home in image at the given camera location and image size. The rendered objects of the home are the same ones since last call to render or construction.

Throws:

java.io.IOException

render

public abstract void render(java.awt.image.BufferedImage image,
                            Camera camera,
                            java.util.List<? extends Selectable> updatedItems,
                            java.awt.image.ImageObserver observer)
                     throws java.io.IOException

Renders home in image at the given camera location and image size. The home objects listed in updatedItems will be updated in the renderer, allowing animations or modifications of their appearance.

Throws:

java.io.IOException

stop

public abstract void stop()

Stops the rendering process.

dispose

public abstract void dispose()

Disposes temporary data that may be required to run this renderer. Trying to use this renderer after a call to this method may lead to errors.

getRenderingParameterValue

protected java.lang.String getRenderingParameterValue(java.lang.String parameterName)

Returns the value of the given rendering parameter.