Ilv3DLabel (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.maps.defense.terrain3d.component.Ilv3DLabel

All Implemented Interfaces:

Ilv3DComponent
```
public class Ilv3DLabel
extends Object
implements Ilv3DComponent
```
This class is a 2D label always facing the camera.

Since:

JViews 8.0

Constructor Summary

Constructors
Constructor and Description
`Ilv3DLabel(double centerLongitude, double centerLatitude, double centerElevation, String text, Font font)` Constructs an `Ilv3DLabel` with the specified parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`display(GL2 gl, Ilv3DCoordinateConverter converter)` Draws this component inside the specified OpenGL GL context object.
`Color`	`getBackgroundColor()` Returns the text color of this component.
`double`	`getCenterElevation()` Returns the elevation of the center of this component.
`double`	`getCenterLatitude()` Returns the latitude of the center of this component.
`double`	`getCenterLongitude()` Returns the longitude of the center of this component.
`Font`	`getFont()` Returns the font used to draw this label component.
`int`	`getHorizontalOffset()` Returns the horizontal offset between the anchor of the label and the text itself.
`double`	`getOutlineWidth()` Returns the width of the outline of the label (used only when this mode is activated).
`String`	`getText()` Returns the text of this label component.
`Color`	`getTextColor()` Returns the text color of this component.
`int`	`getVerticalOffset()` Returns the vertical offset between the anchor of the label and the text itself.
`boolean`	`isDrawLabelOutline()` Returns whether the outline of the label is drawn or not.
`boolean`	`isOpaqueLabelBackground()` Returns whether the rectangular background of the label should be opaque or not.
`boolean`	`isUseTextAntialiasing()` Returns whether the text is drawn using antialiasing or not.
`void`	`setBackgroundColor(Color color)` Sets the text color of this component.
`void`	`setDrawLabelOutline(boolean drawLabelOutline)` Sets whether the outline of the label is drawn or not.
`void`	`setFont(Font font)` Sets the font used to draw this label component.
`void`	`setHorizontalOffset(int horizontalOffset)` Sets the horizontal offset between the anchor of the label and the text itself.
`void`	`setOpaqueLabelBackground(boolean opaqueLabelBackground)` Sets whether the rectangular background of the label should be opaque or not.
`void`	`setOutlineWidth(double outlineWidth)` Sets the width of the outline of the label (used only when this mode is activated).
`void`	`setText(String text)` Sets the text of this label component.
`void`	`setTextColor(Color color)` Sets the text color of this component.
`void`	`setUseTextAntialiasing(boolean useTextAntialiasing)` Sets whether the text is drawn using antialiasing or not.
`void`	`setVerticalOffset(int verticalOffset)` Sets the vertical offset between the anchor of the label and the text itself.

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

- Constructor Detail
  - Ilv3DLabel
```
public Ilv3DLabel(double centerLongitude,
                  double centerLatitude,
                  double centerElevation,
                  String text,
                  Font font)
```
    Constructs an Ilv3DLabel with the specified parameters.
    
    Parameters:
    
    centerLongitude - The longitude of the anchor point of the label in radians.
    
    centerLatitude - The latitude of the anchor point of the label in radians.
    
    centerElevation - The altitude of the anchor point of hte label in meters.
    
    text - The text to display.
    
    font - The font used to draw the label.
- Method Detail
  - getCenterLongitude
```
public double getCenterLongitude()
```
    Returns the longitude of the center of this component.
    
    Specified by:
    
    getCenterLongitude in interface Ilv3DComponent
    
    Returns:
    
    The longitude of the center of this component in radians.
  - getCenterLatitude
```
public double getCenterLatitude()
```
    Returns the latitude of the center of this component.
    
    Specified by:
    
    getCenterLatitude in interface Ilv3DComponent
    
    Returns:
    
    The latitude of the center of this component in radians.
  - getCenterElevation
```
public double getCenterElevation()
```
    Returns the elevation of the center of this component.
    
    Specified by:
    
    getCenterElevation in interface Ilv3DComponent
    
    Returns:
    
    The elevation of the center of this component in meters.
  - getTextColor
```
public Color getTextColor()
```
    Returns the text color of this component.
    
    Returns:
    
    The java.awt.Color of this component.
  - setTextColor
```
public void setTextColor(Color color)
```
    Sets the text color of this component.
    
    Parameters:
    
    color - The java.awt.Color to set.
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    Returns the text color of this component.
    
    Returns:
    
    The java.awt.Color of this component.
  - setBackgroundColor
```
public void setBackgroundColor(Color color)
```
    Sets the text color of this component.
    
    Parameters:
    
    color - The java.awt.Color to set.
  - getFont
```
public Font getFont()
```
    Returns the font used to draw this label component.
    
    Returns:
    
    The font used to draw the label component.
  - setFont
```
public void setFont(Font font)
```
    Sets the font used to draw this label component.
    
    Parameters:
    
    font - The font used to draw this label component.
  - getText
```
public String getText()
```
    Returns the text of this label component.
    
    Returns:
    
    The text used to draw this label component.
  - setText
```
public void setText(String text)
```
    Sets the text of this label component.
    
    Parameters:
    
    text - The text to used to draw this label component.
  - display
```
public void display(GL2 gl,
                    Ilv3DCoordinateConverter converter)
```
    Draws this component inside the specified OpenGL GL context object. The context is centered on the center of the component and any drawing must be done in 3D space coordinates, which are computed through the use of the Ilv3DCoordinateConverter provided.
    
    Specified by:
    
    display in interface Ilv3DComponent
    
    Parameters:
    
    gl - The OpenGL context.
    
    converter - The Ilv3DCoordinateConverter from geographic coordinates to 3D coordinates.
    
    See Also:
    
    Ilv3DCoordinateConverter
  - isOpaqueLabelBackground
```
public boolean isOpaqueLabelBackground()
```
    Returns whether the rectangular background of the label should be opaque or not.
    
    Returns:
    
    If true, the background is filled.
  - setOpaqueLabelBackground
```
public void setOpaqueLabelBackground(boolean opaqueLabelBackground)
```
    Sets whether the rectangular background of the label should be opaque or not. Note that enabling this mode automatically disables label outline drawing.
    
    Parameters:
    
    opaqueLabelBackground - If true, the background is filled.
  - isUseTextAntialiasing
```
public boolean isUseTextAntialiasing()
```
    Returns whether the text is drawn using antialiasing or not.
    
    Returns:
    
    If true, the text is drawn using antialiasing.
  - setUseTextAntialiasing
```
public void setUseTextAntialiasing(boolean useTextAntialiasing)
```
    Sets whether the text is drawn using antialiasing or not.
    
    Parameters:
    
    useTextAntialiasing - If true, the text is drawn using antialiasing.
  - isDrawLabelOutline
```
public boolean isDrawLabelOutline()
```
    Returns whether the outline of the label is drawn or not.
    
    Returns:
    
    If true, the outline of the label is drawn.
  - setDrawLabelOutline
```
public void setDrawLabelOutline(boolean drawLabelOutline)
```
    Sets whether the outline of the label is drawn or not. Note that enabling this mode automatically disables opaque background drawing.
    
    Parameters:
    
    drawLabelOutline - If true, the label's outline is drawn.
  - getOutlineWidth
```
public double getOutlineWidth()
```
    Returns the width of the outline of the label (used only when this mode is activated).
    
    Returns:
    
    The width of the outline of the label.
  - setOutlineWidth
```
public void setOutlineWidth(double outlineWidth)
```
    Sets the width of the outline of the label (used only when this mode is activated).
    
    Parameters:
    
    outlineWidth - The width of the outline of the label.
  - getHorizontalOffset
```
public int getHorizontalOffset()
```
    Returns the horizontal offset between the anchor of the label and the text itself.
    
    Returns:
    
    The horizontal offset in pixels.
  - setHorizontalOffset
```
public void setHorizontalOffset(int horizontalOffset)
```
    Sets the horizontal offset between the anchor of the label and the text itself.
    
    Parameters:
    
    horizontalOffset - The horizontal offset in pixels.
  - getVerticalOffset
```
public int getVerticalOffset()
```
    Returns the vertical offset between the anchor of the label and the text itself.
    
    Returns:
    
    The vertical offset in pixels.
  - setVerticalOffset
```
public void setVerticalOffset(int verticalOffset)
```
    Sets the vertical offset between the anchor of the label and the text itself.
    
    Parameters:
    
    verticalOffset - The vertical offset in pixels.

Class Ilv3DLabel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ilv3DLabel

Method Detail

getCenterLongitude

getCenterLatitude

getCenterElevation

getTextColor

setTextColor

getBackgroundColor

setBackgroundColor

getFont

setFont

getText

setText

display

isOpaqueLabelBackground

setOpaqueLabelBackground

isUseTextAntialiasing

setUseTextAntialiasing

isDrawLabelOutline

setDrawLabelOutline

getOutlineWidth

setOutlineWidth

getHorizontalOffset

setHorizontalOffset

getVerticalOffset

setVerticalOffset