ShapeGISMap (AnyLogic 6 Engine API)

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.xj.anylogic.engine.presentation
Class ShapeGISMap

java.lang.Object
  com.xj.anylogic.engine.presentation.Shape
      com.xj.anylogic.engine.AbstractShapeGISMap
          com.xj.anylogic.engine.presentation.ShapeGISMap

All Implemented Interfaces:: com.xj.anylogic.engine.internal.Child, Locatable2D, java.io.Serializable, java.lang.Cloneable

public class ShapeGISMap
extends AbstractShapeGISMap
extends AbstractShapeGISMap

GIS map projection manager and map renderer (persistent GIS Map shape which displays and map projection)
GIS map is a Shape and it can be placed on the model animation: it renders the associated map projection on the screen
This class provides several projection methods

General information:
Coordinates of any point are presented as:

the longitude of point, measured in degrees (-180 ... (West) ... 0 ... (East) ... +180)
the latitude of point, measured in degrees (-90 ... (South) ... 0 ... (North) ... +90)

The following order of coordinates is assumed: (longitude, latitude), uniformly with (x, y)
Implementation is based on OpenMap GIS

This object is only available in the AnyLogic Professional

Author:: XJ Technologies Company Ltd. www.anylogic.com
See Also:: Serialized Form

Nested Class Summary
`static class`	`ShapeGISMap.Layer` Class which stores GIS map layer information

Field Summary

Fields inherited from class com.xj.anylogic.engine.presentation.Shape
`UNKNOWN_NAME`

Constructor Summary
`ShapeGISMap(Presentable presentable, boolean ispublic, double x, double y, double width, double height, java.lang.String packagePrefix, ShapeGISMap.Layer[] layers, double centerLongitude, double centerLatitude, double mapScale, java.awt.Color mapBorderColor, java.awt.Color mapBackgroundColor)` Constructs a GIS Map shape with specific attributes.

Method Summary
`boolean`	`contains(double px, double py)` Test if the shape contains the point with the given coordinates (relative to this shape's container, i.e. in the same system with the coordinates of this shape, x and y)
`double`	`convertRotationAngleForward(double longitude, double latitude, double angle)` Creates forward projection of the given rotation angle (direction) at the given point, to screen and returns rotation angle in screen coordinates
`double`	`convertXForward(double longitude, double latitude)` Creates forward projection of the given point to screen and returns x-coordinate
`double`	`convertYForward(double longitude, double latitude)` Creates forward projection of the given point to screen and returns y-coordinate
`float[]`	`createTrajectory(double lonFrom, double latFrom, double lonTo, double latTo)` Creates shortest path between two given points and returns it as polyline with N (=512) segments, as array of length 2(N+1) First number in array is always 0, next numbers are (lon, lat)-pairs of polyline nodes, including beginning and end This method is not designed to be called by user
`void`	`destroy()`
`void`	`draw(Panel panel, java.awt.Graphics2D g, java.awt.geom.AffineTransform xform, boolean publicOnly)` Draws the shape in a given context
`double`	`getCenterLatitude()` Returns the latitude of the map projection center, measured in degrees (-90 ...
`double`	`getCenterLongitude()` Returns the longitude of the map projection center, measured in degrees (-180 ...
`double`	`getDistance(double lonFrom, double latFrom, double lonTo, double latTo)` Returns distance, in meters, between 2 given points
`double`	`getHeight()` Returns the height of the shape.
`ShapeGISMap.Layer[]`	`getLayers()` Returns the array of layers used in this GIS Map Returned array shouldn't be modified structurally: only items can be accessed for modification
`double`	`getMapScale()` Returns the scale of map projection
`double`	`getMaxMapScale()` Returns the maximum available scale of the map projection
`double`	`getMinMapScale()` Returns the minimum available scale of the map projection
`Presentable`	`getPresentable()` Returns the Presentable object (ActiveObject or Experiment) where this shape belongs to, or null.
`double`	`getWidth()` Returns the width of the shape.
`boolean`	`onClickAt(double px, double py, boolean publicOnly)` Tests if the GIS map contains the point with the given coordinates and, if yes, executes the reaction on click at that point.
`void`	`pan(int toEast, int toNorth)` Moves the map projection center Parameters are amounts of delta in the resulting offset One horizontal delta is a half of longitude difference from map projection center to the west/east bound of projection One vertical delta is a half of latitude difference from map projection center to the south/north bound of projection
`boolean`	`projectionContains(double longitude, double latitude)` Returns `true` if the projection of the given point to screen is visible on this map
`void`	`requestRedraw()` Schedules projection recreation and map image rendering to the next animation update
`void`	`restoreOwner(java.lang.Object owner)` This method normally should not be called by user This method restores owner of this object The method is used in snapshot saving/loading
`void`	`setCenterLatitude(double centerLatitude)` Sets the latitude of the map projection center, measured in degrees (-90 ...
`void`	`setCenterLongitude(double centerLongitude)` Sets the longitude of the map projection center, measured in degrees (-180 ...
`void`	`setHeight(double height)` Sets the height of the shape.
`void`	`setMapScale(double mapScale)` Sets the scale of map projection
`void`	`setProjectionCenter(double centerLongitude, double centerLatitude)` Sets the center of the map projection
`void`	`setWidth(double width)` Sets the width of the shape.
`void`	`zoomIn()` Increases scale of map projection (`x 2`)
`void`	`zoomOut()` Decreases scale of map projection (`x 1/2`)

Methods inherited from class com.xj.anylogic.engine.AbstractShapeGISMap
`clone, formatMapScale, onClick`

Methods inherited from class com.xj.anylogic.engine.presentation.Shape
`canHandleClick, getGroup, getName, getRotation, getScaleX, getScaleY, getX, getY, isVisible, setPos, setRotation, setScale, setScale, setScaleX, setScaleY, setVisible, setX, setY`

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

Constructor Detail

ShapeGISMap

public ShapeGISMap(Presentable presentable,
                   boolean ispublic,
                   double x,
                   double y,
                   double width,
                   double height,
                   java.lang.String packagePrefix,
                   ShapeGISMap.Layer[] layers,
                   double centerLongitude,
                   double centerLatitude,
                   double mapScale,
                   java.awt.Color mapBorderColor,
                   java.awt.Color mapBackgroundColor)

Constructs a GIS Map shape with specific attributes.

Parameters:: presentable - the presentable object owning this shape; ispublic - if true, the shape is visible on container's presentation; x - the x coordinate of the shape upper left corner; y - the y coordinate of the shape upper left corner; width - the width of the shape; height - the height of the shape; packagePrefix - the package name of original active object where this image is defined, formatted using '/' characters; with '/' character at the beginning and at the end; layers - the array of ShapeGISMap.Layer objects to be used and drawn; centerLongitude - the longitude of the map projection center, measured in degrees (-180 ... (West) ... 0 ... (East) ... +180); centerLatitude - the latitude of the map projection center, measured in degrees (-90 ... (South) ... 0 ... (North) ... +90); mapScale - the scale (ratio between meters on the screen and meters on the Earth surface), e.g. 1/100000 means "1 km in 1 cm"

Method Detail

setWidth

public void setWidth(double width)

Sets the width of the shape.

Parameters:: width - the width of the shape

getWidth

public double getWidth()

Returns the width of the shape.

Returns:: the width of the shape

setHeight

public void setHeight(double height)

Sets the height of the shape.

Parameters:: height - the height of the shape

getHeight

public double getHeight()

Returns the height of the shape.

Returns:: the height of the shape

onClickAt

public boolean onClickAt(double px,
                         double py,
                         boolean publicOnly)

Tests if the GIS map contains the point with the given coordinates and, if yes, executes the reaction on click at that point.

Overrides:: onClickAt in class Shape

Parameters:: px - the x coordinate of the click; py - the y coordinate of the click; publicOnly - if true, not public shape returns false
Returns:: true if the click has been handled AND further click processing is not needed, false otherwise

contains

public boolean contains(double px,
                        double py)

Description copied from class: Shape

Test if the shape contains the point with the given coordinates (relative to this shape's container, i.e. in the same system with the coordinates of this shape, x and y)

Specified by:: contains in class Shape

Parameters:: px - the x coordinate relative to this shape's container; py - the y coordinate relative to this shape's container
Returns:: true if the shape contains the point with the given coordinates

draw

public void draw(Panel panel,
                 java.awt.Graphics2D g,
                 java.awt.geom.AffineTransform xform,
                 boolean publicOnly)

Description copied from class: Shape

Draws the shape in a given context

Specified by:: draw in class Shape

Parameters:: panel - the panel where the drawing is done; g - the graphics where the drawing takes place; xform - the "original" transform that must be restored before drawing; publicOnly - if true, the shape is only drawn if it is public