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

Class SceneThumbnailRecorder

java.lang.Object

org.xj3d.ui.awt.browser.ogl.SceneThumbnailRecorder

All Implemented Interfaces:

ScreenCaptureListener, FrameStateListener, VRMLNodeListener

public class SceneThumbnailRecorder
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 for all viewpoints. The image capture is managed as follows:

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

Version:

$Revision: 1.8 $

Author:

Alan Hudson

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 NumberFormat	fmt	Formatter for creating the image sequence identifier
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 File	outputDir	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 VRMLWorldRootNodeType	root	The scene root, parent for the nav info and viewpoint nodes
protected int	sequenceCaptureNumber	The sequence capture number
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 VRMLViewpointNodeType	viewpoint	The viewpoint node, used when we have to wait for the named viewpoint to be bound
protected List<VRMLViewpointNodeType>	viewpoints	The viewpoints left to process
protected int	width	The width of the output images

Constructor Summary

Constructors

Constructor	Description
SceneThumbnailRecorder(OGLConstruct construct)	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	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
void	setFilePrefix(String prefix)	Set the name prefix for images
void	setOutputDirectory(File dir)	Set the output directory for images
void	setSize(int width, int height)	Set the image size
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

sequenceCaptureNumber

protected int sequenceCaptureNumber

The sequence capture number

viewpoint

protected VRMLViewpointNodeType 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.

outputDir

protected File outputDir

The output file for the captured images

listener

protected RecorderListener listener

Listener for recorder status events

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

fmt

protected NumberFormat fmt

Formatter for creating the image sequence identifier

viewpoints

protected List<VRMLViewpointNodeType> viewpoints

The viewpoints left to process

Constructor Details

SceneThumbnailRecorder

public SceneThumbnailRecorder(OGLConstruct construct)

Constructor

Parameters:

construct - The construct instance to record from

Method Details

screenCaptured

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

Description copied from interface: ScreenCaptureListener

Notification of a new screen capture. This 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.

setOutputDirectory

public void setOutputDirectory(File dir)

Set the output directory for images

Parameters:

dir - The output directory for images

setFilePrefix

public void setFilePrefix(String prefix)

Set the name prefix for images

Parameters:

prefix - The prefix for file names

start

public void start(RecorderListener listener)

Initiate the capture

Parameters:

listener -