Package: inet.visualizer.base
SceneVisualizerBase
simple moduleThis 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.
See also: SceneCanvasVisualizer, SceneOsgVisualizer, ISceneVisualizer, VisualizerBase
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 |
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. |
SceneCanvasVisualizer | simple module |
This 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 accross all visualizers. It can also display 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 scene either as a filled rectangle or as an image. |
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. |
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 |
Properties
Name | Value | Description |
---|---|---|
class | SceneVisualizerBase | |
display | i=block/app |
Source code
// // 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. // // @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, value must be in the range (0, +inf) double sceneMinX @unit(m) = default(nan m); // lower bound of x coordinates in scene double sceneMinY @unit(m) = default(nan m); // lower bound of y coordinates in scene double sceneMinZ @unit(m) = default(nan m); // lower bound of z coordinates in scene double sceneMaxX @unit(m) = default(nan m); // upper bound of x coordinates in scene double sceneMaxY @unit(m) = default(nan m); // upper bound of y coordinates in scene double sceneMaxZ @unit(m) = default(nan m); // upper bound of z coordinates in scene @class(SceneVisualizerBase); }File: src/inet/visualizer/base/SceneVisualizerBase.ned