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.

Inheritance diagram

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

Known subclasses

Name	Type	Description
SceneOsgEarthVisualizer	simple module	This module visualizes the scene using osgEarth. It displays a 3D osg map of some part of the earth as an integrated part of the 3D visualization of the simulation. The map is loaded from an external resource specified by the mapFile parameter. The scene is placed on the map according to the coordinate system module.
SceneOsgVisualizer	simple module	This module visualizes the scene using osg. It displays the scene and the coordinate system axes. It sets the initial viewpoint of the 3D scene based on the bounding sphere of all network nodes. The viewpoint is located opposite of the coordinate system origin with respect to the sphere, and it faces towards the center of the sphere.

Extends

Name	Type	Description
SceneVisualizerBase	simple module	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.

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
cameraManipulator	string	"auto"	type of camera manipulator
cameraDistanceFactor	double	5	camera distance relative to the network bounding sphere radius
zNear	double	1m	near distance for Z buffer optimization
zFar	double	100000m	far distance for Z buffer optimization
fieldOfView	double	30deg	camera field of view
clearColor	string	""	scene background color, not set by default
displayScene	bool	true	display the scene, enabled by default
sceneColor	string	"#A0E0A0"	scene solid color if scene texture is not provided, gray by default
sceneOpacity	double	1.0	scene opacity, opaque by default (not recommended to change)
sceneImage	string	""	scene texture (repeated), no image by default
sceneImageSize	double	1m	scene texture size
sceneShading	bool	true	exponential shading for scene color, enabled by default

Properties

Name	Value	Description
class	SceneOsgVisualizerBase
display	i=block/app

Source code

//
// 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.
//
// @see ~SceneOsgVisualizer, ~SceneOsgEarthVisualizer, ~SceneVisualizerBase
//
simple SceneOsgVisualizerBase extends SceneVisualizerBase
{
    parameters:
        string cameraManipulator @enum("auto","trackball","overview","terrain","earth") = default("auto"); // type of camera manipulator
        double cameraDistanceFactor = default(5); // camera distance relative to the network bounding sphere radius
        double zNear @unit(m) = default(1m); // near distance for Z buffer optimization
        double zFar @unit(m) = default(100000m); // far distance for Z buffer optimization
        double fieldOfView @unit(deg) = default(30deg); // camera field of view
        string clearColor = default(""); // scene background color, not set by default

        bool displayScene = default(true); // display the scene, enabled by default
        string sceneColor = default("#A0E0A0"); // scene solid color if scene texture is not provided, gray by default
        double sceneOpacity = default(1.0); // scene opacity, opaque by default (not recommended to change)
        string sceneImage = default(""); // scene texture (repeated), no image by default
        double sceneImageSize @unit(m) = default(1m); // scene texture size
        bool sceneShading = default(true); // exponential shading for scene color, enabled by default

        @class(SceneOsgVisualizerBase);
}

File: src/inet/visualizer/osg/base/SceneOsgVisualizerBase.ned