Aviatrix3D
2.1.0

org.j3d.aviatrix3d
Class Scene

java.lang.Object
  extended by org.j3d.aviatrix3d.SceneGraphObject
      extended by org.j3d.aviatrix3d.Scene
Direct Known Subclasses:
MultipassScene, Scene2D, SimpleScene

public abstract class Scene
extends SceneGraphObject

Representation of the top level structure of a piece of scene graph that can form a coherent rendering.

A scene encapsulates a viewpoint that is used to view the scene from, the geometry structure to render, data defining the view environment (eg projection type) and global data, such as the background, global fog etc.

A scene may also provide an instance RenderEffectsProcessor that allows the user to provide pre or post processing effects on a per-scene basis. Note that if you are running layers, this will be pre and post processing per layer, not per final rendering. The processor allows a limited form of immediate-mode rendering.

Version:
$Revision: 1.14 $
Author:
Justin Couch

Field Summary
protected  RenderEffectsProcessor processor
          Current effects processor
protected  ViewEnvironment viewEnvironment
          Current view environment
 
Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject
alive, LISTENER_SET_TIMING_ERR_PROP, updateHandler
 
Constructor Summary
Scene()
          Create a default instance of this scene with no content provided.
 
Method Summary
 RenderEffectsProcessor getRenderEffectsProcessor()
          Get the currently set scene processor instance.
 ViewEnvironment getViewEnvironment()
          Get the currently set active view.
protected  void setLive(boolean state)
          Notification that this object is live now.
 void setRenderEffectsProcessor(RenderEffectsProcessor prc)
          Register the scene processor to be used for this scene for pre and post rendering effects.
protected  void setUpdateHandler(NodeUpdateHandler handler)
          Set the scenegraph update handler for this node.
 
Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject
checkForCyclicChild, checkForCyclicParent, dataChanged, getAppUpdateWriteTimingMessage, getBoundsWriteTimingMessage, getDataWriteTimingMessage, getUserData, isLive, setUserData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

viewEnvironment

protected ViewEnvironment viewEnvironment
Current view environment


processor

protected RenderEffectsProcessor processor
Current effects processor

Constructor Detail

Scene

public Scene()
Create a default instance of this scene with no content provided.

Method Detail

setLive

protected void setLive(boolean state)
Notification that this object is live now. Overridden to make sure that the live state of the nodes represents the same state as the parent scene graph.

Overrides:
setLive in class SceneGraphObject
Parameters:
state - true if this should be marked as live now

setUpdateHandler

protected void setUpdateHandler(NodeUpdateHandler handler)
Set the scenegraph update handler for this node. It will notify all its children of the value. A null value will clear the current handler.

Overrides:
setUpdateHandler in class SceneGraphObject
Parameters:
handler - The instance to use as a handler

setRenderEffectsProcessor

public void setRenderEffectsProcessor(RenderEffectsProcessor prc)
                               throws InvalidWriteTimingException
Register the scene processor to be used for this scene for pre and post rendering effects. Setting a null value will clear the current instance.

Parameters:
prc - The instance to use or null
Throws:
InvalidWriteTimingException - An attempt was made to write outside of the ApplicationUpdateObserver callback method

getRenderEffectsProcessor

public RenderEffectsProcessor getRenderEffectsProcessor()
Get the currently set scene processor instance. If none is set, returns null.

Returns:
The current processor or null

getViewEnvironment

public ViewEnvironment getViewEnvironment()
Get the currently set active view. If none is set, return null.

Returns:
The current view instance or null

Aviatrix3D
2.1.0

Latest Info from http://aviatrix3d.j3d.org/
Copyright © 2003 - 2009 j3d.org