org.piccolo2d

Class POffscreenCanvas

java.lang.Object

org.piccolo2d.POffscreenCanvas

All Implemented Interfaces:

PComponent

public final class POffscreenCanvas
extends Object
implements PComponent

Offscreen canvas.

Since:

1.3

Constructor Summary

Constructors

Constructor and Description
POffscreenCanvas(int width, int height) Create a new offscreen canvas the specified width and height.

Method Summary

Methods

Modifier and Type	Method and Description
Color	getBackground() Return the background color for this offscreen canvas.
PCamera	getCamera() Return the camera for this offscreen canvas.
int	getRenderQuality() Return the render quality hint for this offscreen canvas.
PRoot	getRoot() Return the root node of the scene graph for this offscreen canvas.
boolean	isOpaque() Return true if this offscreen canvas is opaque.
void	paintImmediately() Sends a repaint notification the repaint manager if PComponent is not already painting immediately.
void	popCursor() Pops the topmost cursor from the stack and sets it as the current one.
void	pushCursor(Cursor cursor) Pushes the given cursor onto the cursor stack and sets the current cursor to the one provided.
void	render(Graphics2D graphics) Render this offscreen canvas to the specified graphics.
void	repaint(PBounds repaintBounds) Called to notify PComponent that given bounds need repainting.
void	setBackground(Color backgroundColor) Set the background color for this offscreen canvas to backgroundColor.
void	setCamera(PCamera camera) Set the camera for this offscreen canvas to camera.
void	setInteracting(boolean interacting) Sets whether the component is currently being interacted with.
void	setOpaque(boolean opaque) Set to true if this offscreen canvas is opaque.
void	setRenderQuality(int renderQuality) Set the render quality hint for this offscreen canvas to renderQuality.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

POffscreenCanvas

public POffscreenCanvas(int width,
                int height)

Create a new offscreen canvas the specified width and height.

Parameters:

width - width of this offscreen canvas, must be at least zero

height - height of this offscreen canvas, must be at least zero

Method Detail

render

public void render(Graphics2D graphics)

Render this offscreen canvas to the specified graphics.

Parameters:

graphics - graphics to render this offscreen canvas to, must not be null

setCamera

public void setCamera(PCamera camera)

Set the camera for this offscreen canvas to camera.

Parameters:

camera - camera for this offscreen canvas

getCamera

public PCamera getCamera()

Return the camera for this offscreen canvas.

Returns:

the camera for this offscreen canvas

setRenderQuality

public void setRenderQuality(int renderQuality)

Set the render quality hint for this offscreen canvas to renderQuality.

Parameters:

renderQuality - render quality hint, must be one of PPaintContext.HIGH_QUALITY_RENDERING or PPaintContext.LOW_QUALITY_RENDERING

getRenderQuality

public int getRenderQuality()

Return the render quality hint for this offscreen canvas.

Returns:

the render quality hint for this offscreen canvas

paintImmediately

public void paintImmediately()

Sends a repaint notification the repaint manager if PComponent is not already painting immediately.

Specified by:

paintImmediately in interface PComponent

popCursor

public void popCursor()

Pops the topmost cursor from the stack and sets it as the current one.

Specified by:

popCursor in interface PComponent

pushCursor

public void pushCursor(Cursor cursor)

Pushes the given cursor onto the cursor stack and sets the current cursor to the one provided.

Specified by:

pushCursor in interface PComponent

Parameters:

cursor - The cursor to set as the current one and push

repaint

public void repaint(PBounds repaintBounds)

Called to notify PComponent that given bounds need repainting.

Specified by:

repaint in interface PComponent

Parameters:

repaintBounds - bounds needing repaint

setInteracting

public void setInteracting(boolean interacting)

Sets whether the component is currently being interacted with.

Specified by:

setInteracting in interface PComponent

Parameters:

interacting - whether the component is currently being interacted with

getRoot

public PRoot getRoot()

Return the root node of the scene graph for this offscreen canvas. The root node will be null if the camera for this offscreen canvas is null.

Returns:

the root node of the scene graph for this offscreen canvas

isOpaque

public boolean isOpaque()

Return true if this offscreen canvas is opaque. Defaults to false.

Returns:

true if this offscreen canvas is opaque

setOpaque

public void setOpaque(boolean opaque)

Set to true if this offscreen canvas is opaque.

Parameters:

opaque - true if this offscreen canvas is opaque

getBackground

public Color getBackground()

Return the background color for this offscreen canvas. If this offscreen canvas is opaque, the background color will be painted before the contents of the scene are rendered.

Returns:

the background color for this offscreen canvas

See Also:

isOpaque()

setBackground

public void setBackground(Color backgroundColor)

Set the background color for this offscreen canvas to backgroundColor. If this offscreen canvas is opaque, the background color will be painted before the contents of the scene are rendered.

Parameters:

backgroundColor - background color for this offscreen canvas

See Also:

isOpaque()