PhysicalEnvironmentVisualizerBase¶

simple module PhysicalEnvironmentVisualizerBase

Base module for physical environment visualizer simple modules. It provides the physical objects through the physical environment module for derived modules. The actual visualization of physical objects is done in derived modules.

Inheritance diagram¶

Known subclasses¶

Name	Type	Description
PhysicalEnvironmentCanvasVisualizer	simple module	Visualizes a physical environment on a 2D canvas. It displays the physical objects present in the physical environment. Since this is not a 3D visualization, the physical objects are projected to a 2D plane according to the view angle of the corresponding SceneCanvasVisualizer. Apart from this, the visualizer considers all object properties that affect the appearance such as position, orientation, shape, colors, opacity, etc.
PhysicalEnvironmentOsgVisualizer	simple module	Visualizes a physical environment on a 3D osg scene. It displays the physical objects present in the physical environment. The visualizer considers all object properties that affect appearance such as position, orientation, shape, colors, opacity, etc.

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 that is displayed, refers to a top-level sub-module by default
displayObjects	bool	true

Properties¶

Name	Value	Description
class	PhysicalEnvironmentVisualizerBase
display	i=block/app

Source code¶

//
// Base module for physical environment visualizer simple modules. It
// provides the physical objects through the physical environment module for
// derived modules. The actual visualization of physical objects is done in
// derived modules.
//
// @see ~PhysicalEnvironmentCanvasVisualizer, ~PhysicalEnvironmentOsgVisualizer, ~IPhysicalEnvironmentVisualizer, ~VisualizerBase
//
simple PhysicalEnvironmentVisualizerBase extends VisualizerBase
{
    parameters:
        string physicalEnvironmentModule = default("physicalEnvironment"); // The physical environment module that is displayed, refers to a top-level sub-module by default

        bool displayObjects = default(true);

        @class(PhysicalEnvironmentVisualizerBase);
}

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