AbstractTacticalSymbol.OrderedSymbol (NASA WorldWind)

java.lang.Object
- gov.nasa.worldwind.symbology.AbstractTacticalSymbol.OrderedSymbol

All Implemented Interfaces:: OrderedRenderable, Renderable

Enclosing class:: AbstractTacticalSymbol

protected class AbstractTacticalSymbol.OrderedSymbol
extends java.lang.Object
implements OrderedRenderable

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`dx` Per-frame screen offset indicating this symbol's x-offset relative to the screenPoint.
`double`	`dy` Per-frame screen offset indicating this symbol's y-offset relative to the screenPoint.
`double`	`eyeDistance` Per-frame distance corresponding to the distance between the placePoint and the View's eye point.
`java.awt.Rectangle`	`iconRectScaled` iconRect with scaling applied, used to lay out text.
`java.awt.Rectangle`	`layoutRect`
`java.awt.Rectangle`	`layoutRectScaled` layoutRect with scaling applied, used to lay out text.
`Vec4`	`placePoint` Per-frame Cartesian point corresponding to this symbol's position.
`Vec4`	`screenPoint` Per-frame screen point corresponding to the projection of the placePoint in the viewport (on the screen).
`java.awt.Rectangle`	`screenRect`
`double`	`sx` Per-frame screen scale indicating this symbol's x-scale relative to the screen offset.
`double`	`sy` Per-frame screen scale indicating this symbol's y-scale relative to the screen offset.

Constructor Summary

Constructors
Modifier Constructor and Description

protected OrderedSymbol()

Constructors
Modifier	Constructor and Description
`protected`	`OrderedSymbol()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`doDrawOrderedRenderable(DrawContext dc, PickSupport pickCandidates)`
`double`	`getDistanceFromEye()` Returns the ordered renderable's distance from the current view's eye point.
`Layer`	`getPickLayer()`
`boolean`	`isEnableBatchPicking()`
`boolean`	`isEnableBatchRendering()`
`void`	`pick(DrawContext dc, java.awt.Point pickPoint)` Executes a pick of the ordered renderable.
`void`	`render(DrawContext dc)` Causes this `Renderable` to render itself using the provided draw context.

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

- Field Detail
  - dx
```
public double dx
```
    Per-frame screen offset indicating this symbol's x-offset relative to the screenPoint. Calculated each frame in AbstractTacticalSymbol.computeTransform(gov.nasa.worldwind.render.DrawContext, gov.nasa.worldwind.symbology.AbstractTacticalSymbol.OrderedSymbol). Initially 0.
  - dy
```
public double dy
```
    Per-frame screen offset indicating this symbol's y-offset relative to the screenPoint. Calculated each frame in AbstractTacticalSymbol.computeTransform(gov.nasa.worldwind.render.DrawContext, gov.nasa.worldwind.symbology.AbstractTacticalSymbol.OrderedSymbol). Initially 0.
  - eyeDistance
```
public double eyeDistance
```
    Per-frame distance corresponding to the distance between the placePoint and the View's eye point. Used to order the symbol as an ordered renderable, and is returned by getDistanceFromEye. Calculated each frame in AbstractTacticalSymbol.computeSymbolPoints(gov.nasa.worldwind.render.DrawContext, gov.nasa.worldwind.symbology.AbstractTacticalSymbol.OrderedSymbol). Initially 0.
  - iconRectScaled
```
public java.awt.Rectangle iconRectScaled
```
    iconRect with scaling applied, used to lay out text.
  - layoutRect
```
public java.awt.Rectangle layoutRect
```
  - layoutRectScaled
```
public java.awt.Rectangle layoutRectScaled
```
    layoutRect with scaling applied, used to lay out text.
  - placePoint
```
public Vec4 placePoint
```
    Per-frame Cartesian point corresponding to this symbol's position. Calculated each frame in AbstractTacticalSymbol.computeSymbolPoints(gov.nasa.worldwind.render.DrawContext, gov.nasa.worldwind.symbology.AbstractTacticalSymbol.OrderedSymbol). Initially null.
  - screenPoint
```
public Vec4 screenPoint
```
    Per-frame screen point corresponding to the projection of the placePoint in the viewport (on the screen). Calculated each frame in AbstractTacticalSymbol.computeSymbolPoints(gov.nasa.worldwind.render.DrawContext, gov.nasa.worldwind.symbology.AbstractTacticalSymbol.OrderedSymbol). Initially null.
  - screenRect
```
public java.awt.Rectangle screenRect
```
  - sx
```
public double sx
```
    Per-frame screen scale indicating this symbol's x-scale relative to the screen offset. Calculated each frame in AbstractTacticalSymbol.computeTransform(gov.nasa.worldwind.render.DrawContext, gov.nasa.worldwind.symbology.AbstractTacticalSymbol.OrderedSymbol). Initially 0.
  - sy
```
public double sy
```
    Per-frame screen scale indicating this symbol's y-scale relative to the screen offset. Calculated each frame in AbstractTacticalSymbol.computeTransform(gov.nasa.worldwind.render.DrawContext, gov.nasa.worldwind.symbology.AbstractTacticalSymbol.OrderedSymbol). Initially 0.
- Constructor Detail
  - OrderedSymbol
```
protected OrderedSymbol()
```
- Method Detail
  - doDrawOrderedRenderable
```
protected void doDrawOrderedRenderable(DrawContext dc,
                                       PickSupport pickCandidates)
```
  - getDistanceFromEye
```
public double getDistanceFromEye()
```
    Description copied from interface: OrderedRenderable
    
    Returns the ordered renderable's distance from the current view's eye point. Intended to be used only to sort a list of ordered renderables according to eye distance, and only during frame generation when a view is active.
    
    Specified by:
    
    getDistanceFromEye in interface OrderedRenderable
    
    Returns:
    
    the distance of the ordered renderable from the current view's eye point.
  - getPickLayer
```
public Layer getPickLayer()
```
  - isEnableBatchPicking
```
public boolean isEnableBatchPicking()
```
  - isEnableBatchRendering
```
public boolean isEnableBatchRendering()
```
  - pick
```
public void pick(DrawContext dc,
                 java.awt.Point pickPoint)
```
    Description copied from interface: OrderedRenderable
    
    Executes a pick of the ordered renderable.
    
    Specified by:
    
    pick in interface OrderedRenderable
    
    Parameters:
    
    dc - the current draw context.
    
    pickPoint - the pick point.
  - render
```
public void render(DrawContext dc)
```
    Description copied from interface: Renderable
    
    Causes this Renderable to render itself using the provided draw context.
    
    Specified by:
    
    render in interface Renderable
    
    Parameters:
    
    dc - the DrawContext to be used
    
    See Also:
    
    DrawContext

Class AbstractTacticalSymbol.OrderedSymbol

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dx

dy

eyeDistance

iconRectScaled

layoutRect

layoutRectScaled

placePoint

screenPoint

screenRect

sx

sy

Constructor Detail

OrderedSymbol

Method Detail

doDrawOrderedRenderable

getDistanceFromEye

getPickLayer

isEnableBatchPicking

isEnableBatchRendering

pick

render