Package org.xj3d.ui.construct.ogl

Class AutoConfigureViewpoint

java.lang.Object

org.xj3d.ui.construct.ogl.AutoConfigureViewpoint

All Implemented Interfaces:

FrameStateListener

public class AutoConfigureViewpoint
extends Object
implements FrameStateListener

Utility module for the ThumbnailRecorder that will attempt to create a useful default viewpoint of the loaded scene. The generated viewpoint will be along the vector [1, 1, 1] from the center of the scene bounds, at a distance that -should- have the object(s) in the field of view.

Version:

$Revision: 1.10 $

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 boolean	configComplete	Synchronization flag
protected OGLConstruct	construct	The construct
protected OGLStandardBrowserCore	core	The browser core
protected org.j3d.util.ErrorReporter	errorReporter	The error reporting mechanism
protected FrameStateManager	fsm	The frame state manager
protected boolean	headlight	Should the headlight be on
protected OGLNavigationInfo	navInfo	The navigation info
protected VRMLWorldRootNodeType	root	The scene root, parent for the nav info and viewpoint nodes
protected OGLViewpoint	viewpoint	The viewpoint

Constructor Summary

Constructors

Constructor	Description
AutoConfigureViewpoint(OGLConstruct construct, 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.
boolean	configure()	Create and configure a new viewpoint.

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

headlight

protected boolean headlight

Should the headlight be on

core

protected OGLStandardBrowserCore core

The browser core

fsm

protected FrameStateManager fsm

The frame state manager

errorReporter

protected org.j3d.util.ErrorReporter errorReporter

The error reporting mechanism

configComplete

protected boolean configComplete

Synchronization flag

viewpoint

protected OGLViewpoint viewpoint

The viewpoint

navInfo

protected OGLNavigationInfo navInfo

The navigation info

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

Constructor Details

AutoConfigureViewpoint

public AutoConfigureViewpoint(OGLConstruct construct,
 boolean headlight)

Constructor

Parameters:

construct - The construct containing the scene for which to configure a viewpoint.

headlight - Should the headlight be on

Method Details

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

configure

public boolean configure()

Create and configure a new viewpoint. Wait for the node to be added and bound in the scene before returning. If the bounds of the scene could not be determined, no configuration is performed and the method returns immediately.

Returns:

true if the viewpoint was added successfully, false otherwise.