PhysicalEnvironmentCanvasVisualizer

Package: inet.visualizer.canvas.environment

PhysicalEnvironmentCanvasVisualizer

simple module

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 also: PhysicalEnvironmentOsgVisualizer, PhysicalEnvironmentVisualizer, PhysicalEnvironmentVisualizerBase, IPhysicalEnvironmentVisualizer

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.

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 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

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);
}

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