MobilityCanvasVisualizer

Package: inet.visualizer.canvas.mobility

MobilityCanvasVisualizer

simple module

This module visualizes multiple mobilities on a 2D canvas. It moves visual representations according to their mobility model. It also displays recent movement as a polyline, current velocity vector and current orientation.

See also: MobilityOsgVisualizer, MobilityVisualizer, MobilityVisualizerBase, MobilityVisualizer

Inheritance diagram

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

Extends

Name Type Description
MobilityVisualizerBase simple module

This is a base module for mobility visualizer simple modules. It subscribes for the mobilityStateChanged signal at the module determined by the visualizationSubjectModule parameter. The actual visualization of mobility 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

networkNodeVisualizerModule string "^.networkNodeVisualizer"

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

displayMobility bool true

display mobility, enabled by default

animationSpeed double 0

animation speed while objects are moving around, value must be in the range (0, +inf)

moduleFilter string "**.mobility"

which mobilities are considered, matches all mobilities by default

displayPositions bool false

display a circle indicating the current position, disabled by default

positionCircleRadius double 4

radius of the circle

positionCircleLineWidth double 1

line width of the circle

positionCircleLineColor string "dark"

position circle line color is a list of colors, a set of dark colors by default

positionCircleFillColor string "dark"

position circle fill color is a list of colors, a set of dark colors by default

displayOrientations bool false

display a pie indicating the current orientation, disabled by default

orientationPieRadius double 32

radius of the pie

orientationPieSize double 0.2

relative size of the pie compared to the full circle

orientationPieOpacity double 0.25

opacity of the pie

orientationLineColor string "black"

orientation line color, black by default

orientationLineStyle string "solid"

orientation line style (solid, dashed, dotted)

orientationLineWidth double 1

orientation line width

orientationFillColor string "blue"

orientation fill color, blue by default

displayVelocities bool false

display an arrow indicating the current velocity, disabled by default

velocityArrowScale double 1

velocity scaling factor to pixels

velocityLineColor string "black"

velocity line color, black by default

velocityLineStyle string "solid"

velocity line style (solid, dashed, dotted)

velocityLineWidth double 1

velocity line width

displayMovementTrails bool false

display a line along the recent path of mobilities, disabled by default

movementTrailLineColor string "dark"

movement trail line color is a list of colors, a set of dark colors by default

movementTrailLineStyle string "solid"

movement trail line style (solid, dashed, dotted)

movementTrailLineWidth double 1

movement trail line width

trailLength int 100

number of sections in the trail

zIndex double 0

determines the drawing order of figures relative to other visualizers

Properties

Name Value Description
class MobilityCanvasVisualizer
display i=block/app

Source code

//
// This module visualizes multiple mobilities on a 2D canvas. It moves visual
// representations according to their mobility model. It also displays recent
// movement as a polyline, current velocity vector and current orientation.
//
// @see ~MobilityOsgVisualizer, ~MobilityVisualizer, ~MobilityVisualizerBase, ~MobilityVisualizer
//
simple MobilityCanvasVisualizer extends MobilityVisualizerBase like IMobilityVisualizer
{
    parameters:
        double zIndex = default(0); // determines the drawing order of figures relative to other visualizers
        @class(MobilityCanvasVisualizer);
}

File: src/inet/visualizer/canvas/mobility/MobilityCanvasVisualizer.ned