com.luciad.lucy.map.asynchronous

LuciadLightspeedClass TLcyAsynchronousPaintHint

java.lang.Object

com.luciad.view.gxy.asynchronous.manager.TLcdGXYAsynchronousPaintHint

com.luciad.lucy.map.asynchronous.TLcyAsynchronousPaintHint

public class TLcyAsynchronousPaintHint
extends TLcdGXYAsynchronousPaintHint

This class describes asynchronous painting hints. A hint controls paint queue configuration options and paint queue sharing. It must be created and returned by an ILcyAsynchronousPaintHintProvider.

Nested Class Summary

Nested classes/interfaces inherited from class com.luciad.view.gxy.asynchronous.manager.TLcdGXYAsynchronousPaintHint

TLcdGXYAsynchronousPaintHint.Choice, TLcdGXYAsynchronousPaintHint.Combinable, TLcdGXYAsynchronousPaintHint.EqualsCombinable, TLcdGXYAsynchronousPaintHint.Range

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MERGE_GROUP A default merge group name.
static String	MERGE_GROUP_KEY Key used to store the merge group property.
static String	MERGE_KEY Key used to store the merge property.

Fields inherited from class com.luciad.view.gxy.asynchronous.manager.TLcdGXYAsynchronousPaintHint

BORDER_FACTOR_KEY, INTERMEDIATE_UPDATE_RANGE_KEY, INTERRUPT_MODE_KEY, INTERRUPT_PAINTING_KEY, PAINTING_MODE_KEY, SKIP_DELAY_KEY, SYNCHRONOUS_DELAY_KEY, THREAD_PRIORITY_KEY

Constructor Summary

Constructors

Constructor and Description
TLcyAsynchronousPaintHint() Create a new asynchronous paint hint with an empty properties map.
TLcyAsynchronousPaintHint(boolean aBodiesOnly, boolean aMerge, String aMergeGroup) Creates a new asynchronous paint hint.
TLcyAsynchronousPaintHint(boolean aBodiesOnly, boolean aMerge, String aMergeGroup, int aIntermediateUpdateInterval) Creates a new asynchronous paint hint with intermediate updating.
TLcyAsynchronousPaintHint(boolean aBodiesOnly, boolean aMerge, String aMergeGroup, int aIntermediateUpdateInterval, int aMinimumThreadPriority) Creates a new asynchronous paint hint with custom thread priority.

Method Summary

Modifier and Type	Method and Description
int	getIntermediateUpdateInterval() If not 0, ongoing asynchronous paints are directly shown on the view with the returned refresh rate (in milliseconds)
String	getMergeGroup() Returns the paint group to which the layer belongs.
int	getMinimumThreadPriority() Returns the minimum thread priority of the paint thread.
boolean	isBodiesOnly() Returns whether only the bodies need to be painted asynchronously.
boolean	isMerge() Returns whether the layer may be painted together with other layers.

Methods inherited from class com.luciad.view.gxy.asynchronous.manager.TLcdGXYAsynchronousPaintHint

getBorderFactor, getIntermediateUpdateRange, getInterruptMode, getInterruptPainting, getPaintingMode, getProperties, getSkipDelay, getSynchronousDelay, getThreadPriority, setBorderFactor, setIntermediateUpdateRange, setInterruptMode, setInterruptPainting, setPaintingMode, setSkipDelay, setSynchronousDelay, setThreadPriority, toString

Methods inherited from class java.lang.Object

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

Field Detail

MERGE_GROUP_KEY

public static final String MERGE_GROUP_KEY

Key used to store the merge group property. The value must be a Choice containing String values

See Also:

Constant Field Values

MERGE_KEY

public static final String MERGE_KEY

Key used to store the merge property. The value must be a Choice containing true when the layer may share a paint queue with other layers, or a Choice without any values when the layer must have its own paint queue.

See Also:

Constant Field Values

DEFAULT_MERGE_GROUP

public static final String DEFAULT_MERGE_GROUP

A default merge group name. Specify this merge group in the TLcyAsynchronousPaintHint(boolean, boolean, java.lang.String, int, int) constructor for layers that are painted relatively fast.

See Also:

Constant Field Values

Constructor Detail

TLcyAsynchronousPaintHint

public TLcyAsynchronousPaintHint()

Create a new asynchronous paint hint with an empty properties map.

The resulting paint hint will have an empty properties map, hence place no restrictions on the corresponding paint queue.

Such a paint can for example be used for empty ILcdLayerTreeNodes, which do not affect the painting time of a paint queue.

TLcyAsynchronousPaintHint

public TLcyAsynchronousPaintHint(boolean aBodiesOnly,
                                 boolean aMerge,
                                 String aMergeGroup)

Creates a new asynchronous paint hint. This convenience constructor is equivalent with calling TLcyAsynchronousPaintHint( aBodiesOnly, aMerge, aMergeGroup, 0, Thread.MIN_PRIORITY - 1 ).

Parameters:

aBodiesOnly - if true, only the bodies need to be painted asynchronously

aMerge - if true, the layer may be painted together with other layers

aMergeGroup - the paint group the layer belongs to. All layers of this group are painted together. This argument has no meaning when aMerge is false.

See Also:

TLcyAsynchronousPaintHint(boolean, boolean, String, int)

TLcyAsynchronousPaintHint

public TLcyAsynchronousPaintHint(boolean aBodiesOnly,
                                 boolean aMerge,
                                 String aMergeGroup,
                                 int aIntermediateUpdateInterval)

Creates a new asynchronous paint hint with intermediate updating. This convenience constructor is equivalent with calling TLcyAsynchronousPaintHint( aBodiesOnly, aMerge, aMergeGroup, aIntermediateUpdateInterval, Thread.MIN_PRIORITY - 1 ).

Parameters:

aBodiesOnly - if true, only the bodies need to be painted asynchronously

aMerge - if true, the layer may be painted together with other layers

aMergeGroup - the paint group the layer belongs to. All layers of this group are painted together. This argument has no meaning when aMerge is false.

aIntermediateUpdateInterval - if not 0, ongoing asynchronous paints are directly shown on the view with the specified refresh rate (in milliseconds)

See Also:

TLcyAsynchronousPaintHint(boolean, boolean, String, int, int)

TLcyAsynchronousPaintHint

public TLcyAsynchronousPaintHint(boolean aBodiesOnly,
                                 boolean aMerge,
                                 String aMergeGroup,
                                 int aIntermediateUpdateInterval,
                                 int aMinimumThreadPriority)

Creates a new asynchronous paint hint with custom thread priority.

Parameters:

aBodiesOnly - if true, only the bodies need to be painted asynchronously

aMerge - if true, the layer may be painted together with other layers

aMergeGroup - the paint group the layer belongs to. All layers of this group are painted together. This argument has no meaning when aMerge is false.

aIntermediateUpdateInterval - if not 0, ongoing asynchronous paints are directly shown on the view with the specified refresh rate (in milliseconds)

aMinimumThreadPriority - the minimum priority of the paint thread, or Thread.MIN_PRIORITY - 1 for the default priority.

Method Detail

isMerge

public boolean isMerge()

Returns whether the layer may be painted together with other layers.

The result of this method is only valid when the properties map is not empty.

Returns:

whether the layer may be painted together with other layers

getMergeGroup

public String getMergeGroup()

Returns the paint group to which the layer belongs.

The result of this method is only valid when the properties map is not empty.

Returns:

the paint group to which the layer belongs

isBodiesOnly

public boolean isBodiesOnly()

Returns whether only the bodies need to be painted asynchronously.

The result of this method is only valid when the properties map is not empty.

Returns:

whether only the bodies need to be painted asynchronously

getIntermediateUpdateInterval

public int getIntermediateUpdateInterval()

If not 0, ongoing asynchronous paints are directly shown on the view with the returned refresh rate (in milliseconds)

The result of this method is only valid when the properties map is not empty.

Returns:

if not 0, ongoing asynchronous paints are directly shown on the view with the returned refresh rate (in milliseconds)

getMinimumThreadPriority

public int getMinimumThreadPriority()

Returns the minimum thread priority of the paint thread.

The result of this method is only valid when the properties map is not empty.

Returns:

the minimum thread priority of the paint thread, or Thread.MIN_PRIORITY - 1 if no priority is specified.