inet::visualizer::MobilityCanvasVisualizer Class Reference

#include <MobilityCanvasVisualizer.h>

Inheritance diagram for inet::visualizer::MobilityCanvasVisualizer:

Classes
class	MobilityCanvasVisualization

Protected Member Functions
virtual void	initialize (int stage) override
virtual void	refreshDisplay () const override
virtual MobilityVisualization *	createMobilityVisualization (IMobility *mobility) override
virtual void	addMobilityVisualization (const IMobility *mobility, MobilityVisualization *mobilityVisualization) override
virtual void	removeMobilityVisualization (const MobilityVisualization *mobilityVisualization) override
virtual void	extendMovementTrail (const IMobility *mobility, TrailFigure *trailFigure, cFigure::Point position) const
Protected Member Functions inherited from inet::visualizer::MobilityVisualizerBase
virtual void	handleParameterChange (const char *name) override
virtual void	preDelete (cComponent *root) override
virtual void	subscribe ()
virtual void	unsubscribe ()
virtual MobilityVisualization *	getMobilityVisualization (const IMobility *mobility) const
virtual void	removeAllMobilityVisualizations ()
Protected Member Functions inherited from inet::visualizer::VisualizerBase
virtual int	numInitStages () const override
virtual Coord	getPosition (const cModule *networkNode) const
virtual Coord	getContactPosition (const cModule *networkNode, const Coord &fromPosition, const char *contactMode, double contactSpacing) const
virtual Quaternion	getOrientation (const cModule *networkNode) const
virtual void	mapChunks (const Ptr< const Chunk > &chunk, const std::function< void(const Ptr< const Chunk > &, int)> &thunk) const

Protected Attributes
double	zIndex = NaN
const CanvasProjection *	canvasProjection = nullptr
Protected Attributes inherited from inet::visualizer::MobilityVisualizerBase
bool	displayMobility = false
double	animationSpeed = NaN
ModuleFilter	moduleFilter
bool	displayPositions = false
double	positionCircleRadius = NaN
double	positionCircleLineWidth = NaN
ColorSet	positionCircleLineColorSet
ColorSet	positionCircleFillColorSet
bool	displayOrientations = false
double	orientationPieRadius = NaN
double	orientationPieSize = NaN
double	orientationPieOpacity = NaN
cFigure::Color	orientationLineColor
cFigure::LineStyle	orientationLineStyle
double	orientationLineWidth = NaN
cFigure::Color	orientationFillColor
bool	displayVelocities = false
double	velocityArrowScale = NaN
cFigure::Color	velocityLineColor
cFigure::LineStyle	velocityLineStyle
double	velocityLineWidth = NaN
bool	displayMovementTrails = false
bool	autoMovementTrailLineColor = false
ColorSet	movementTrailLineColorSet
cFigure::LineStyle	movementTrailLineStyle
double	movementTrailLineWidth = NaN
int	trailLength = -1
std::map< int, MobilityVisualization * >	mobilityVisualizations
Protected Attributes inherited from inet::visualizer::VisualizerBase
cModule *	visualizationTargetModule = nullptr
cModule *	visualizationSubjectModule = nullptr
const char *	tags = nullptr

Additional Inherited Members
Public Member Functions inherited from inet::visualizer::MobilityVisualizerBase
virtual void	receiveSignal (cComponent *source, simsignal_t signal, cObject *object, cObject *details) override

Member Function Documentation

addMobilityVisualization()

void inet::visualizer::MobilityCanvasVisualizer::addMobilityVisualization ( const IMobility *  mobility, MobilityVisualization *  mobilityVisualization  )

overrideprotectedvirtual

Reimplemented from inet::visualizer::MobilityVisualizerBase.

{
    MobilityVisualizerBase::addMobilityVisualization(mobility, mobilityVisualization);
    auto mobilityCanvasVisualization = static_cast<MobilityCanvasVisualization *>(mobilityVisualization);
    auto canvas = visualizationTargetModule->getCanvas();
    if (displayPositions)
        canvas->addFigure(mobilityCanvasVisualization->positionFigure);
    if (displayOrientations)
        canvas->addFigure(mobilityCanvasVisualization->orientationFigure);
    if (displayVelocities)
        canvas->addFigure(mobilityCanvasVisualization->velocityFigure);
    if (displayMovementTrails)
        canvas->addFigure(mobilityCanvasVisualization->trailFigure);
}

createMobilityVisualization()

MobilityCanvasVisualizer::MobilityVisualization * inet::visualizer::MobilityCanvasVisualizer::createMobilityVisualization ( IMobility *  mobility )

overrideprotectedvirtual

Implements inet::visualizer::MobilityVisualizerBase.

{
    auto module = const_cast<cModule *>(check_and_cast<const cModule *>(mobility));
    cOvalFigure *positionFigure = nullptr;
    if (displayPositions) {
        positionFigure = new cOvalFigure("position");
        positionFigure->setTags((std::string("position ") + tags).c_str());
        positionFigure->setTooltip("This circle represents the current position of the mobility model");
        positionFigure->setZIndex(zIndex);
        positionFigure->setLineColor(positionCircleLineColorSet.getColor(module->getId()));
        positionFigure->setLineWidth(positionCircleLineWidth);
        positionFigure->setFilled(true);
        positionFigure->setFillColor(positionCircleFillColorSet.getColor(module->getId()));
    }
    cPieSliceFigure *orientationFigure = nullptr;
    if (displayOrientations) {
        orientationFigure = new cPieSliceFigure("orientation");
        orientationFigure->setTags((std::string("orientation ") + tags).c_str());
        orientationFigure->setTooltip("This arc represents the current orientation of the mobility model");
        orientationFigure->setZIndex(zIndex);
        orientationFigure->setLineOpacity(orientationPieOpacity);
        orientationFigure->setLineColor(orientationLineColor);
        orientationFigure->setLineStyle(orientationLineStyle);
        orientationFigure->setLineWidth(orientationLineWidth);
        orientationFigure->setFilled(true);
        orientationFigure->setFillOpacity(orientationPieOpacity);
        orientationFigure->setFillColor(orientationFillColor);
    }
    cLineFigure *velocityFigure = nullptr;
    if (displayVelocities) {
        velocityFigure = new cLineFigure("velocity");
        velocityFigure->setTags((std::string("velocity ") + tags).c_str());
        velocityFigure->setTooltip("This arrow represents the current velocity of the mobility model");
        velocityFigure->setZIndex(zIndex);
        velocityFigure->setVisible(false);
        velocityFigure->setEndArrowhead(cFigure::ARROW_SIMPLE);
        velocityFigure->setLineColor(velocityLineColor);
        velocityFigure->setLineStyle(velocityLineStyle);
        velocityFigure->setLineWidth(velocityLineWidth);
    }
    TrailFigure *trailFigure = nullptr;
    if (displayMovementTrails) {
        trailFigure = new TrailFigure(trailLength, true, "movement trail");
        trailFigure->setTags((std::string("movement_trail recent_history ") + tags).c_str());
        trailFigure->setZIndex(zIndex);
    }
    return new MobilityCanvasVisualization(positionFigure, orientationFigure, velocityFigure, trailFigure, mobility);
}

extendMovementTrail()

void inet::visualizer::MobilityCanvasVisualizer::extendMovementTrail ( const IMobility *  mobility, TrailFigure *  trailFigure, cFigure::Point  position  ) const

protectedvirtual

{
    cFigure::Point startPosition;
    cFigure::Point endPosition = position;
    if (trailFigure->getNumFigures() == 0)
        startPosition = position;
    else
        startPosition = static_cast<cLineFigure *>(trailFigure->getFigure(trailFigure->getNumFigures() - 1))->getEnd();
    double dx = startPosition.x - endPosition.x;
    double dy = startPosition.y - endPosition.y;
    // TODO 1?
    if (trailFigure->getNumFigures() == 0 || dx * dx + dy * dy > 1) {
        cLineFigure *movementLine = new cLineFigure("movementTrail");
        movementLine->setTags((std::string("movement_trail recent_history ") + tags).c_str());
        movementLine->setTooltip("This line represents the recent movement trail of the mobility model");
        movementLine->setStart(startPosition);
        movementLine->setEnd(endPosition);
        auto module = const_cast<cModule *>(check_and_cast<const cModule *>(mobility));
        movementLine->setLineColor(movementTrailLineColorSet.getColor(module->getId()));
        movementLine->setLineStyle(movementTrailLineStyle);
        movementLine->setLineWidth(movementTrailLineWidth);
        movementLine->setZoomLineWidth(false);
        trailFigure->addFigure(movementLine);
    }
}

Referenced by refreshDisplay().

initialize()

void inet::visualizer::MobilityCanvasVisualizer::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented from inet::visualizer::MobilityVisualizerBase.

{
    MobilityVisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        zIndex = par("zIndex");
        canvasProjection = CanvasProjection::getCanvasProjection(visualizationTargetModule->getCanvas());
    }
}

refreshDisplay()

void inet::visualizer::MobilityCanvasVisualizer::refreshDisplay ( ) const

overrideprotectedvirtual

{
    MobilityVisualizerBase::refreshDisplay();
    for (auto it : mobilityVisualizations) {
        auto mobilityVisualization = static_cast<MobilityCanvasVisualization *>(it.second);
        auto mobility = mobilityVisualization->mobility;
        auto position = canvasProjection->computeCanvasPoint(mobility->getCurrentPosition());
        auto orientation = mobility->getCurrentAngularPosition();
        auto velocity = canvasProjection->computeCanvasPoint(mobility->getCurrentVelocity());
        if (displayPositions) {
            double radius = positionCircleRadius / getEnvir()->getZoomLevel(visualizationTargetModule);
            mobilityVisualization->positionFigure->setBounds(cFigure::Rectangle(position.x - radius, position.y - radius, 2 * radius, 2 * radius));
        }
        if (displayOrientations) {
            // NOTE: this negation cancels out the (incorrect) CCW angle handling of cPieSliceFigure (see bug https://dev.omnetpp.org/bugs/view.php?id=1030)
            auto angle = -orientation.toEulerAngles().alpha;
            mobilityVisualization->orientationFigure->setStartAngle(rad(angle - rad(M_PI) * orientationPieSize).get());
            mobilityVisualization->orientationFigure->setEndAngle(rad(angle + rad(M_PI) * orientationPieSize).get());
            double radius = orientationPieRadius / getEnvir()->getZoomLevel(visualizationTargetModule);
            mobilityVisualization->orientationFigure->setBounds(cFigure::Rectangle(position.x - radius, position.y - radius, 2 * radius, 2 * radius));
        }
        if (displayVelocities) {
            mobilityVisualization->velocityFigure->setStart(position);
            mobilityVisualization->velocityFigure->setEnd(position + velocity * velocityArrowScale);
            mobilityVisualization->velocityFigure->setVisible(velocity.getLength() != 0);
        }
        if (displayMovementTrails)
            extendMovementTrail(mobility, mobilityVisualization->trailFigure, position);
    }
    visualizationTargetModule->getCanvas()->setAnimationSpeed(mobilityVisualizations.empty() ? 0 : animationSpeed, this);
}

removeMobilityVisualization()

void inet::visualizer::MobilityCanvasVisualizer::removeMobilityVisualization ( const MobilityVisualization *  mobilityVisualization )

overrideprotectedvirtual

Reimplemented from inet::visualizer::MobilityVisualizerBase.

{
    auto canvas = visualizationTargetModule->getCanvas();
    auto mobilityCanvasVisualization = static_cast<const MobilityCanvasVisualization *>(mobilityVisualization);
    if (displayPositions)
        canvas->removeFigure(mobilityCanvasVisualization->positionFigure);
    if (displayOrientations)
        canvas->removeFigure(mobilityCanvasVisualization->orientationFigure);
    if (displayVelocities)
        canvas->removeFigure(mobilityCanvasVisualization->velocityFigure);
    if (displayMovementTrails)
        canvas->removeFigure(mobilityCanvasVisualization->trailFigure);
    MobilityVisualizerBase::removeMobilityVisualization(mobilityVisualization);
}

Member Data Documentation

canvasProjection

const CanvasProjection* inet::visualizer::MobilityCanvasVisualizer::canvasProjection = nullptr

protected

Referenced by initialize(), and refreshDisplay().

zIndex

double inet::visualizer::MobilityCanvasVisualizer::zIndex = NaN

protected

Referenced by createMobilityVisualization(), and initialize().

---

The documentation for this class was generated from the following files:

• MobilityCanvasVisualizer.h
• MobilityCanvasVisualizer.cc