Ilv3DSymbolStyle (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.maps.defense.terrain3d.symbol.Ilv3DSymbolStyle

All Implemented Interfaces:

IlvPersistentObject, Serializable
```
public class Ilv3DSymbolStyle
extends Object
implements IlvPersistentObject
```
Style class used to regroup all style display preferences.

Since:

JViews 7.5

See Also:

Usually, this style is created throuigh the use of an {@link ilog.views.maps.defense.terrain3d.view.Ilv3DViewBoundsDataSource}, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Ilv3DSymbolStyle()
Creates a new Ilv3DSymbolStyle.

Ilv3DSymbolStyle(IlvInputStream stream)
Creates a new Ilv3DSymbolStyle.

Constructors
Constructor and Description
`Ilv3DSymbolStyle()` Creates a new `Ilv3DSymbolStyle`.
`Ilv3DSymbolStyle(IlvInputStream stream)` Creates a new `Ilv3DSymbolStyle`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Color`	`getGroundImprintColor()` Returns the ground Imprint line Color.
`double`	`getIconOffsetAbovePoint()` Returns the offset in meters of the icon above the real position.
`Color`	`getPointColor()` Returns the point color.
`boolean`	`isPreciseImage()` Indicates whether or not the number of pixels in the symbol image size should be doubled.
`boolean`	`isShowGroundImprintLine()` Indicates whether or not ground imprint line is shown.
`boolean`	`isShowSymbolIcon()` Indicates whether or not the symbol icon should be displayed.
`boolean`	`isShowSymbolPoint()` Indicates whether or not symbol point (real position) is shown
`boolean`	`isSymbolsOrdered()` Indicates whether or not symbols should use depth buffer (and can be hidden by terrain).
`void`	`setGroundImprintColor(Color groundImprintColor)` Determines the color of the ground imprint line.
`void`	`setIconOffsetAbovePoint(double iconOffsetAbovePoint)` The icon can be moved above the real symbol position, by defining this offset.
`void`	`setPointColor(Color pointColor)` Determines the color to use to display points.
`void`	`setPreciseImage(boolean preciseImage)` Determines if the number of pixels in the symbol image size should be doubled.
`void`	`setShowGroundImprintLine(boolean showGroundImprintLine)` Determines whether or not the ground imprint line should be displayed.
`void`	`setShowSymbolIcon(boolean showSymbolIcon)` Determines whether or not the symbol icon should be displayed.
`void`	`setShowSymbolPoint(boolean showSymbolPoint)` Determines whether or not the symbol point (real position) should be displayed.
`void`	`setSymbolsOrdered(boolean symbolsOrdered)` Determines whether or not symbols should use depth buffer (and can be hidden by terrain).
`void`	`write(IlvOutputStream stream)` Writes the attributes of a persistent object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Ilv3DSymbolStyle
```
public Ilv3DSymbolStyle()
```
    Creates a new Ilv3DSymbolStyle.
  - Ilv3DSymbolStyle
```
public Ilv3DSymbolStyle(IlvInputStream stream)
                 throws IlvReadFileException
```
    Creates a new Ilv3DSymbolStyle.
    
    Parameters:
    
    stream - stream to read parameters from.
    
    Throws:
    
    IlvReadFileException
- Method Detail
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the attributes of a persistent object.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Parameters:
    
    stream - the output stream
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.
    
    See Also:
    
    IlvPersistentObject.write(ilog.views.io.IlvOutputStream)
  - getGroundImprintColor
```
public Color getGroundImprintColor()
```
    Returns the ground Imprint line Color.
    
    Returns:
    
    the ground Imprint line Color.
  - getIconOffsetAbovePoint
```
public double getIconOffsetAbovePoint()
```
    Returns the offset in meters of the icon above the real position.
    
    Returns:
    
    the offset in meters of the icon above the real position.
  - getPointColor
```
public Color getPointColor()
```
    Returns the point color.
    
    Returns:
    
    the point color.
  - isPreciseImage
```
public boolean isPreciseImage()
```
    Indicates whether or not the number of pixels in the symbol image size should be doubled.
    
    Returns:
    
    true if the symbol should have a more precise image.
  - isShowGroundImprintLine
```
public boolean isShowGroundImprintLine()
```
    Indicates whether or not ground imprint line is shown.
    
    Returns:
    
    true if ground imprint line is shown.
  - isShowSymbolIcon
```
public boolean isShowSymbolIcon()
```
    Indicates whether or not the symbol icon should be displayed.
    
    Returns:
    
    true if the symbol icon should be displayed..
  - isShowSymbolPoint
```
public boolean isShowSymbolPoint()
```
    Indicates whether or not symbol point (real position) is shown
    
    Returns:
    
    true if symbol point (real position) is shown.
  - isSymbolsOrdered
```
public boolean isSymbolsOrdered()
```
    Indicates whether or not symbols should use depth buffer (and can be hidden by terrain).
    
    Returns:
    
    true if symbols should use depth buffer.
  - setGroundImprintColor
```
public void setGroundImprintColor(Color groundImprintColor)
```
    Determines the color of the ground imprint line.
    
    Parameters:
    
    groundImprintColor - The ground imprint line Color to set.
  - setIconOffsetAbovePoint
```
public void setIconOffsetAbovePoint(double iconOffsetAbovePoint)
```
    The icon can be moved above the real symbol position, by defining this offset. Default value is 200.
    
    Parameters:
    
    iconOffsetAbovePoint - the offset in meters of the icon above the real position.
  - setPointColor
```
public void setPointColor(Color pointColor)
```
    Determines the color to use to display points.
    
    Parameters:
    
    pointColor - The point color to set.
  - setPreciseImage
```
public void setPreciseImage(boolean preciseImage)
```
    Determines if the number of pixels in the symbol image size should be doubled.
    
    Parameters:
    
    preciseImage - true to have a more precise symbol icon.
  - setShowGroundImprintLine
```
public void setShowGroundImprintLine(boolean showGroundImprintLine)
```
    Determines whether or not the ground imprint line should be displayed.
    
    Parameters:
    
    showGroundImprintLine - true to display the ground imprint line.
  - setShowSymbolIcon
```
public void setShowSymbolIcon(boolean showSymbolIcon)
```
    Determines whether or not the symbol icon should be displayed.
    
    Parameters:
    
    showSymbolIcon - true to display the symbol icon.
  - setShowSymbolPoint
```
public void setShowSymbolPoint(boolean showSymbolPoint)
```
    Determines whether or not the symbol point (real position) should be displayed.
    
    Parameters:
    
    showSymbolPoint - true to display the symbol point.
  - setSymbolsOrdered
```
public void setSymbolsOrdered(boolean symbolsOrdered)
```
    Determines whether or not symbols should use depth buffer (and can be hidden by terrain).
    
    Parameters:
    
    symbolsOrdered - True if symbols use the depth buffer.

Class Ilv3DSymbolStyle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ilv3DSymbolStyle

Ilv3DSymbolStyle

Method Detail

write

getGroundImprintColor

getIconOffsetAbovePoint

getPointColor

isPreciseImage

isShowGroundImprintLine

isShowSymbolIcon

isShowSymbolPoint

isSymbolsOrdered

setGroundImprintColor

setIconOffsetAbovePoint

setPointColor

setPreciseImage

setShowGroundImprintLine

setShowSymbolIcon

setShowSymbolPoint

setSymbolsOrdered