Simple Module MobilityVisualizerBase

Package: inet.visualizer.base
File: src/inet/visualizer/base/MobilityVisualizerBase.ned

This is a base module for mobility visualizer simple modules. It subscribes for the mobilityStateChanged signal at the module determined by the subscriptionModule parameter. The actual visualization of mobility is done in derived modules.

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

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

Extends:

Name	Type	Description
VisualizerBase	simple module	This is a base module for visualizer simple modules. It simply provides the visualization target module for derived modules.

Known subclasses:

Name	Type	Description
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.
MobilityOsgVisualizer	simple module	This module visualizes multiple mobilities on a 3D osg scene. It moves the visual represnetation according to their mobility model. It also displays recent movement as a polyline, current velocity vector and current orientation.

Parameters:

Name	Type	Default value	Description
visualizerTargetModule	string	""	module path relative to the visualizer where the visualization should appear in the user interface, root 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
subscriptionModule	string	""	module where the visualizer subscribes for mobility signals, root module by default
displayMovements	bool	true	display mobility movement, enabled by default
animationSpeed	double	0	animation speed while objects are moving around, value must be in the range (0, +inf)
moduleFilter	string	"**"	which mobilities are considered, matches all mobilities by default
displayOrientations	bool	false	display an arc indicating the current orientation, disabled by default
orientationArcSize	double	0.25	relative size of the arc compared to the full circle
orientationLineColor	string	"black"	orientation line color, black by default
orientationLineStyle	string	"solid"	orientation line style (solid, dashed, dotted)
orientationLineWidth	double	1	orientation line width
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

Properties:

Name	Value	Description
class	MobilityVisualizerBase
display	i=block/app_s

Source code:

//
// This is a base module for mobility visualizer simple modules. It subscribes
// for the mobilityStateChanged signal at the module determined by the
// subscriptionModule parameter. The actual visualization of mobility is done in
// derived modules.
//
// @see ~MobilityCanvasVisualizer, ~MobilityOsgVisualizer, ~IMobilityVisualizer, ~VisualizerBase
//
simple MobilityVisualizerBase extends VisualizerBase
{
    parameters:
        string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // the network node visualizer module, refers to a sibling submodule by default
        string subscriptionModule = default("<root>"); // module where the visualizer subscribes for mobility signals, root module by default

        bool displayMovements = default(true); // display mobility movement, enabled by default
        double animationSpeed = default(0); // animation speed while objects are moving around, value must be in the range (0, +inf)

        string moduleFilter = default("**"); // which mobilities are considered, matches all mobilities by default

        bool displayOrientations = default(false); // display an arc indicating the current orientation, disabled by default
        double orientationArcSize = default(0.25); // relative size of the arc compared to the full circle 
        string orientationLineColor = default("black"); // orientation line color, black by default
        string orientationLineStyle = default("solid"); // orientation line style (solid, dashed, dotted)
        double orientationLineWidth = default(1); // orientation line width

        bool displayVelocities = default(false); // display an arrow indicating the current velocity, disabled by default
        double velocityArrowScale = default(1); // velocity scaling factor to pixels
        string velocityLineColor = default("black"); // velocity line color, black by default
        string velocityLineStyle = default("solid"); // velocity line style (solid, dashed, dotted)
        double velocityLineWidth = default(1); // velocity line width

        bool displayMovementTrails = default(false); // display a line along the recent path of mobilities, disabled by default
        string movementTrailLineColor @enum("light","dark") = default("dark"); // movement trail line color is a list of colors, a set of dark colors by default
        string movementTrailLineStyle = default("solid"); // movement trail line style (solid, dashed, dotted)
        double movementTrailLineWidth = default(1); // movement trail line width
        int trailLength = default(100); // number of sections in the trail

        @class(MobilityVisualizerBase);
}