com.luciad.view.lightspeed

LuciadFusionClass TLspPaintPass

java.lang.Object

com.luciad.view.lightspeed.TLspPaintPass

public final class TLspPaintPass
extends Object

Combination of a paint phase and paint representation state that describes which object representation to paint during a given paint pass.

As an example, an TLspPaintPass could state that only selected bodies should be painted that are transparent and draped on terrain.

Painters should only paint what is requested by the provided paint pass.

Since:

2012.0

See Also:

ILspPainter

Method Summary

Modifier and Type	Method and Description
static TLspPaintPass	getInstance(TLspPaintPhase aPaintPhase, TLspPaintRepresentationState aPaintRepresentationState) Retrieves a paint pass that combines the given paint phase and paint representation state.
TLspPaintPhase.PaintDraping	getPaintDraping()
TLspPaintPhase.PaintOpacity	getPaintOpacity()
TLspPaintPhase	getPaintPhase() Gets the paint phase.
TLspPaintRepresentation	getPaintRepresentation() Convenience method that gets the paint representation.
TLspPaintRepresentationState	getPaintRepresentationState() Gets the paint representation state.
TLspPaintState	getPaintState() Convenience method that gets the paint state that defines whether selected, edited or all other objects should be painted.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static TLspPaintPass getInstance(TLspPaintPhase aPaintPhase,
                                        TLspPaintRepresentationState aPaintRepresentationState)

Retrieves a paint pass that combines the given paint phase and paint representation state.

Parameters:

aPaintPhase - the paint phase

aPaintRepresentationState - the paint representation state

Returns:

the corresponding paint pass

getPaintPhase

public TLspPaintPhase getPaintPhase()

Gets the paint phase.

Returns:

the paint phase

getPaintRepresentationState

public TLspPaintRepresentationState getPaintRepresentationState()

Gets the paint representation state.

Returns:

the paint representation state

getPaintRepresentation

public TLspPaintRepresentation getPaintRepresentation()

Convenience method that gets the paint representation.

Returns:

the paint representation

getPaintOpacity

public TLspPaintPhase.PaintOpacity getPaintOpacity()

getPaintDraping

public TLspPaintPhase.PaintDraping getPaintDraping()

getPaintState

public TLspPaintState getPaintState()

Convenience method that gets the paint state that defines whether selected, edited or all other objects should be painted.

Returns:

the paint state that defines whether selected, edited or all other objects should be painted

toString

public String toString()

Overrides:

toString in class Object