com.luciad.view.lightspeed.layer.imageprojection

LuciadLightspeedClass TLspImageProjectionStyle.Builder<B extends TLspImageProjectionStyle.Builder<B>>

java.lang.Object

com.luciad.view.lightspeed.style.ALspStyle.Builder<B>

com.luciad.view.lightspeed.layer.imageprojection.TLspImageProjectionStyle.Builder<B>

Enclosing class:

TLspImageProjectionStyle

public static class TLspImageProjectionStyle.Builder<B extends TLspImageProjectionStyle.Builder<B>>
extends ALspStyle.Builder<B>

Builder used to create image projection styles.

You must specify an projector and image to create a valid instance.

Example usages:

To create a static image projected on the terrain:

  TLspImageProjectionStyle.newBuilder().
    projector( myProjector ).
    image( new TLsp2DImageTextureObject( myImage ) ).
    build();
 

Since:

2012.0

Method Summary

Modifier and Type	Method and Description
B	all(ALspStyle aStyle) Sets all parameters on the builder based on the given style.
TLspImageProjectionStyle	build() Builds the style with the set parameters.
B	image(ALspTextureObject aImage) Sets the image to be projected onto the terrain.
B	opacity(float aOpacity) Sets the opacity (alpha value) of the projected image.
B	projector(ILspImageProjector aProjector) Sets the projector.
B	zOrder(int aZOrder) Sets the z-order of this style.

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

equals, hashCode

Methods inherited from class java.lang.Object

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

Method Detail

all

public B all(ALspStyle aStyle)

Description copied from class: ALspStyle.Builder

Sets all parameters on the builder based on the given style.

This is useful for example to create a new style that has almost all properties equal to another style.

Specified by:

all in class ALspStyle.Builder<B extends TLspImageProjectionStyle.Builder<B>>

Parameters:

aStyle - the style to copy

Returns:

this

build

public TLspImageProjectionStyle build()

Description copied from class: ALspStyle.Builder

Builds the style with the set parameters.

Specified by:

build in class ALspStyle.Builder<B extends TLspImageProjectionStyle.Builder<B>>

Returns:

the resulting style

zOrder

public B zOrder(int aZOrder)

Sets the z-order of this style.

Parameters:

aZOrder - the z order

Returns:

this builder

See Also:

ALspStyle.getZOrder()

projector

public B projector(ILspImageProjector aProjector)

Sets the projector. The projector's coordinates must be defined in model coordinates.

Parameters:

aProjector - the projector

Returns:

this builder

See Also:

TLspImageProjectionStyle.getProjector()

image

public B image(ALspTextureObject aImage)

Sets the image to be projected onto the terrain.

Parameters:

aImage - the image to be projected on the terrain

Returns:

this builder

See Also:

TLspImageProjectionStyle.getImage()

opacity

public B opacity(float aOpacity)

Sets the opacity (alpha value) of the projected image. A value of 0 means the image is fully transparent, a value of 1 means it is fully opaque. The default value is 1.

Parameters:

aOpacity - the alpha value to use for the projected image

Returns:

this builder

See Also:

TLspImageProjectionStyle.getOpacity()