TracingObstacleLossCanvasVisualizer¶

Package: inet.visualizer.canvas.physicallayer

simple module TracingObstacleLossCanvasVisualizer

Visualizes obstacle loss on a 2D canvas. It displays a line at the intersections of signal propagation paths with physical objects, and normal vectors of physical object faces at intersection points.

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.
TracingObstacleLossVisualizer	compound module	Integrates canvas and osg obstacle loss visualizers into a single module.

Extends¶

Name	Type	Description
TracingObstacleLossVisualizerBase	simple module	Base module for tracing obstacle loss visualizer simple modules. It subscribes to the obstacle loss module for physical object penetrated signals. The actual visualization of obstacle loss 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
displayIntersections	bool	false	Display intersections of transmissions and physical objects, disabled by default
intersectionLineColor	string	“red”
intersectionLineStyle	string	“solid”
intersectionLineWidth	double	1
displayFaceNormalVectors	bool	false	Display face normal vectors of intersections, disabled by default
faceNormalLineColor	string	“grey”
faceNormalLineStyle	string	“solid”
faceNormalLineWidth	double	1
fadeOutMode	string	“realTime”	Specifies how inactive obstacle losses fade out
fadeOutTime	double	1s	How quickly link breaks fade away, 1 second by default
fadeOutAnimationSpeed	double	0	Animation speed while there are obstacle losses, value must be in the range (0, +inf)
zIndex	double	0	Determines the drawing order of figures relative to other visualizers

Properties¶

Name	Value	Description
class	TracingObstacleLossCanvasVisualizer
display	i=block/app

Source code¶

//
// Visualizes obstacle loss on a 2D canvas. It displays a line at
// the intersections of signal propagation paths with physical objects, and
// normal vectors of physical object faces at intersection points.
//
// @see ~TracingObstacleLossOsgVisualizer, ~TracingObstacleLossVisualizer, ~TracingObstacleLossVisualizerBase, ~ITracingObstacleLossVisualizer
//
simple TracingObstacleLossCanvasVisualizer extends TracingObstacleLossVisualizerBase like ITracingObstacleLossVisualizer
{
    parameters:
        double zIndex = default(0); // Determines the drawing order of figures relative to other visualizers
        @class(TracingObstacleLossCanvasVisualizer);
}

File: src/inet/visualizer/canvas/physicallayer/TracingObstacleLossCanvasVisualizer.ned