Simple Module SceneVisualizerBase

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

C++ definition

This is a base module for scene visualizer simple modules. It determines the bounds of the playground, that is the minimum area where the whole simulation fits in. The playground 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.

See also: SceneCanvasVisualizer, SceneOsgVisualizer, ISceneVisualizer, VisualizerBase

SceneVisualizerBase

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
SceneCanvasVisualizer simple module

This module visualizes the scene on a 2D canvas. It provides the 3D coordinate system's 2D projection for other visualizers. This is used to get a consistent visualization accross all visualizers. It also displays the coordinate system axes.

SceneOsgVisualizerBase simple module

This is a base module for scene visualizer simple modules on a 3D osg scene. It displays the playground either as a filled rectangle or as an image.

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

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 0m/0

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)

Properties:

Name Value Description
class SceneVisualizerBase
display i=block/app_s

Source code:

//
// This is a base module for scene visualizer simple modules. It determines the
// bounds of the playground, that is the minimum area where the whole simulation
// fits in. The playground 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.
//
// @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 @unit(m) = default(0m/0); // length of x, y, and z axes, no axis by default
        double animationSpeed = default(0); // always active animation speed independent of any visualization, value must be in the range (0, +inf)
        @class(SceneVisualizerBase);
}