Simple Module PhysicalEnvironmentCanvasVisualizer

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

C++ definition

This 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, so 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:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

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

Extends:

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

Networks:

Name	Type	Description
SimpleVisualizationExample	network	(no description)

Parameters:

Name	Type	Default value	Description
visualizerTargetModule	string	""	module path relative to the visualizer where the visualization should appear in the user interface, root 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 submodule 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_s

Source code:

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