com.luciad.view.gxy.asynchronous

LuciadFusionClass TLcdGXYAsynchronousMultiPaintQueue

java.lang.Object

com.luciad.view.gxy.asynchronous.TLcdGXYAsynchronousMultiPaintQueue

All Implemented Interfaces:

ILcdGXYAsynchronousPaintQueue

public class TLcdGXYAsynchronousMultiPaintQueue
extends Object
implements ILcdGXYAsynchronousPaintQueue

A paint queue for multiple views, delegating to several ILcdGXYAsynchronousPaintQueue instances. A multi paint queue is linked to a single layer. However, the delegated paint queues may be shared by several layers. The ILcdGXYAsynchronousPaintQueue instances to use should be set before setting this multi paint queue on a layer.

Note that the use of this class is not recommended: because a layer cannot be accessed simultaneously, and because the delegate ILcdGXYAsynchronousPaintQueues do not know of each other, a TLcdGXYAsynchronousMultiPaintQueue uses significantly more synchronization to enforce single-threaded access.

Instead, it is recommended to create separate layers for the same model. This allows the model to be painted in parallel on all views.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
TLcdGXYAsynchronousMultiPaintQueue(ILcdGXYAsynchronousLayerWrapper aWrapper) Creates a new multi view paint queue for the given layer wrapper.

Method Summary

Modifier and Type	Method and Description
void	addGXYAsynchronousPaintListener(ILcdGXYAsynchronousPaintListener aListener) Registers an ILcdGXYAsynchronousPaintListener to be informed of asynchronous painting events.
ILcdGXYAsynchronousLayerWrapper	getGXYAsynchronousLayerWrapper() Returns the layer for which this paint performs its delegation.
ILcdGXYAsynchronousPaintQueue	getGXYAsynchronousPaintQueue(ILcdGXYView aGXYView) Returns the ILcdGXYAsynchronousPaintQueue that is used to paint asynchronously on the given view
Map<ILcdGXYView,ILcdGXYAsynchronousPaintQueue>	getGXYAsynchronousPaintQueues() Returns all set ILcdGXYAsynchronousPaintQueue instances.
ILcdGXYView	getGXYAsynchronousView(ILcdGXYAsynchronousLayerWrapper aWrapper, int aMode, ILcdGXYView aGXYView) Returns the view on which the asynchronous paint requests are actually executed.
void	invokeAndWait(Runnable aRunnable) Executes the given Runnable synchronously, but without interfering with the paint thread.
void	invokeLater(Runnable aRunnable) Executes the given Runnable in the paint thread and returns immediately.
void	invokeLaterInEDT(Runnable aRunnable) Executes the given Runnable in the event dispatch thread and returns immediately.
boolean	isEmpty() Returns true if the paint queue is not painting and it has no paint requests to finish.
void	paint(Graphics aGraphics, ILcdGXYAsynchronousLayerWrapper aWrapper, int aMode, ILcdGXYView aGXYView) Paints an image of the painted layers using the given graphics.
void	removeGXYAsynchronousPaintListener(ILcdGXYAsynchronousPaintListener aListener) Stops informing the given ILcdGXYAsynchronousPaintListener of asynchronous painting events.
void	reset() Clears all cached images and paint requests.
void	setGXYAsynchronousPaintQueue(ILcdGXYView aGXYView, ILcdGXYAsynchronousPaintQueue aQueue) Sets the ILcdGXYAsynchronousPaintQueue that is used to paint asynchronously on the given view.

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcdGXYAsynchronousMultiPaintQueue

public TLcdGXYAsynchronousMultiPaintQueue(ILcdGXYAsynchronousLayerWrapper aWrapper)

Creates a new multi view paint queue for the given layer wrapper. For each view to paint asynchronously on, an appropriate paint queue should be set using setGXYAsynchronousPaintQueue(com.luciad.view.gxy.ILcdGXYView, com.luciad.view.gxy.asynchronous.ILcdGXYAsynchronousPaintQueue).

Parameters:

aWrapper - the layer wrapper that should be painted asynchronously on several views

Method Detail

getGXYAsynchronousLayerWrapper

public ILcdGXYAsynchronousLayerWrapper getGXYAsynchronousLayerWrapper()

Returns the layer for which this paint performs its delegation.

Returns:

the layer wrapper that is painted asynchronously

getGXYAsynchronousPaintQueue

public ILcdGXYAsynchronousPaintQueue getGXYAsynchronousPaintQueue(ILcdGXYView aGXYView)

Returns the ILcdGXYAsynchronousPaintQueue that is used to paint asynchronously on the given view

Parameters:

aGXYView - the view for which to return a paint queue

Returns:

the paint queue that paints this queue's layer asynchronously for the given view

getGXYAsynchronousPaintQueues

public Map<ILcdGXYView,ILcdGXYAsynchronousPaintQueue> getGXYAsynchronousPaintQueues()

Returns all set ILcdGXYAsynchronousPaintQueue instances.

Returns:

all set ILcdGXYAsynchronousPaintQueue instances

See Also:

setGXYAsynchronousPaintQueue(com.luciad.view.gxy.ILcdGXYView, ILcdGXYAsynchronousPaintQueue)

setGXYAsynchronousPaintQueue

public void setGXYAsynchronousPaintQueue(ILcdGXYView aGXYView,
                                         ILcdGXYAsynchronousPaintQueue aQueue)

Sets the ILcdGXYAsynchronousPaintQueue that is used to paint asynchronously on the given view. This method should only be called before setting this multi paint queue on a layer.

Parameters:

aGXYView - the view for which to set the given paint queue

aQueue - the paint queue that paints this queue's layer asynchronously, or null if no paint queue is to be used Paint calls for the given view are delegated to the given queue.

paint

public void paint(Graphics aGraphics,
                  ILcdGXYAsynchronousLayerWrapper aWrapper,
                  int aMode,
                  ILcdGXYView aGXYView)

Paints an image of the painted layers using the given graphics. If a valid image is not available for the mode, this operation queues an asynchronous paint request, in order to create one. The parent view will then be asked to repaint itself when the asynchronous painting is completed.

Note that the paint queue is free to decide if it will execute the paint synchronously or asynchronously (e.g. when confronted with unsupported views). This paint queue delegates to several individual paint queues to paint asynchronously on multiple views.

Specified by:

paint in interface ILcdGXYAsynchronousPaintQueue

Parameters:

aGraphics - the graphics to use for painting

aWrapper - the asynchronous layer wrapper that should be painted

aMode - the mode indicating what should be painted, see ILcdGXYLayer.paint(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYView).

aGXYView - the view for which the layer should be painted.

getGXYAsynchronousView

public ILcdGXYView getGXYAsynchronousView(ILcdGXYAsynchronousLayerWrapper aWrapper,
                                          int aMode,
                                          ILcdGXYView aGXYView)

Description copied from interface: ILcdGXYAsynchronousPaintQueue

Returns the view on which the asynchronous paint requests are actually executed. In the painting thread, the asynchronous view replaces the given view when painting the given asynchronous layer with the given painting mode. Its images are then used as image buffers that can be composited in the actual view.

Specified by:

getGXYAsynchronousView in interface ILcdGXYAsynchronousPaintQueue

Parameters:

aWrapper - the asynchronous layer wrapper that would be painted

aMode - the mode indicating what should be painted, see ILcdGXYLayer.paint(java.awt.Graphics, int, com.luciad.view.gxy.ILcdGXYView).

aGXYView - the original view for which asynchronous paints are meant to be displayed. Paints for unsupported views are executed synchronously.

Returns:

the view that is used for asynchronous painting

reset

public void reset()
           throws InterruptedException

Description copied from interface: ILcdGXYAsynchronousPaintQueue

Clears all cached images and paint requests. Waits for asynchronous painting to finish.

Specified by:

reset in interface ILcdGXYAsynchronousPaintQueue

Throws:

InterruptedException - when the thread is interrupted while waiting for the asynchronous paint to complete

isEmpty

public boolean isEmpty()

Description copied from interface: ILcdGXYAsynchronousPaintQueue

Returns true if the paint queue is not painting and it has no paint requests to finish. When called on the event dispatch thread, it should guarantee that no painting occurs while the caller holds the thread.

Specified by:

isEmpty in interface ILcdGXYAsynchronousPaintQueue

Returns:

true when no painting will occur while the caller holds the thread

invokeLater

public void invokeLater(Runnable aRunnable)

Executes the given Runnable in the paint thread and returns immediately. This paint queue delegates this call to one of the set paint queues. The wrapper is synchronized on during the call.

Specified by:

invokeLater in interface ILcdGXYAsynchronousPaintQueue

Parameters:

aRunnable - the Runnable to execute. The run method should take care when waiting for another thread: if that thread in turn waits for asynchronous painting to complete, a deadlock will occur.

invokeLaterInEDT

public void invokeLaterInEDT(Runnable aRunnable)

Description copied from interface: ILcdGXYAsynchronousPaintQueue

Executes the given Runnable in the event dispatch thread and returns immediately.

Specified by:

invokeLaterInEDT in interface ILcdGXYAsynchronousPaintQueue

Parameters:

aRunnable - the Runnable to execute.

invokeAndWait

public void invokeAndWait(Runnable aRunnable)
                   throws InterruptedException

Executes the given Runnable synchronously, but without interfering with the paint thread. This call blocks until all asynchronous paints and runnables have been processed, and the Runnable returns. The invocation is executed in the view's paint thread (typically the EDT). This paint queue delegates this call to one of the set paint queues. The wrapper is synchronized on during the call.

Specified by:

invokeAndWait in interface ILcdGXYAsynchronousPaintQueue

Parameters:

aRunnable - the Runnable to execute. The run method should take care when waiting for another thread: if that thread in turn waits for asynchronous painting to complete, a deadlock will occur.

Throws:

InterruptedException - when the thread is interrupted while waiting for the execution to complete

addGXYAsynchronousPaintListener

public void addGXYAsynchronousPaintListener(ILcdGXYAsynchronousPaintListener aListener)

Description copied from interface: ILcdGXYAsynchronousPaintQueue

Registers an ILcdGXYAsynchronousPaintListener to be informed of asynchronous painting events. These events will be thrown in the asynchronous painting thread.

Specified by:

addGXYAsynchronousPaintListener in interface ILcdGXYAsynchronousPaintQueue

Parameters:

aListener - the listener that should be notified

removeGXYAsynchronousPaintListener

public void removeGXYAsynchronousPaintListener(ILcdGXYAsynchronousPaintListener aListener)

Description copied from interface: ILcdGXYAsynchronousPaintQueue

Stops informing the given ILcdGXYAsynchronousPaintListener of asynchronous painting events.

Specified by:

removeGXYAsynchronousPaintListener in interface ILcdGXYAsynchronousPaintQueue

Parameters:

aListener - the listener that should no longer be notified.