|
j3d.org Aviatrix3D | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.j3d.aviatrix3d.SceneGraphObject
org.j3d.aviatrix3d.Scene
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.
Field Summary |
Fields inherited from class org.j3d.aviatrix3d.SceneGraphObject |
alive, updateHandler, WRITE_TIMING_MSG |
Constructor Summary | |
Scene()
Create a default instance of this scene with no content provided. |
Method Summary | |
Background |
getActiveBackground()
Get the currently set active view. |
Fog |
getActiveFog()
Get the currently set active view. |
Viewpoint |
getActiveView()
Get the currently set active view. |
Group |
getRenderedGeometry()
Get the root of the currently rendered scene. |
RenderEffectsProcessor |
getRenderEffectsProcessor()
Get the currently set scene processor instance. |
java.lang.Object |
getUserData()
Get the currently set instance of user data. |
ViewEnvironment |
getViewEnvironment()
Get the currently set active view. |
void |
setActiveBackground(Background bg)
Set the background path that should be applied to the current surface. |
void |
setActiveFog(Fog fog)
Set the fog that should be applied to the current surface. |
void |
setActiveView(Viewpoint vp)
Set the viewpoint path that should be applied to the current surface. |
protected void |
setLive(boolean state)
Notification that this object is live now. |
void |
setRenderedGeometry(Group geom)
Set the collection of geometry that should be rendered to this texture. |
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. |
void |
setUserData(java.lang.Object data)
Assign some arbitrary piece of user data to this scene. |
void |
setViewEnvironment(ViewEnvironment env)
Set the view environment that is used to render this surface. |
Methods inherited from class org.j3d.aviatrix3d.SceneGraphObject |
checkForCyclicChild, checkForCyclicParent, dataChanged, isLive |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Scene()
Method Detail |
protected void setLive(boolean state)
setLive
in class SceneGraphObject
state
- true if this should be marked as live nowprotected void setUpdateHandler(NodeUpdateHandler handler)
setUpdateHandler
in class SceneGraphObject
handler
- The instance to use as a handlerpublic void setRenderEffectsProcessor(RenderEffectsProcessor prc) throws InvalidWriteTimingException
prc
- The instance to use or null
InvalidWriteTimingException
- An attempt was made to write outside
of the ApplicationUpdateObserver callback methodpublic RenderEffectsProcessor getRenderEffectsProcessor()
public void setUserData(java.lang.Object data)
setUserData
in class SceneGraphObject
data
- some arbitrary data the user wants to providepublic java.lang.Object getUserData()
getUserData
in class SceneGraphObject
public void setRenderedGeometry(Group geom) throws InvalidWriteTimingException
geom
- The new geometry to use or null
InvalidWriteTimingException
- An attempt was made to write outside
of the ApplicationUpdateObserver callback methodpublic Group getRenderedGeometry()
public void setActiveView(Viewpoint vp) throws InvalidWriteTimingException, java.lang.IllegalArgumentException
vp
- The instance of the active viewpoint to use
java.lang.IllegalArgumentException
- The path contains a SharedGroup or
the node is not live
InvalidWriteTimingException
- An attempt was made to write outside
of the ApplicationUpdateObserver callback methodpublic Viewpoint getActiveView()
public void setActiveFog(Fog fog) throws InvalidWriteTimingException, java.lang.IllegalArgumentException
fog
- The instance of the active fog node
java.lang.IllegalArgumentException
- The path contains a SharedGroup or
the node is not live
InvalidWriteTimingException
- An attempt was made to write outside
of the ApplicationUpdateObserver callback methodpublic Fog getActiveFog()
public void setActiveBackground(Background bg) throws InvalidWriteTimingException, java.lang.IllegalArgumentException
bg
- The instance of the active background
java.lang.IllegalArgumentException
- The path contains a SharedGroup or
the node is not live
InvalidWriteTimingException
- An attempt was made to write outside
of the ApplicationUpdateObserver callback methodpublic Background getActiveBackground()
public void setViewEnvironment(ViewEnvironment env) throws InvalidWriteTimingException, java.lang.IllegalArgumentException
env
- The environment instance to use for the render setup
InvalidWriteTimingException
- An attempt was made to write outside
of the ApplicationUpdateObserver callback method
java.lang.IllegalArgumentException
public ViewEnvironment getViewEnvironment()
|
j3d.org Aviatrix3D | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |