#include <MobilityVisualizerBase.h>

Inheritance diagram for inet::visualizer::MobilityVisualizerBase:

Classes
class	MobilityVisualization

Parameters
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

virtual void	initialize (int stage) override

virtual void	handleParameterChange (const char *name) override

virtual void	preDelete (cComponent *root) override

virtual void	subscribe ()

virtual void	unsubscribe ()

virtual MobilityVisualization *	createMobilityVisualization (IMobility *mobility)=0

virtual MobilityVisualization *	getMobilityVisualization (const IMobility *mobility) const

virtual void	addMobilityVisualization (const IMobility mobility, MobilityVisualization mobilityVisualization)

virtual void	removeMobilityVisualization (const MobilityVisualization *visualization)

virtual void	removeAllMobilityVisualizations ()

virtual void	receiveSignal (cComponent source, simsignal_t signal, cObject object, cObject *details) override

Additional Inherited Members
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 inherited from inet::visualizer::VisualizerBase
cModule *	visualizationTargetModule = nullptr

cModule *	visualizationSubjectModule = nullptr

const char *	tags = nullptr

Member Function Documentation

◆ addMobilityVisualization()

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

protectedvirtual

Reimplemented in inet::visualizer::MobilityCanvasVisualizer, and inet::visualizer::MobilityOsgVisualizer.

 {
     mobilityVisualizations[mobility->getId()] = mobilityVisualization;
 }

Referenced by inet::visualizer::MobilityOsgVisualizer::addMobilityVisualization(), inet::visualizer::MobilityCanvasVisualizer::addMobilityVisualization(), and receiveSignal().

◆ createMobilityVisualization()

virtual MobilityVisualization* inet::visualizer::MobilityVisualizerBase::createMobilityVisualization ( IMobility * mobility )

protectedpure virtual

Implemented in inet::visualizer::MobilityCanvasVisualizer, and inet::visualizer::MobilityOsgVisualizer.

Referenced by receiveSignal().

◆ getMobilityVisualization()

MobilityVisualizerBase::MobilityVisualization * inet::visualizer::MobilityVisualizerBase::getMobilityVisualization ( const IMobility * mobility ) const

protectedvirtual

 {
     auto it = mobilityVisualizations.find(mobility->getId());
     return (it == mobilityVisualizations.end()) ? nullptr : it->second;
 }

Referenced by receiveSignal().

◆ handleParameterChange()

void inet::visualizer::MobilityVisualizerBase::handleParameterChange ( const char * name )

overrideprotectedvirtual

 {
     if (!hasGUI()) return;
     if (name != nullptr) {
         if (!strcmp(name, "moduleFilter"))
             moduleFilter.setPattern(par("moduleFilter"));
         // TODO
     }
 }

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::VisualizerBase.

Reimplemented in inet::visualizer::MobilityCanvasVisualizer, and inet::visualizer::MobilityOsgVisualizer.

 {
     VisualizerBase::initialize(stage);
     if (!hasGUI()) return;
     if (stage == INITSTAGE_LOCAL) {
         displayMobility = par("displayMobility");
         animationSpeed = par("animationSpeed");
         moduleFilter.setPattern(par("moduleFilter"));
         // position
         displayPositions = par("displayPositions");
         positionCircleRadius = par("positionCircleRadius");
         positionCircleLineWidth = par("positionCircleLineWidth");
         positionCircleLineColorSet.parseColors(par("positionCircleLineColor"));
         positionCircleFillColorSet.parseColors(par("positionCircleFillColor"));
         // orientation
         displayOrientations = par("displayOrientations");
         orientationPieRadius = par("orientationPieRadius");
         orientationPieSize = par("orientationPieSize");
         orientationPieOpacity = par("orientationPieOpacity");
         orientationLineColor = cFigure::parseColor(par("orientationLineColor"));
         orientationLineStyle = cFigure::parseLineStyle(par("orientationLineStyle"));
         orientationLineWidth = par("orientationLineWidth");
         orientationFillColor = cFigure::parseColor(par("orientationFillColor"));
         // velocity
         displayVelocities = par("displayVelocities");
         velocityArrowScale = par("velocityArrowScale");
         velocityLineColor = cFigure::parseColor(par("velocityLineColor"));
         velocityLineStyle = cFigure::parseLineStyle(par("velocityLineStyle"));
         velocityLineWidth = par("velocityLineWidth");
         // movement trail
         displayMovementTrails = par("displayMovementTrails");
         movementTrailLineColorSet.parseColors(par("movementTrailLineColor"));
         movementTrailLineStyle = cFigure::parseLineStyle(par("movementTrailLineStyle"));
         movementTrailLineWidth = par("movementTrailLineWidth");
         trailLength = par("trailLength");
         if (displayMobility)
             subscribe();
     }
 }

Referenced by inet::visualizer::MobilityOsgVisualizer::initialize(), and inet::visualizer::MobilityCanvasVisualizer::initialize().

◆ preDelete()

void inet::visualizer::MobilityVisualizerBase::preDelete ( cComponent * root )

overrideprotectedvirtual

 {
     if (displayMobility) {
         unsubscribe();
         removeAllMobilityVisualizations();
     }
 }

◆ receiveSignal()

void inet::visualizer::MobilityVisualizerBase::receiveSignal	(	cComponent *	source,
		simsignal_t	signal,
		cObject *	object,
		cObject *	details
	)

overridevirtual

 {
     Enter_Method("%s", cComponent::getSignalName(signal));
  
     if (signal == IMobility::mobilityStateChangedSignal) {
         if (moduleFilter.matches(check_and_cast<cModule *>(source))) {
             auto mobility = dynamic_cast<IMobility *>(source);
             auto mobilityVisualization = getMobilityVisualization(mobility);
             if (mobilityVisualization == nullptr) {
                 mobilityVisualization = createMobilityVisualization(mobility);
                 addMobilityVisualization(mobility, mobilityVisualization);
             }
         }
     }
     else if (signal == PRE_MODEL_CHANGE) {
         if (dynamic_cast<cPreModuleDeleteNotification *>(object)) {
             if (auto mobility = dynamic_cast<IMobility *>(source)) {
                 auto mobilityVisualization = getMobilityVisualization(mobility);
                 removeMobilityVisualization(mobilityVisualization);
                 delete mobilityVisualization;
             }
         }
     }
     else
         throw cRuntimeError("Unknown signal");
 }

◆ removeAllMobilityVisualizations()

void inet::visualizer::MobilityVisualizerBase::removeAllMobilityVisualizations ( )

protectedvirtual

 {
     std::vector<const MobilityVisualization *> removedMobilityVisualizations;
     for (auto it : mobilityVisualizations)
         removedMobilityVisualizations.push_back(it.second);
     for (auto mobilityVisualization : removedMobilityVisualizations) {
         removeMobilityVisualization(mobilityVisualization);
         delete mobilityVisualization;
     }
 }

Referenced by preDelete().

◆ removeMobilityVisualization()

void inet::visualizer::MobilityVisualizerBase::removeMobilityVisualization ( const MobilityVisualization * visualization )

protectedvirtual

Reimplemented in inet::visualizer::MobilityCanvasVisualizer, and inet::visualizer::MobilityOsgVisualizer.

 {
     mobilityVisualizations.erase(mobilityVisualization->mobility->getId());
 }

Referenced by receiveSignal(), removeAllMobilityVisualizations(), inet::visualizer::MobilityOsgVisualizer::removeMobilityVisualization(), and inet::visualizer::MobilityCanvasVisualizer::removeMobilityVisualization().

◆ subscribe()

void inet::visualizer::MobilityVisualizerBase::subscribe ( )

protectedvirtual

 {
     visualizationSubjectModule->subscribe(IMobility::mobilityStateChangedSignal, this);
     visualizationSubjectModule->subscribe(PRE_MODEL_CHANGE, this);
 }

Referenced by initialize().

◆ unsubscribe()

void inet::visualizer::MobilityVisualizerBase::unsubscribe ( )

protectedvirtual

 {
     // NOTE: lookup the module again because it may have been deleted first
     auto visualizationSubjectModule = findModuleFromPar<cModule>(par("visualizationSubjectModule"), this);
     if (visualizationSubjectModule != nullptr) {
         visualizationSubjectModule->unsubscribe(IMobility::mobilityStateChangedSignal, this);
         visualizationSubjectModule->unsubscribe(PRE_MODEL_CHANGE, this);
     }
 }