OpenStreetMapSceneCanvasVisualizer

Package: inet.visualizer.canvas.scene

OpenStreetMapSceneCanvasVisualizer

simple module

This module visualizes a stream map given in an OpenStreetMap file. Other objects of the scene are placed on the map according to the coordinate system module.

See also: SceneCanvasVisualizer, SceneVisualizer, SceneVisualizerBase, ISceneVisualizer

See also: IGeographicCoordinateSystem, SimpleGeographicCoordinateSystem, OsgGeographicCoordinateSystem

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name Type Description
SceneVisualizerBase simple module

This is a base module for scene visualizer simple modules. It determines the bounds of the scene, that is the minimum area where the whole simulation fits in. The scene encloses all physical objects and the constraint area of all mobile nodes. The visualizer also provides a timer which can be used to periodically update the user interface independently of the underlying simulation. The actual visualization of the scene is done in derived modules.

Parameters

Name Type Default value Description
visualizationTargetModule string "^"

module path relative to the visualizer which determines where the visualization should appear in the user interface, parent module by default

visualizationSubjectModule string "^"

module path relative to the visualizer which determines what part of the simulation model the visualizer displays in the user interface, parent module by default

tags string ""

tag added to each visualization for disambiguation in the runtime environment

physicalEnvironmentModule string "physicalEnvironment"

the physical environment module, refers to a top level submodule by default

networkNodeVisualizerModule string "^.networkNodeVisualizer"

the network node visualizer, refers to a sibling submodule by default

axisLength double nan m

length of x, y, and z axes, no axis by default

animationSpeed double 0

always active animation speed independent of any visualization, value must be in the range (0, +inf)

sceneMinX double nan m

lower bound of x coordinates in scene

sceneMinY double nan m

lower bound of y coordinates in scene

sceneMinZ double nan m

lower bound of z coordinates in scene

sceneMaxX double nan m

upper bound of x coordinates in scene

sceneMaxY double nan m

upper bound of y coordinates in scene

sceneMaxZ double nan m

upper bound of z coordinates in scene

coordinateSystemModule string "coordinateSystem"

the geographic coordinate system, refers to a top level module by default

mapFile xml

OpenStreetMap map file, e.g. one exported from openstreetmap.org

zIndex double 0

determines the drawing order of figures relative to other visualizers

adjustBackgroundBox bool true

if true, sets background box (bgb tag) to match map bounds

Properties

Name Value Description
class OpenStreetMapSceneCanvasVisualizer
display i=block/app

Source code

//
// This module visualizes a stream map given in an OpenStreetMap file.
// Other objects of the scene are placed on the map according to the coordinate system module.
//
// @see ~SceneCanvasVisualizer, ~SceneVisualizer, ~SceneVisualizerBase, ~ISceneVisualizer
// @see ~IGeographicCoordinateSystem, ~SimpleGeographicCoordinateSystem, ~OsgGeographicCoordinateSystem
//
simple OpenStreetMapSceneCanvasVisualizer extends SceneVisualizerBase like ISceneVisualizer
{
    parameters:
        @class(OpenStreetMapSceneCanvasVisualizer);
        string coordinateSystemModule = default("coordinateSystem"); // the geographic coordinate system, refers to a top level module by default

        xml mapFile; // OpenStreetMap map file, e.g. one exported from openstreetmap.org

        double zIndex = default(0); // determines the drawing order of figures relative to other visualizers
        bool adjustBackgroundBox = default(true); // if true, sets background box (bgb tag) to match map bounds
}

File: src/inet/visualizer/canvas/scene/OpenStreetMapSceneCanvasVisualizer.ned