SceneOsgVisualizer

Package: inet.visualizer.osg.scene

simple module SceneOsgVisualizer

Visualizes the scene using osg. It displays the scene and the coordinate system axes. It sets the initial viewpoint of the 3D scene based on the bounding sphere of all network nodes. The viewpoint is located opposite to the coordinate system origin with respect to the sphere, and it faces towards the center of the sphere.

See also: SceneCanvasVisualizer, SceneVisualizer, SceneVisualizerBase, ISceneVisualizer

inet.visualizer.osg.scene.SceneOsgVisualizerSceneOsgVisualizersimple

Usage diagram

Inheritance diagram

Used in compound modules

Name

Type

Description

SceneVisualizer

compound module

Integrates canvas and osg scene visualizers into a single module.

IntegratedMultiOsgVisualizer

compound module

Integrates all osg visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.

IntegratedOsgVisualizer

compound module

Integrates all osg visualizers into a single module. It supports disabling any submodule visualizer by providing an empty string as its type.

Extends

Name

Type

Description

SceneOsgVisualizerBase

simple module

Base module for scene visualizer simple modules on a 3D osg scene. It displays the scene either as a filled rectangle or as an image.

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, refers to a top-level submodule by default

networkNodeVisualizerModule

string

“^.networkNodeVisualizer”

The network node visualizer, refers to a sibling submodule by default

axisLength

double

nan m

Length of x, y, and z axes, no axis by default

animationSpeed

double

0

Always active animation speed independent of any visualization, the value must be in the range (0, +inf)

sceneMinX

double

nan m

Lower bound of x coordinates in the scene

sceneMinY

double

nan m

Lower bound of y coordinates in the scene

sceneMinZ

double

nan m

Lower bound of z coordinates in the scene

sceneMaxX

double

nan m

Upper bound of x coordinates in the scene

sceneMaxY

double

nan m

Upper bound of y coordinates in the scene

sceneMaxZ

double

nan m

Upper bound of z coordinates in the scene

cameraManipulator

string

“auto”

Type of camera manipulator

cameraDistanceFactor

double

5

Camera distance relative to the network bounding sphere radius

zNear

double

1m

Near distance for Z buffer optimization

zFar

double

100000m

Far distance for Z buffer optimization

fieldOfView

double

30deg

Camera field of view

clearColor

string

“#FFFFFF”

Scene background color, not set by default

displayScene

bool

true

Display the scene, enabled by default

sceneColor

string

“#A0E0A0”

Scene solid color if scene texture is not provided, gray by default

sceneOpacity

double

1.0

Scene opacity, opaque by default (not recommended to change)

sceneImage

string

“”

Scene texture (repeated), no image by default

sceneImageSize

double

1m

Scene texture size

sceneShading

bool

true

Exponential shading for scene color, enabled by default

Properties

Name

Value

Description

class

SceneOsgVisualizer

display

i=block/app

Source code

//
// Visualizes the scene using osg. It displays the scene and
// the coordinate system axes. It sets the initial viewpoint of the 3D scene
// based on the bounding sphere of all network nodes. The viewpoint is located
// opposite to the coordinate system origin with respect to the sphere, and it
// faces towards the center of the sphere.
//
// @see ~SceneCanvasVisualizer, ~SceneVisualizer, ~SceneVisualizerBase, ~ISceneVisualizer
//
simple SceneOsgVisualizer extends SceneOsgVisualizerBase like ISceneVisualizer
{
    parameters:
        @class(SceneOsgVisualizer);
        clearColor = default("#FFFFFF"); // Scene background color, default is white
}

File: src/inet/visualizer/osg/scene/SceneOsgVisualizer.ned