PhysicalEnvironmentCanvasVisualizer¶

Package: inet.visualizer.canvas.environment

simple module PhysicalEnvironmentCanvasVisualizer

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.

Usage diagram¶

Inheritance diagram¶

Used in compound modules¶

Name	Type	Description
IntegratedCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
IntegratedMultiCanvasVisualizer	compound module	Integrates all canvas visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.
PhysicalEnvironmentVisualizer	compound module	Integrates canvas and OSG physical environment visualizers into a single module.

Extends¶

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

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
zIndex	double	0	Determines the drawing order of figures relative to other visualizers

Properties¶

Name	Value	Description
class	PhysicalEnvironmentCanvasVisualizer
display	i=block/app

Source code¶

//
// 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.
//
// @see ~PhysicalEnvironmentOsgVisualizer, ~PhysicalEnvironmentVisualizer, ~PhysicalEnvironmentVisualizerBase, ~IPhysicalEnvironmentVisualizer
//
simple PhysicalEnvironmentCanvasVisualizer extends PhysicalEnvironmentVisualizerBase like IPhysicalEnvironmentVisualizer
{
    parameters:
        double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers
        @class(PhysicalEnvironmentCanvasVisualizer);
}

File: src/inet/visualizer/canvas/environment/PhysicalEnvironmentCanvasVisualizer.ned