com.luciad.tea.lightspeed.los.view

Terrain Analysis EngineClass TLspLOSCoverageStyle

java.lang.Object

com.luciad.view.lightspeed.style.ALspStyle

com.luciad.tea.lightspeed.los.view.TLspLOSCoverageStyle

All Implemented Interfaces:

ILspEffectsHintStyle, ILspWorldElevationStyle, ILspStyler

public class TLspLOSCoverageStyle
extends ALspStyle
implements ILspWorldElevationStyle, ILspEffectsHintStyle

The LOS Coverage style. This style is used by the TLspLOSCoveragePainter to visualize a LOS calculation.

A LOS Coverage style defines the following things:

• The color map of a LOS Coverage
• The unknown color of a LOS Coverage, indicating the color for unknown values
• The invisible color of a LOS Coverage, indicating the color for invisible areas
• Whether or not the LOS Coverage should be draped.
• The order of painting in case there are overlapping LOS Coverages.

The transparency of this style is determined by the color map, and can't be set individually.

NOTE: Styles are generally immutable, and this style is no exception. You shouldn't modify the color map after the style has been created, but instead create a new TLspLOSCoverageStyle instance with a new color map instance.

Since:

2012.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLspLOSCoverageStyle.Builder<B extends TLspLOSCoverageStyle.Builder<B>> Builder for LOS coverage styles.

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.style.ILspWorldElevationStyle

ILspWorldElevationStyle.ElevationMode

Nested classes/interfaces inherited from interface com.luciad.view.lightspeed.style.ILspEffectsHintStyle

ILspEffectsHintStyle.EffectsHint

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TLspLOSCoverageStyle(TLspLOSCoverageStyle.Builder aBuilder)

Method Summary

Modifier and Type	Method and Description
TLspLOSCoverageStyle.Builder<?>	asBuilder() Creates a new builder initialized with all the properties of this style.
boolean	equals(Object o)
TLcdColorMap	getColorMap() Gets the color map of this LOS Coverage Style.
Collection<ILspEffectsHintStyle.EffectsHint>	getEffectsHints() Returns the effects hints specified for this style.
ILspWorldElevationStyle.ElevationMode	getElevationMode() Returns the elevation mode of this style.
Color	getInvisibleColor() Returns the color used to display "invisible" los elevation values
Color	getUnknownColor() Returns the unknown color used to display "unknown" los elevation values
int	hashCode()
boolean	isCompatible(TLspPaintPass aPaintPass) Utility method to determine whether the style is compatible with the given paint pass.
boolean	isTransparent() Determines whether this style is transparent.
static TLspLOSCoverageStyle.Builder<?>	newBuilder() Creates a new builder with the default values.

Methods inherited from class com.luciad.view.lightspeed.style.ALspStyle

addStyleChangeListener, getZOrder, removeStyleChangeListener, style

Methods inherited from class java.lang.Object

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

Constructor Detail

TLspLOSCoverageStyle

protected TLspLOSCoverageStyle(TLspLOSCoverageStyle.Builder aBuilder)

Method Detail

newBuilder

public static TLspLOSCoverageStyle.Builder<?> newBuilder()

Creates a new builder with the default values.

Returns:

the new builder.

asBuilder

public TLspLOSCoverageStyle.Builder<?> asBuilder()

Creates a new builder initialized with all the properties of this style.

Specified by:

asBuilder in class ALspStyle

Returns:

the new builder.

getColorMap

public TLcdColorMap getColorMap()

Gets the color map of this LOS Coverage Style.

Returns:

the color map

getUnknownColor

public Color getUnknownColor()

Returns the unknown color used to display "unknown" los elevation values

Returns:

the unknown color

getInvisibleColor

public Color getInvisibleColor()

Returns the color used to display "invisible" los elevation values

Returns:

the invisible color

isTransparent

public boolean isTransparent()

Determines whether this style is transparent.

The return value of this method depends on the color map of the style. If the color map contains a single transparent color, or has a master opacity value lower than 255

Specified by:

isTransparent in class ALspStyle

Returns:

whether or not this style is transparent

getElevationMode

public ILspWorldElevationStyle.ElevationMode getElevationMode()

Description copied from interface: ILspWorldElevationStyle

Returns the elevation mode of this style.

Specified by:

getElevationMode in interface ILspWorldElevationStyle

Returns:

The elevation mode.

getEffectsHints

public Collection<ILspEffectsHintStyle.EffectsHint> getEffectsHints()

Description copied from interface: ILspEffectsHintStyle

Returns the effects hints specified for this style.

Specified by:

getEffectsHints in interface ILspEffectsHintStyle

Returns:

the effects hints specified for this style

isCompatible

public boolean isCompatible(TLspPaintPass aPaintPass)

Description copied from class: ALspStyle

Utility method to determine whether the style is compatible with the given paint pass.

A style and paint pass are compatible if they use or request the same terrain and transparency properties.

Overrides:

isCompatible in class ALspStyle

Parameters:

aPaintPass - the paint pass

Returns:

true if the style can be used in the given paint pass, false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class ALspStyle

hashCode

public int hashCode()

Overrides:

hashCode in class ALspStyle