|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Renderer
The Renderer interface defines the methods for rendering a scene. Call renderScene() to render an image, and cancelRendering() to stop a render that is in progress.
Renderers typically have configuration options that affect the rendering process. You should always configure a Renderer before calling renderScene(). This can be done in any of three different ways.
First and most simply, you can call configurePreview(). This configures the renderer in a way which is appropriate for quick previews. It will attempt to find a balance between speed and image quality, but err on the side of speed when necessary.
Second, each Renderer can create a user interface that allows the configuration to be edited interactively. Call getConfigPanel() to get a Widget for configuring the renderer. When the user is done setting options, call recordConfiguration() to record them.
Finally, you can query and set rendering options directly with getConfiguration() and setConfiguration(). Rendering options are defined as key:value pairs. Each key is always a String. The value may be a String, Integer, Float, Double, or Boolean, depending on the specific option.
Method Summary | |
---|---|
void |
cancelRendering(Scene theScene)
Cancel a rendering which is in progress. |
void |
configurePreview()
Configure the renderer in a way which is appropriate for rendering previews. |
Widget |
getConfigPanel()
Get a Widget in which the user can specify options about how the scene should be rendered. |
java.util.Map<java.lang.String,java.lang.Object> |
getConfiguration()
Get a Map containing all current configuration options for the renderer. |
java.lang.String |
getName()
Get the name of the renderer. |
boolean |
recordConfiguration()
Record the values which the user has entered into the configuration panel. |
void |
renderScene(Scene theScene,
Camera theCamera,
RenderListener listener,
SceneCamera sceneCamera)
Begin rendering a scene. |
void |
setConfiguration(java.lang.String property,
java.lang.Object value)
Set the value of a configuration option for the renderer. |
Method Detail |
---|
java.lang.String getName()
void renderScene(Scene theScene, Camera theCamera, RenderListener listener, SceneCamera sceneCamera)
void cancelRendering(Scene theScene)
Widget getConfigPanel()
boolean recordConfiguration()
void configurePreview()
java.util.Map<java.lang.String,java.lang.Object> getConfiguration()
void setConfiguration(java.lang.String property, java.lang.Object value)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |