ilog.views.maps.defense.terrain3d.symbol

Class Ilv3DSymbol

java.lang.Object

ilog.views.maps.defense.terrain3d.symbol.Ilv3DSymbol

public class Ilv3DSymbol
extends Object

The 3D element that displays an SDM node. Users should not have to create instances of this class directly, but rather should use the Ilv3DSymbolManager

Since:

JViews 7.5

Constructor Summary

Constructors

Constructor and Description
Ilv3DSymbol(IlvSDMNode node, BufferedImage image, double ratio) Creates a new 3D Symbol.

Method Summary

Modifier and Type	Method and Description
double	getAltitude() Returns the altitude of the symbol in the current altitude unit.
double	getLatitude() Returns the latitude of the symbol(in radians) transformed from the SDM property.
double	getLongitude() Returns the longitude of the symbol(in radians) transformed from the SDM property.
IlvSDMNode	getNode() Returns the SDM node attached to this 3D symbol.
void	setAltitudePropertyName(String altitudePropertyName) Sets the name of the property to use to retrieve altitude in the symbol node.
void	setAltitudeUnit(IlvLinearUnit altitudeUnit) Sets the unit for the altitude property.
void	setImage(BufferedImage image) Sets the image for this symbol.
void	setLatitudePropertyName(String latitudePropertyName) Sets the name of the property to use to retrieve latitude in the symbol node.
void	setLongitudePropertyName(String longitudePropertyName) Sets the name of the property to use to retrieve longitude in the symbol node.

Methods inherited from class java.lang.Object

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

Constructor Detail

Ilv3DSymbol

public Ilv3DSymbol(IlvSDMNode node,
                   BufferedImage image,
                   double ratio)

Creates a new 3D Symbol.

Parameters:

node - the node to represent

image - the image to use as an icon above the node position image to use to represent symbol.

ratio - a ratio for displaying the image.

Method Detail

getAltitude

public double getAltitude()
                   throws IlvConvertException

Returns the altitude of the symbol in the current altitude unit.

Returns:

Returns the altitude.

Throws:

IlvConvertException

getLatitude

public double getLatitude()
                   throws IlvConvertException

Returns the latitude of the symbol(in radians) transformed from the SDM property.

Returns:

Returns the latitude.

Throws:

IlvConvertException

See Also:

IlvMapRenderer.convertLatLong(Object, boolean), setLatitudePropertyName(String)

getLongitude

public double getLongitude()
                    throws IlvConvertException

Returns the longitude of the symbol(in radians) transformed from the SDM property.

Returns:

Returns the longitude (in radians).

Throws:

IlvConvertException

See Also:

IlvMapRenderer.convertLatLong(Object, boolean), setLongitudePropertyName(String)

setAltitudePropertyName

public void setAltitudePropertyName(String altitudePropertyName)

Sets the name of the property to use to retrieve altitude in the symbol node. Default value is "Altitude".

Parameters:

altitudePropertyName - name of the property.

See Also:

getAltitude()

setAltitudeUnit

public void setAltitudeUnit(IlvLinearUnit altitudeUnit)

Sets the unit for the altitude property.

Parameters:

altitudeUnit - the unit. Default value is IlvLinearUnit.METER.

See Also:

getAltitude()

setImage

public void setImage(BufferedImage image)

Sets the image for this symbol.

Parameters:

image - The image to set.

setLatitudePropertyName

public void setLatitudePropertyName(String latitudePropertyName)

Sets the name of the property to use to retrieve latitude in the symbol node.

Parameters:

latitudePropertyName - name of the property. Default value is IlvMapRenderer.LATITUDE_PROPERTY.

See Also:

getLatitude()

setLongitudePropertyName

public void setLongitudePropertyName(String longitudePropertyName)

Sets the name of the property to use to retrieve longitude in the symbol node.

Parameters:

longitudePropertyName - name of the property. Default value is IlvMapRenderer.LONGITUDE_PROPERTY.

See Also:

getLongitude()

getNode

public IlvSDMNode getNode()

Returns the SDM node attached to this 3D symbol.

Returns:

Returns the SDM node attached to this 3D symbol.