com.luciad.view.lightspeed.style

LuciadLightspeedClass TLspParameterizedIconStyle.Builder<B extends TLspParameterizedIconStyle.Builder<B>>

java.lang.Object

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

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

All Implemented Interfaces:

ILspEffectsHintStyle.Builder, ILspWorldElevationStyle.Builder

Enclosing class:

TLspParameterizedIconStyle

public static class TLspParameterizedIconStyle.Builder<B extends TLspParameterizedIconStyle.Builder<B>>
extends ALspStyle.Builder<B>
implements ILspWorldElevationStyle.Builder, ILspEffectsHintStyle.Builder

Builder used to create parameterized icon styles.

Default values:

• visibility(com.luciad.util.expression.ILcdExpression<java.lang.Boolean>): true (all objects visible)
• scale(com.luciad.util.expression.ILcdExpression<java.lang.Float>): 1 (original icon size)
• modulationColor(com.luciad.util.expression.ILcdExpression<java.awt.Color>): white (original icon is not modified)
• opacity(com.luciad.util.expression.ILcdExpression<java.lang.Float>): 1 (original icon is not modified)
• icon(com.luciad.util.expression.ILcdExpression<? extends com.luciad.gui.ILcdIcon>): A filled rect with an outline
• useOrientation(boolean): false (icons are aligned to the screen, not using using ILcdOriented)
• offset(com.luciad.util.expression.ILcdExpression<java.lang.Float>, com.luciad.util.expression.ILcdExpression<java.lang.Float>): 0
• worldSize(com.luciad.util.expression.ILcdExpression<java.lang.Float>): 50000
• scalingMode(com.luciad.view.lightspeed.style.TLspIconStyle.ScalingMode): ScalingMode.VIEW_SCALING
• elevationMode(com.luciad.view.lightspeed.style.ILspWorldElevationStyle.ElevationMode): ElevationMode.OBJECT_DEPENDENT

Since:

2018.0

See Also:

for examples

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
B	all(ALspStyle aStyle) Sets all builder parameters to the properties of the provided style.
TLspParameterizedIconStyle	build() Builds the style with the set parameters.
B	effectsHints(ILspEffectsHintStyle.EffectsHint... aEffectsHints) Specifies the effects hints to be added to the style.
B	elevationMode(ILspWorldElevationStyle.ElevationMode aMode) Specifies the elevation mode.
B	icon(ILcdExpression<? extends ILcdIcon> aIcon) Sets the expression that determines the icon to use.
B	minimumPixelSize(ILcdExpression<Integer> aMinimumPixelSize) Sets the expression that determines the minimum icon pixel size.
B	modulationColor(ILcdExpression<Color> aColorExpression) Sets the expression that determines the modulation color to apply to the icons.
B	offset(ILcdExpression<Float> aOffsetX, ILcdExpression<Float> aOffsetY) Sets expressions that determine the icon offsets in 2D view coordinates.
B	opacity(ILcdExpression<Float> aOpacity) Sets the expression that determines the transparency to apply to the icons.
B	scale(ILcdExpression<Float> aScaleFactorExpression) Sets the expression that determines the scale factor to apply to the icons.
B	scalingMode(TLspIconStyle.ScalingMode aScalingMode) Sets the scaling mode of the icons.
B	useOrientation(boolean aOrientationEnabled) Sets whether the icon should respect its orientation.
B	visibility(ILcdExpression<Boolean> aVisibilityExpression) Sets the expression that determines whether objects should be displayed or not.
B	worldSize(ILcdExpression<Float> aWorldSize) Sets the expression that determines the icon size in meters.
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

Constructor Detail

Builder

public Builder()

Method Detail

icon

public B icon(ILcdExpression<? extends ILcdIcon> aIcon)

Sets the expression that determines the icon to use.

If an icon provided by the expression is an ILcdAnchoredIcon, the anchor point will automatically become the point of rotation, as well as the anchor point of the icon in the view.

Parameters:

aIcon - An expression of type ILcdIcon

Returns:

this

useOrientation

public B useOrientation(boolean aOrientationEnabled)

Sets whether the icon should respect its orientation. By default, this is set to false.

The actual orientation that is applied to the icon will be retrieved from the ILcdOriented interface. Either the geometry returned by the ALspStyleTargetProvider or the model object should implement this interface. The geometry takes precedence if both objects implement this interface. The orientation is interpreted as an azimuth.

Parameters:

aOrientationEnabled - a flag indicating whether or not the icon should respect its orientation

Returns:

this

scale

public B scale(ILcdExpression<Float> aScaleFactorExpression)

Sets the expression that determines the scale factor to apply to the icons.

• Scale 1 corresponds to the original size of the icon.
• Scale <1 will shrink the icon.
• Scale >1 will enlarge the icon.

If not set, icons are never re-scaled.

Parameters:

aScaleFactorExpression - An expression of type Float

Returns:

this

scalingMode

public B scalingMode(TLspIconStyle.ScalingMode aScalingMode)

Sets the scaling mode of the icons. By default this is set to ScalingMode.VIEW_SCALING.

Parameters:

aScalingMode - a scaling mode

Returns:

this

visibility

public B visibility(ILcdExpression<Boolean> aVisibilityExpression)

Sets the expression that determines whether objects should be displayed or not.

If not set, all objects in view are always displayed.

Parameters:

aVisibilityExpression - An expression of type Boolean

Returns:

this

offset

public B offset(ILcdExpression<Float> aOffsetX,
                ILcdExpression<Float> aOffsetY)

Sets expressions that determine the icon offsets in 2D view coordinates. This offset is applied after all other transformations have been applied. In other words: Scaling and rotation are applied first. Then this offset is done as a post-effect.

To support anchored icons, and rotations of icons around a specific point in the icon, please supply the icon(ILcdExpression) method with an expression that provides ILcdAnchoredIcon.

Parameters:

aOffsetX - the offset in X direction

aOffsetY - the offset in Y direction

Returns:

this;

See Also:

icon(ILcdExpression)

zOrder

public B zOrder(int aZOrder)

Sets the Z-order of this style. Styles should be painted from lowest to highest Z-order.

Increasing the number of different Z-orders can negatively impact painting performance. By default, it is set to 0.

Parameters:

aZOrder - the z order

Returns:

this

minimumPixelSize

public B minimumPixelSize(ILcdExpression<Integer> aMinimumPixelSize)

Sets the expression that determines the minimum icon pixel size. This size only affects the style if the scaling mode is set to ScalingMode.WORLD_SCALING_CLAMPED or ScalingMode.WORLD_SCALING. As soon as the largest dimension (i.e. width or height) of the icon is smaller than this minimum pixel size, the icon will be scaled to satisfy this minimum size.

By default this value is set to 0, which indicates that no minimum size will be enforced.

Parameters:

aMinimumPixelSize - An expression of type Float

Returns:

this

worldSize

public B worldSize(ILcdExpression<Float> aWorldSize)

Sets the expression that determines the icon size in meters. This size only affects the style if the scaling mode is set to ScalingMode.WORLD_SCALING or ScalingMode.WORLD_SCALING_CLAMPED.

By default this is set to 50000m.

Parameters:

aWorldSize - An expression of type Float.

Returns:

this

modulationColor

public B modulationColor(ILcdExpression<Color> aColorExpression)

Sets the expression that determines the modulation color to apply to the icons.

Color Color.white corresponds to the original icon.

If not set, icons keep their original color.

Parameters:

aColorExpression - An expression of type Color

Returns:

this

opacity

public B opacity(ILcdExpression<Float> aOpacity)

Sets the expression that determines the transparency to apply to the icons. This value is multiplied with the alpha value of the modulation color to determine the transparency of the icon.

• Opacity 1 corresponds to the original transparency icon.
• Opacity <1 will make the icons more transparent.
• Opacity 0 or <0 will make the icons completely transparent.
• Opacity >1 has no effect.

If not set, icons keep their original opacity determined by the alpha value of the modulation color.

Parameters:

aOpacity - An expression of type Float

Returns:

this

build

public TLspParameterizedIconStyle build()

Description copied from class: ALspStyle.Builder

Builds the style with the set parameters.

Specified by:

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

Returns:

the resulting style

effectsHints

public B effectsHints(ILspEffectsHintStyle.EffectsHint... aEffectsHints)

Description copied from interface: ILspEffectsHintStyle.Builder

Specifies the effects hints to be added to the style.

Specified by:

effectsHints in interface ILspEffectsHintStyle.Builder

Parameters:

aEffectsHints - the effects hints to be added to the style

Returns:

this

elevationMode

public B elevationMode(ILspWorldElevationStyle.ElevationMode aMode)

Description copied from interface: ILspWorldElevationStyle.Builder

Specifies the elevation mode. The default mode depends on the specific implementation.

Specified by:

elevationMode in interface ILspWorldElevationStyle.Builder

Returns:

this

all

public B all(ALspStyle aStyle)

Sets all builder parameters to the properties of the provided style.

Specified by:

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

Parameters:

aStyle - the style to copy

Returns:

this