TemporalOMPoint (OpenMap API)
Date: 2016-12-09

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bbn.openmap.omGraphics.time
Class TemporalOMPoint

    java.lang.Object
      com.bbn.openmap.omGraphics.geom.BasicGeometry
          com.bbn.openmap.omGraphics.OMGraphicAdapter
              com.bbn.openmap.omGraphics.OMPoint
                  com.bbn.openmap.omGraphics.time.TemporalOMPoint

All Implemented Interfaces:
  OMGeometry, OMGraphic, OMGraphicConstants, TemporalOMGraphic, java.io.Serializable, java.lang.Cloneable

    public class TemporalOMPoint

extends OMPoint
implements TemporalOMGraphic

A ScenarioPoint is a ScenarioGraphic representing an object on the map. It takes TimeStamps and works out its location for a specific time, or it can also represent its plan for the entire scenario. If the URL provided for the point is not available, it will describe itself as an OMPoint. ScenarioPoint is a Location, however, so any location marker OMGraphic can be used. Make sure setGraphicLocations is updated if the marker OMGraphic is something other than OMPoint or OMRaster.

See Also:
  Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.bbn.openmap.omGraphics.OMPoint
`OMPoint.Image`

Field Summary
`protected java.lang.Object` | `id`
`protected boolean` | `interpolate` Flag to indicate that intermediate positions between locations should be interpolated.
`protected TemporalPointSupport` | `timeStamps` A list of points where this point should be.

Fields inherited from class com.bbn.openmap.omGraphics.OMPoint
`DEFAULT_ISOVAL, DEFAULT_RADIUS, lat1, lon1, oval, radius, x, y`

Fields inherited from class com.bbn.openmap.omGraphics.OMGraphicAdapter
`declutterType, displayPaint, edgeMatchesFill, fillPaint, hasLabel, linePaint, matted, mattingPaint, renderType, selected, selectPaint, showEditablePalette, stroke, textureMask`

Fields inherited from class com.bbn.openmap.omGraphics.geom.BasicGeometry
`attributes, lineType, needToRegenerate, shape, visible`

Fields inherited from interface com.bbn.openmap.omGraphics.OMGraphicConstants
`ADD_GRAPHIC_MASK, APP_OBJECT, BASIC_STROKE, CHANGE_APPEARANCE, clear, DECIMAL_DEGREES, DECLUTTERTYPE_LINE, DECLUTTERTYPE_MOVE, DECLUTTERTYPE_NONE, DECLUTTERTYPE_SPACE, DEFAULT_ROTATIONANGLE, DELETE_GRAPHIC_MASK, DESELECT_GRAPHIC_MASK, DESELECTALL_GRAPHIC_MASK, GRAPHICTYPE_ARC, GRAPHICTYPE_BITMAP, GRAPHICTYPE_CIRCLE, GRAPHICTYPE_ELLIPSE, GRAPHICTYPE_GRAPHIC, GRAPHICTYPE_GRID, GRAPHICTYPE_LINE, GRAPHICTYPE_POINT, GRAPHICTYPE_POLY, GRAPHICTYPE_RASTER, GRAPHICTYPE_RECTANGLE, GRAPHICTYPE_TEXT, INDEX, INFOLINE, LABEL, LINETYPE_GREATCIRCLE, LINETYPE_RHUMB, LINETYPE_STRAIGHT, LINETYPE_UNKNOWN, LOWER_GRAPHIC_MASK, LOWER_TO_BOTTOM_GRAPHIC_MASK, NO_ROTATE, OMGRAPHIC_ELT, OMGRAPHIC_TYPE_ATTR, RADIANS, RAISE_GRAPHIC_MASK, RAISE_TO_TOP_GRAPHIC_MASK, REMOVABLE, RENDERTYPE_LATLON, RENDERTYPE_OFFSET, RENDERTYPE_UNKNOWN, RENDERTYPE_XY, SELECT_GRAPHIC_MASK, SORT_GRAPHICS_MASK, TOOLTIP, UPDATE_GRAPHIC_MASK, UPDATED`

Constructor Summary
`TemporalOMPoint(java.lang.Object id, int renderType, boolean interpolate)` Create a ScenarioLocation at a latitude/longitude location.

Method Summary
`void` | `addTimeStamp(TemporalRecord timeStamp)` Add a TimeStamp to the point.
`void` | `clearTimeStamps()` Clear all time stamps.
`void` | `generate(Projection p, long time)` Prepare the ScenarioPoint to be rendered in its position at a certain time.
`java.lang.Object` | `getId()`
`boolean` | `isInterpolate()`
`boolean` | `removeTimeStamp(TemporalRecord timeStamp)` Remove a location at a certain time.
`void` | `setId(java.lang.Object id)`
`void` | `setInterpolate(boolean interpolate)`
`TemporalPoint` | `setPosition(long time)` Given a time, figure out the location.
`boolean` | `thisIsYou(java.lang.Object n)` Checks the internal id against the given one.

Methods inherited from class com.bbn.openmap.omGraphics.OMPoint
`generate, getLat, getLon, getRadius, getX, getY, hasLineTypeChoice, isOval, restore, set, set, set, setLat, setLon, setOval, setRadius, setX, setY`

Methods inherited from class com.bbn.openmap.omGraphics.OMGraphicAdapter
`clone, deselect, distance, getDeclutterType, getDisplayColor, getDisplayPaint, getEdgeMatchesFill, getFillColor, getFillPaint, getHasLabel, getLineColor, getLinePaint, getMattingPaint, getRenderType, getSelectColor, getSelectPaint, getShowEditablePalette, getStroke, getTextureMask, initLabelingDuringGenerate, isClear, isMatted, isSelected, normalizeDistanceForLineWidth, readStroke, readTextureMask, regenerate, render, renderLabel, renderShape, select, setDeclutterType, setEdgeMatchesFill, setFillColor, setFillPaint, setGraphicsColor, setGraphicsForEdge, setGraphicsForFill, setHasLabel, setLabelLocation, setLabelLocation, setLabelLocation, setLabelLocation, setLabelLocation, setLabelLocation, setLabelLocation, setLabelLocation, setLineColor, setLinePaint, setMatted, setMattingPaint, setRenderType, setSelectColor, setSelected, setSelectPaint, setShowEditablePalette, setStroke, setTextureMask, shouldRenderEdge, shouldRenderFill, writeStroke, writeTextureMask`

Methods inherited from class com.bbn.openmap.omGraphics.geom.BasicGeometry
`_distance, appendShapeEdge, appendShapeEdge, appendShapeEdge, appendShapeEdge, clearAttributes, contains, createAttributeMap, createBoxShape, createShape, createShape, describeShapeDetail, describeShapeDetail, distanceToEdge, distanceToEdge, draw, draw, fill, fill, getAppObject, getAttribute, getAttributes, getDescription, getLineType, getNeedToRegenerate, getShape, isRenderable, isRenderable, isVisible, putAttribute, removeAttribute, setAppObject, setAttributes, setLineType, setNeedToRegenerate, setShape, setVisible`

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

Methods inherited from interface com.bbn.openmap.omGraphics.OMGraphic
`clone, deselect, getDeclutterType, getDisplayColor, getDisplayPaint, getFillColor, getFillPaint, getLineColor, getLinePaint, getMattingPaint, getRenderType, getSelectColor, getSelectPaint, getShowEditablePalette, getStroke, getTextureMask, hasLineTypeChoice, isMatted, isSelected, normalizeDistanceForLineWidth, regenerate, renderLabel, select, setDeclutterType, setFillPaint, setGraphicsColor, setGraphicsForEdge, setGraphicsForFill, setLabelLocation, setLabelLocation, setLabelLocation, setLinePaint, setMatted, setMattingPaint, setRenderType, setSelected, setSelectPaint, setShowEditablePalette, setStroke, setTextureMask, shouldRenderEdge, shouldRenderFill`

Methods inherited from interface com.bbn.openmap.omGraphics.OMGeometry
`clearAttributes, contains, distance, distanceToEdge, draw, draw, fill, fill, generate, getAppObject, getAttribute, getAttributes, getDescription, getLineType, getNeedToRegenerate, getShape, isRenderable, isRenderable, isVisible, putAttribute, removeAttribute, render, restore, setAppObject, setAttributes, setLineType, setNeedToRegenerate, setShape, setVisible`

Field Detail

### id

    protected java.lang.Object id

### timeStamps

    protected TemporalPointSupport timeStamps

  A list of points where this point should be.

### interpolate

    protected boolean interpolate

  Flag to indicate that intermediate positions between locations should be interpolated.

Constructor Detail

### TemporalOMPoint

    public TemporalOMPoint(java.lang.Object id,
                           int renderType,
                           boolean interpolate)

  Create a ScenarioLocation at a latitude/longitude location.

  Parameters:
    `id` - the identifier for the location.

Method Detail

### getId

    public java.lang.Object getId()

### setId

    public void setId(java.lang.Object id)

### isInterpolate

    public boolean isInterpolate()

### setInterpolate

    public void setInterpolate(boolean interpolate)

### thisIsYou

    public boolean thisIsYou(java.lang.Object n)

  Checks the internal id against the given one.

### addTimeStamp

    public void addTimeStamp(TemporalRecord timeStamp)

  Add a TimeStamp to the point.

  Specified by:
    `addTimeStamp` in interface `TemporalOMGraphic`

### removeTimeStamp

    public boolean removeTimeStamp(TemporalRecord timeStamp)

  Description copied from interface: `TemporalOMGraphic`
  Remove a location at a certain time.

  Specified by:
    `removeTimeStamp` in interface `TemporalOMGraphic`

### clearTimeStamps

    public void clearTimeStamps()

  Description copied from interface: `TemporalOMGraphic`
  Clear all time stamps.

  Specified by:
    `clearTimeStamps` in interface `TemporalOMGraphic`

### setPosition

    public TemporalPoint setPosition(long time)

  Given a time, figure out the location. If the time is before the earliest time or after the latest time, the location will be set to the first or last known location, but the marker will made invisible. If the time is in between the first and last time, the position will be interpolated.

### generate

    public void generate(Projection p,
                         long time)

  Prepare the ScenarioPoint to be rendered in its position at a certain time.

  Specified by:
    `generate` in interface `TemporalOMGraphic`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright (C) BBNT Solutions LLC; See http://openmap.bbn.com/ for details