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

Name Type Description
SceneVisualizerBase simple module

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.

Source code:

//
// Copyright (C) OpenSim Ltd.
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program; if not, see <http://www.gnu.org/licenses/>.
//

package inet.visualizer.base;

//
// 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);
}