com.luciad.view.lightspeed

LuciadFusionClass TLspPaintPhase

java.lang.Object

com.luciad.view.lightspeed.TLspPaintPhase

public final class TLspPaintPhase
extends Object

Class that describes the current paint phase. A paint phase consists of a TLspPaintPhase.PaintOpacity, TLspPaintPhase.PaintDraping and a TLspPaintPhase.PaintStereo.

An ILspView may paint its layers in multiple phases, depending on rendering techniques which are used (such as draping over terrain or transparency blending). All the view's layers may be visited again during every phase. The paint phase can state, for example, that only opaque objects that are not draped should be painted. Painters should then comply with the supplied settings and only paint what is requested. The paint phase also identifies for which eye the view should be rendered if the view is stereoscopic (e.g. for a VR headset).

Since:

2012.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLspPaintPhase.PaintDraping Identifies how the objects are added to the world: draped on terrain or not.
static class	TLspPaintPhase.PaintOpacity Identifies the current paint phase in the transparency algorithm and hence which objects should be drawn.
static class	TLspPaintPhase.PaintStereo Identifies for which eye the view should be rendered for a stereoscopic view.

Method Summary

Modifier and Type	Method and Description
static TLspPaintPhase	getInstance(TLspPaintPhase.PaintOpacity aPaintOpacity, TLspPaintPhase.PaintDraping aPaintDraping) Returns a TLspPaintPhase combining the passed Paint Opacity and Paint Draping.
static TLspPaintPhase	getInstance(TLspPaintPhase.PaintOpacity aPaintOpacity, TLspPaintPhase.PaintDraping aPaintDraping, TLspPaintPhase.PaintStereo aPaintStereo) Returns a TLspPaintPhase combining the passed Paint Opacity and Paint Draping.
TLspPaintPhase.PaintDraping	getPaintDraping() Defines which objects need to be drawn based on the fact whether terrain or not is required.
TLspPaintPhase.PaintOpacity	getPaintOpacity() Defines which objects need to be drawn based on the object's painting style.
TLspPaintPhase.PaintStereo	getPaintStereo() Defines that the left or right eye needs to be rendered when a stereoscopic view is used.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static TLspPaintPhase getInstance(TLspPaintPhase.PaintOpacity aPaintOpacity,
                                         TLspPaintPhase.PaintDraping aPaintDraping)

Returns a TLspPaintPhase combining the passed Paint Opacity and Paint Draping. The Paint stereo is set to TLspPaintPhase.PaintStereo.NON_STEREO.

Parameters:

aPaintOpacity - the Paint Opacity

aPaintDraping - the Paint Draping

Returns:

a TLspPaintPhase

getInstance

public static TLspPaintPhase getInstance(TLspPaintPhase.PaintOpacity aPaintOpacity,
                                         TLspPaintPhase.PaintDraping aPaintDraping,
                                         TLspPaintPhase.PaintStereo aPaintStereo)

Returns a TLspPaintPhase combining the passed Paint Opacity and Paint Draping.

Parameters:

aPaintOpacity - the Paint Opacity

aPaintDraping - the Paint Draping

aPaintStereo - the Paint Stereo

Returns:

a TLspPaintPhase

getPaintOpacity

public TLspPaintPhase.PaintOpacity getPaintOpacity()

Defines which objects need to be drawn based on the object's painting style.

Returns:

whether transparent, opaque, or all objects should be painted

getPaintDraping

public TLspPaintPhase.PaintDraping getPaintDraping()

Defines which objects need to be drawn based on the fact whether terrain or not is required.

Returns:

whether objects to be draped, to be not draped, or all objects should be painted.

getPaintStereo

public TLspPaintPhase.PaintStereo getPaintStereo()

Defines that the left or right eye needs to be rendered when a stereoscopic view is used.

Returns:

whether the left or right eye is to be rendered or that no stereoscopic rendering is needed.

toString

public String toString()

Overrides:

toString in class Object