SceneVisualizerBase

simple module

Base module for scene visualizer simple modules. It determines the bounds of the scene, which 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 that 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.

Inheritance diagram

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

Known subclasses

Name	Type	Description
OpenStreetMapSceneCanvasVisualizer	simple module	Visualizes a stream map given in an OpenStreetMap (openstreetmap.org) file. Other objects of the scene are placed on the map according to the coordinate system module.
SceneCanvasVisualizer	simple module	Visualizes the scene on a 2D canvas. It provides the 3D coordinate system's 2D orthographic projection for other visualizers. This is used to get a consistent visualization across all visualizers. It can also display the coordinate system axes.
SceneOsgVisualizerBase	simple module	Base module for scene visualizer simple modules on a 3D osg scene. It displays the scene either as a filled rectangle or as an image.

Extends

Name	Type	Description
VisualizerBase	simple module	Base module for visualizer simple modules. It simply provides the visualization target module for derived modules.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	""	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
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, the value must be in the range (0, +inf)
sceneMinX	double	nan m	Lower bound of x coordinates in the scene
sceneMinY	double	nan m	Lower bound of y coordinates in the scene
sceneMinZ	double	nan m	Lower bound of z coordinates in the scene
sceneMaxX	double	nan m	Upper bound of x coordinates in the scene
sceneMaxY	double	nan m	Upper bound of y coordinates in the scene
sceneMaxZ	double	nan m	Upper bound of z coordinates in the scene

Properties

Name	Value	Description
class	SceneVisualizerBase
display	i=block/app

Source code

//
// Base module for scene visualizer simple modules. It determines the
// bounds of the scene, which 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 that 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.
//
// @see ~SceneCanvasVisualizer, ~SceneOsgVisualizer, ~ISceneVisualizer, ~VisualizerBase
//
simple SceneVisualizerBase extends VisualizerBase
{
    parameters:
        string physicalEnvironmentModule = default("physicalEnvironment"); // The physical environment module, refers to a top-level submodule by default
        string networkNodeVisualizerModule = default("^.networkNodeVisualizer"); // The network node visualizer, refers to a sibling submodule by default
        double axisLength @mutable @unit(m) = default(nan m); // Length of x, y, and z axes, no axis by default
        double animationSpeed = default(0); // Always active animation speed independent of any visualization, the value must be in the range (0, +inf)
        double sceneMinX @unit(m) = default(nan m); // Lower bound of x coordinates in the scene
        double sceneMinY @unit(m) = default(nan m); // Lower bound of y coordinates in the scene
        double sceneMinZ @unit(m) = default(nan m); // Lower bound of z coordinates in the scene
        double sceneMaxX @unit(m) = default(nan m); // Upper bound of x coordinates in the scene
        double sceneMaxY @unit(m) = default(nan m); // Upper bound of y coordinates in the scene
        double sceneMaxZ @unit(m) = default(nan m); // Upper bound of z coordinates in the scene
        @class(SceneVisualizerBase);
}

File: src/inet/visualizer/base/SceneVisualizerBase.ned