com.luciad.view.lightspeed.style

LuciadFusionClass TLsp3DIconStyle

java.lang.Object

com.luciad.view.lightspeed.style.ALspStyle

com.luciad.view.lightspeed.style.TLsp3DIconStyle

All Implemented Interfaces:

ILspEffectsHintStyle, ILspWorldElevationStyle, ILspStyler

public class TLsp3DIconStyle
extends ALspStyle
implements ILspEffectsHintStyle, ILspWorldElevationStyle

3D Icon style for styling points with 3D icons in 2D and 3D views. Construction of a 3D icon style is done through the Builder design pattern mechanism.

A typical use-case of a TLsp3DIconStyle is to visualize moving tracks, where the icon could be a car, an airplane, ... . Such an icon has a specific orientation. For example, the car should be visualized in such a way that it is driving forwards and not sideways or backwards. LuciadLightspeed assumes a "Z-axis up convention", meaning that the icons should be oriented as illustrated below with an airplane:

• The axis colors on the screen shot are RGB, pointing respectively to the positive XYZ axis.
• The front of the airplane should be pointing in the positive Y-direction (green) in order for the airplane to fly forward.
• The wings of the airplane should be aligned with the X-axis (red) to ensure that the airplane does not fly sideways.

Note that when you want to visualize a moving airplane, it is recommended to let your domain object (or geometry) implement ILcd3DOriented. LuciadLightspeed will then automatically apply the pitch, yaw and roll angles on your airplane icon, making it fly in a very realistic manner. This is illustrated in the samples.lightspeed.icons3d sample.

Since:

2012.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLsp3DIconStyle.Builder<B extends TLsp3DIconStyle.Builder<B>> Builder for 3D icon styles.
static class	TLsp3DIconStyle.ScalingMode Mode that indicates how the icon size is determined.

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

ILspEffectsHintStyle.EffectsHint

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

ILspWorldElevationStyle.ElevationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TLsp3DIconStyle(TLsp3DIconStyle.Builder<?> aBuilder) Creates a new style with the properties that are set on the builder

Method Summary

Modifier and Type	Method and Description
TLsp3DIconStyle.Builder<?>	asBuilder() Creates a new builder initialized with all the properties of this style.
boolean	equals(Object o)
Collection<ILspEffectsHintStyle.EffectsHint>	getEffectsHints() Returns the effects hints specified for this style.
ILspWorldElevationStyle.ElevationMode	getElevationMode() Returns the elevation mode of this style.
ILsp3DIcon	getIcon() Gets the icon.
int	getMinimumPixelSize() Returns the minimum icon size in pixels.
Color	getModulationColor() Gets the color that is modulated with the icon.
float	getOpacity() Gets the opacity of the icon.
int	getPixelSize() Gets the icon size in pixels.
double	getRotationX() Gets the counterclockwise rotation angle in degrees around the X axis.
double	getRotationY() Gets the counterclockwise rotation angle in degrees around the Y axis.
double	getRotationZ() Gets the counterclockwise rotation angle in degrees around the Z axis.
double	getScale() Deprecated.
double	getScaleX() Gets the icon scale factor on the X-axis.
double	getScaleY() Gets the icon scale factor on the Y-axis.
double	getScaleZ() Gets the icon scale factor on the Z-axis.
TLsp3DIconStyle.ScalingMode	getScalingMode() Gets the scaling mode of the icon.
double	getTranslationX() Gets the translation via the X axis
double	getTranslationY() Gets the translation via the Y axis
double	getTranslationZ() Gets the translation via the Z axis
double	getVerticalOffsetFactor() Gets the vertical offset factor of the icon.
double	getWorldSize() Gets the icon world size in meters.
int	hashCode()
boolean	isRecenterIcon() Checks whether or not the painter should recenter icons on the point at which the icons are drawn.
boolean	isTransparent() Determines whether the icon has a transparent surface or not.
static TLsp3DIconStyle.Builder<?>	newBuilder() Creates a new builder with the default values.
String	toString()

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

addStyleChangeListener, getZOrder, isCompatible, removeStyleChangeListener, style

Methods inherited from class java.lang.Object

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

Constructor Detail

TLsp3DIconStyle

protected TLsp3DIconStyle(TLsp3DIconStyle.Builder<?> aBuilder)

Creates a new style with the properties that are set on the builder

Parameters:

aBuilder - a builder which will be used to initialize this style.

Method Detail

newBuilder

public static TLsp3DIconStyle.Builder<?> newBuilder()

Creates a new builder with the default values.

Returns:

the new builder.

asBuilder

public TLsp3DIconStyle.Builder<?> asBuilder()

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

Specified by:

asBuilder in class ALspStyle

Returns:

the new builder.

getIcon

public ILsp3DIcon getIcon()

Gets the icon.

Returns:

the resulting icon

getScale

@Deprecated
public double getScale()

Deprecated.

Gets the icon scale factor.

Returns:

the scale factor

Throws:

IllegalStateException - if the scale factor isn't the same for each axis.

See Also:

TLsp3DIconStyle.ScalingMode

getScaleX

public double getScaleX()

Gets the icon scale factor on the X-axis.

Returns:

the scale factor on the X-axis

See Also:

TLsp3DIconStyle.ScalingMode

getScaleY

public double getScaleY()

Gets the icon scale factor on the Y-axis.

Returns:

the scale factor on the Y-axis

See Also:

TLsp3DIconStyle.ScalingMode

getScaleZ

public double getScaleZ()

Gets the icon scale factor on the Z-axis.

Returns:

the scale factor on the Z-axis

See Also:

TLsp3DIconStyle.ScalingMode

getRotationX

public double getRotationX()

Gets the counterclockwise rotation angle in degrees around the X axis.

Returns:

the rotation angle around the X axis

getRotationY

public double getRotationY()

Gets the counterclockwise rotation angle in degrees around the Y axis.

Returns:

the rotation angle around the X axis

getRotationZ

public double getRotationZ()

Gets the counterclockwise rotation angle in degrees around the Z axis.

Returns:

the rotation angle around the Z axis

getTranslationX

public double getTranslationX()

Gets the translation via the X axis

Returns:

the translation via the X axis.

getTranslationY

public double getTranslationY()

Gets the translation via the Y axis

Returns:

the translation via the Y axis.

getTranslationZ

public double getTranslationZ()

Gets the translation via the Z axis

Returns:

the translation via the Z axis.

getWorldSize

public double getWorldSize()

Gets the icon world size in meters.

Returns:

the world size

See Also:

TLsp3DIconStyle.ScalingMode

getPixelSize

public int getPixelSize()

Gets the icon size in pixels.

Returns:

the pixel size

See Also:

TLsp3DIconStyle.ScalingMode

getMinimumPixelSize

public int getMinimumPixelSize()

Returns the minimum icon size in pixels. This size only affects the style if the scaling mode is set to TLsp3DIconStyle.ScalingMode.WORLD_SCALING . As soon as the largest dimension (i.e. width, height or depth) of the 3D 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.

Returns:

A positive number expressing the minimum icon size in pixels.

getVerticalOffsetFactor

public double getVerticalOffsetFactor()

Gets the vertical offset factor of the icon. This offset factor is used to reposition an icon relative to the point at which it is drawn.

The factor is relative to the size of the icon: a value of 1.0 will shift the icon up by half its height, a value of -1.0 will shift it down by the same distance.

Returns:

the vertical offset factor of the icon

getScalingMode

public TLsp3DIconStyle.ScalingMode getScalingMode()

Gets the scaling mode of the icon.

Returns:

the icon size mode

isTransparent

public boolean isTransparent()

Determines whether the icon has a transparent surface or not.

Specified by:

isTransparent in class ALspStyle

Returns:

whether or not the icon is transparent

isRecenterIcon

public boolean isRecenterIcon()

Checks whether or not the painter should recenter icons on the point at which the icons are drawn.

If true, 3D icons will be translated such that the center of their bounds coincides with the location at which they are being painted.

If false, the origin of the icon's coordinate system will be mapped to the point being painted.

Returns:

true if recentering is enabled, false otherwise

getOpacity

public float getOpacity()

Gets the opacity of the icon.

Returns:

the opacity of the icon

getModulationColor

public Color getModulationColor()

Gets the color that is modulated with the icon. For example using an icon with gray-scale colors and a red modulation color will result in a resulting painted icon with red hues.

Returns:

the modulation color

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

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.

equals

public boolean equals(Object o)

Overrides:

equals in class ALspStyle

hashCode

public int hashCode()

Overrides:

hashCode in class ALspStyle

toString

public String toString()

Overrides:

toString in class Object