Package org.xj3d.ui.awt.browser.ogl

Class ThumbnailRecorder

java.lang.Object

org.xj3d.ui.awt.browser.ogl.ThumbnailRecorder

All Implemented Interfaces:

ScreenCaptureListener, FrameStateListener, VRMLNodeListener

public class ThumbnailRecorder
extends Object
implements ScreenCaptureListener, VRMLNodeListener, FrameStateListener

A function module that performs an image capture of an X3D scene for the purpose of creating a thumbnail image. The requirements of the X3D world are:

• Optionally there may be a DEF'ed Viewpoint with a known DEF name.
• By default the Viewpoint's DEF name is "ICON_VIEWPOINT". The Viewpoint's DEF name is programmatically configurable in this module.
• In the absence of a DEF'ed Viewpoint, the default viewpoint will be captured.

The image capture is managed as follows:

• On the completion of the world and content loading, the DEF'ed Viewpoint node is searched for and bound if necessary.
• The image capture is initiated immediately if the DEF'd Viewpoint is not found, or the DEF'ed Viewpoint is found and currently bound.
• Otherwise, the capture is initiated immediately upon notification that the DEF'd Viewpoint has been bound.

Version:

$Revision: 1.8 $

Author:

Rex Melton

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	addNodes	Flag used in the end of frame listener, indicating that the new nodes may be added to the scene
protected String[]	alphaTypes	Image encoding types that may have an alpha
protected Object	canvas	The rendering surface
protected boolean	configComplete	Synchronization flag
protected OGLConstruct	construct	The construct instance to record from
protected OGLStandardBrowserCore	core	The browser core
protected org.j3d.util.ErrorReporter	errorReporter	The error reporting mechanism
protected long	fileTime	The total file write time
protected FrameStateManager	fsm	The frame state manager
protected boolean	hasAlpha	Flag indicating that the selected encoding type may have an alpha
protected boolean	headlight	Should the headlight be on
protected int	height	The height of the output images
protected int	imageARGB
protected int	isBound_index	The index of the viewpoint's isBound field.
protected RecorderListener	listener	Listener for recorder status events
protected OGLNavigationInfo	navInfo	The viewpoint
protected int	number	The sequence capture number, somewhat unnecessary as in this application, it only ever reaches one (1)
protected File	outputFile	The output file for the captured images
protected boolean	postProcess	Flag indicating that the image capture should be post processed
protected long	renderTime	The total frame rendering time
protected boolean	replaceNavInfo	Should the navigation info be replaced to use the headlight value
protected VRMLWorldRootNodeType	root	The scene root, parent for the nav info and viewpoint nodes
protected int	snapRGB	RGB value for snap pixels that should be replaced
protected long	startFrameTime	The last start of frame rendering time
protected String	type	The image encoding type
protected BaseViewpoint	viewpoint	The viewpoint node, used when we have to wait for the named viewpoint to be bound
protected String	viewpointName	The name of the x3d viewpoint to capture.
protected int	width	The width of the output images

Constructor Summary

Constructors

Constructor	Description
ThumbnailRecorder(OGLConstruct construct, boolean replaceNavInfo, boolean headlight)	Constructor

Method Summary

Modifier and Type	Method	Description
void	allEventsComplete()	Notification that the rendering of the event model is complete and that rendering is about to begin.
void	fieldChanged(int index)	Notification that the field represented by the given index has changed.
double	getFileTime()	Return the file write time in milliseconds
double	getRenderTime()	Return the frame rendering time in milliseconds
void	saveScreen(Buffer buffer, int width, int height)	Process the screen capture buffer into a BufferedImage and save it to a file
void	screenCaptured(Buffer buffer, int width, int height)	Notification of a new screen capture.
void	setBackgroundColor(Color x3dBackgroundColor, Color imageBackgroundColor)	Set the background color for the image.
boolean	setEncoding(String type)	Set the image encoding type
boolean	setOutputFile(File file)	Set the output file for the image
void	setSize(int width, int height)	Set the image size
void	setViewpointName(String name)	Set the DEF'ed name of the Viewpoint
void	start(RecorderListener listener)	Initiate the capture

Methods inherited from class java.lang.Object

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

Field Details

construct

protected OGLConstruct construct

The construct instance to record from

core

protected OGLStandardBrowserCore core

The browser core

errorReporter

protected org.j3d.util.ErrorReporter errorReporter

The error reporting mechanism

canvas

protected Object canvas

The rendering surface

navInfo

protected OGLNavigationInfo navInfo

The viewpoint

root

protected VRMLWorldRootNodeType root

The scene root, parent for the nav info and viewpoint nodes

addNodes

protected boolean addNodes

Flag used in the end of frame listener, indicating that the new nodes may be added to the scene

fsm

protected FrameStateManager fsm

The frame state manager

configComplete

protected boolean configComplete

Synchronization flag

number

protected int number

The sequence capture number, somewhat unnecessary as in this application, it only ever reaches one (1)

viewpointName

protected String viewpointName

The name of the x3d viewpoint to capture. Default value is "ICON_VIEWPOINT"

viewpoint

protected BaseViewpoint viewpoint

The viewpoint node, used when we have to wait for the named viewpoint to be bound

isBound_index

protected int isBound_index

The index of the viewpoint's isBound field.

outputFile

protected File outputFile

The output file for the captured images

listener

protected RecorderListener listener

Listener for recorder status events

replaceNavInfo

protected boolean replaceNavInfo

Should the navigation info be replaced to use the headlight value

headlight

protected boolean headlight

Should the headlight be on

width

protected int width

The width of the output images

height

protected int height

The height of the output images

type

protected String type

The image encoding type

hasAlpha

protected boolean hasAlpha

Flag indicating that the selected encoding type may have an alpha

alphaTypes

protected String[] alphaTypes

Image encoding types that may have an alpha

fileTime

protected long fileTime

The total file write time

renderTime

protected long renderTime

The total frame rendering time

startFrameTime

protected long startFrameTime

The last start of frame rendering time

postProcess

protected boolean postProcess

Flag indicating that the image capture should be post processed

snapRGB

protected int snapRGB

RGB value for snap pixels that should be replaced

imageARGB

protected int imageARGB

Constructor Details

ThumbnailRecorder

public ThumbnailRecorder(OGLConstruct construct,
 boolean replaceNavInfo,
 boolean headlight)

Constructor

Parameters:

construct - The construct instance to record from

replaceNavInfo - Should the navigationInfo be replaced

headlight - Should the headlight be on

Method Details

screenCaptured

public void screenCaptured(Buffer buffer,
 int width,
 int height)

Notification of a new screen capture. The buffer will be in openGL pixel order.

Specified by:

screenCaptured in interface ScreenCaptureListener

Parameters:

buffer - The screen capture

width - The width in pixels of the captured screen

height - The height in pixels of the captured screen

fieldChanged

public void fieldChanged(int index)

Description copied from interface: VRMLNodeListener

Notification that the field represented by the given index has changed.

Specified by:

fieldChanged in interface VRMLNodeListener

Parameters:

index - The index of the field that has changed

allEventsComplete

public void allEventsComplete()

Description copied from interface: FrameStateListener

Notification that the rendering of the event model is complete and that rendering is about to begin. If the node needs to update itself for this frame, it should do so now before the render pass takes place.

Specified by:

allEventsComplete in interface FrameStateListener

getRenderTime

public double getRenderTime()

Return the frame rendering time in milliseconds

Returns:

the frame rendering time in milliseconds

getFileTime

public double getFileTime()

Return the file write time in milliseconds

Returns:

the file write time in milliseconds

setEncoding

public boolean setEncoding(String type)

Set the image encoding type

Parameters:

type - The image encoding type

Returns:

true if the encoding type is valid, false otherwise.

setSize

public void setSize(int width,
 int height)

Set the image size

Parameters:

width - The image width

height - The image height

setBackgroundColor

public void setBackgroundColor(Color x3dBackgroundColor,
 Color imageBackgroundColor)

Set the background color for the image.

Parameters:

x3dBackgroundColor - The background color of the X3D model to replace with the image background color. If null, the image background will not be changed from the capture.

imageBackgroundColor - The color to set for the image background. If null, the image background will not be changed from the capture.

setOutputFile

public boolean setOutputFile(File file)

Set the output file for the image

Parameters:

file - The output file for the image

Returns:

true if the output file is of a valid encoding type, false otherwise.

setViewpointName

public void setViewpointName(String name)

Set the DEF'ed name of the Viewpoint

Parameters:

name - The DEF'ed name of the Viewpoint

start

public void start(RecorderListener listener)

Initiate the capture

Parameters:

listener -

saveScreen

public void saveScreen(Buffer buffer,
 int width,
 int height)

Process the screen capture buffer into a BufferedImage and save it to a file

Parameters:

buffer - The screen capture buffer

width - The width of the image

height - The height of the image