com.eteks.sweethome3d.j3d

Class PhotoRenderer

java.lang.Object

com.eteks.sweethome3d.j3d.AbstractPhotoRenderer

com.eteks.sweethome3d.j3d.PhotoRenderer

public class PhotoRenderer
extends AbstractPhotoRenderer

A renderer able to create a photo realistic image of a home based on SunFlow rendering engine.

Author:

Emmanuel Puybaret

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhotoRenderer.Quality Deprecated. From version 7.0, prefer use AbstractPhotoRenderer.Quality enum.
static class	PhotoRenderer.SphereLightWithNoRepresentation A SunFlow sphere light with no representation.
static class	PhotoRenderer.TriangleMeshLightWithNoRepresentation A SunFlow triangle mesh light with no representation.

Constructor Summary

Constructors

Constructor and Description
PhotoRenderer(Home home, AbstractPhotoRenderer.Quality quality) Creates an instance ready to render the scene matching the given home.
PhotoRenderer(Home home, Object3DFactory object3dFactory, AbstractPhotoRenderer.Quality quality) Creates an instance ready to render the scene matching the given home.
PhotoRenderer(Home home, Object3DFactory object3dFactory, PhotoRenderer.Quality quality) Deprecated. From version 7.0, prefer use the constructor with the parameter of AbstractPhotoRenderer.Quality type.
PhotoRenderer(Home home, PhotoRenderer.Quality quality) Deprecated. From version 7.0, prefer use the constructor with the parameter of AbstractPhotoRenderer.Quality type.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes temporary data that may be required to run this renderer.
java.lang.String	getName()
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.
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.
void	stop() Stops the rendering process.

Methods inherited from class com.eteks.sweethome3d.j3d.AbstractPhotoRenderer

createInstance, getAvailableRenderers, getHome, getQuality, getRenderingParameterValue, isAvailable

Methods inherited from class java.lang.Object

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

Constructor Detail

PhotoRenderer

public PhotoRenderer(Home home,
                     PhotoRenderer.Quality quality)
              throws java.io.IOException

Deprecated. From version 7.0, prefer use the constructor with the parameter of AbstractPhotoRenderer.Quality type.

Creates an instance ready to render the scene matching the given home.

Throws:

java.io.IOException - if texture image files required in the scene couldn't be created.

PhotoRenderer

public PhotoRenderer(Home home,
                     AbstractPhotoRenderer.Quality quality)
              throws java.io.IOException

Creates an instance ready to render the scene matching the given home.

Throws:

java.io.IOException - if texture image files required in the scene couldn't be created.

PhotoRenderer

public PhotoRenderer(Home home,
                     Object3DFactory object3dFactory,
                     PhotoRenderer.Quality quality)
              throws java.io.IOException

Deprecated. From version 7.0, prefer use the constructor with the parameter of AbstractPhotoRenderer.Quality type.

Creates an instance ready to render the scene matching the given home.

Parameters:

home - the home to render

object3dFactory - a factory able to create 3D objects from home items. The createObject3D of this factory is expected to return an instance of Node in current implementation.

Throws:

java.io.IOException

PhotoRenderer

public PhotoRenderer(Home home,
                     Object3DFactory object3dFactory,
                     AbstractPhotoRenderer.Quality quality)
              throws java.io.IOException

Creates an instance ready to render the scene matching the given home.

Parameters:

home - the home to render

object3dFactory - a factory able to create 3D objects from home items. The createObject3D of this factory is expected to return an instance of Node in current implementation.

Throws:

java.io.IOException

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class AbstractPhotoRenderer

render

public 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. The rendered objects of the home are the same ones since last call to render or construction.

Overrides:

render in class AbstractPhotoRenderer

render

public 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.

Specified by:

render in class AbstractPhotoRenderer

Throws:

java.io.IOException

stop

public void stop()

Stops the rendering process.

Specified by:

stop in class AbstractPhotoRenderer

dispose

public 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.

Specified by:

dispose in class AbstractPhotoRenderer