inet::visualizer::InfoCanvasVisualizer Class Reference

#include <InfoCanvasVisualizer.h>

Inheritance diagram for inet::visualizer::InfoCanvasVisualizer:

Classes
class	InfoCanvasVisualization

Protected Member Functions
virtual void	initialize (int stage) override
virtual InfoVisualization *	createInfoVisualization (cModule *module) const override
virtual void	addInfoVisualization (const InfoVisualization *infoVisualization) override
virtual void	removeInfoVisualization (const InfoVisualization *infoVisualization) override
virtual void	refreshInfoVisualization (const InfoVisualization *infoVisualization, const char *info) const override
Protected Member Functions inherited from inet::visualizer::InfoVisualizerBase
virtual void	handleParameterChange (const char *name) override
virtual void	refreshDisplay () const override
virtual void	addInfoVisualizations ()
virtual void	removeAllInfoVisualizations ()
virtual const char *	getInfoVisualizationText (cModule *module) const
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
ModuleRefByPar< NetworkNodeCanvasVisualizer >	networkNodeVisualizer
Protected Attributes inherited from inet::visualizer::InfoVisualizerBase
bool	displayInfos = false
ModuleFilter	modules
StringFormat	format
cFigure::Font	font
cFigure::Color	textColor
cFigure::Color	backgroundColor
double	opacity = NaN
Placement	placementHint
double	placementPriority
std::vector< const InfoVisualization * >	infoVisualizations
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::InfoVisualizerBase
virtual void	preDelete (cComponent *root) override

Member Function Documentation

addInfoVisualization()

void inet::visualizer::InfoCanvasVisualizer::addInfoVisualization ( const InfoVisualization *  infoVisualization )

overrideprotectedvirtual

Reimplemented from inet::visualizer::InfoVisualizerBase.

{
    InfoVisualizerBase::addInfoVisualization(infoVisualization);
    auto infoCanvasVisualization = static_cast<const InfoCanvasVisualization *>(infoVisualization);
    auto figure = infoCanvasVisualization->figure;
    infoCanvasVisualization->networkNodeVisualization->addAnnotation(figure, figure->getBounds().getSize(), placementHint, placementPriority);
}

createInfoVisualization()

InfoVisualizerBase::InfoVisualization * inet::visualizer::InfoCanvasVisualizer::createInfoVisualization ( cModule *  module ) const

overrideprotectedvirtual

Implements inet::visualizer::InfoVisualizerBase.

{
    auto figure = new BoxedLabelFigure("info");
    figure->setTags((std::string("info ") + tags).c_str());
    figure->setTooltip("This label represents some module information");
    figure->setAssociatedObject(module);
    figure->setZIndex(zIndex);
    figure->setFont(font);
    figure->setText(getInfoVisualizationText(module));
    figure->setLabelColor(textColor);
    figure->setBackgroundColor(backgroundColor);
    figure->setOpacity(opacity);
    auto networkNode = getContainingNode(module);
    auto networkNodeVisualization = networkNodeVisualizer->getNetworkNodeVisualization(networkNode);
    return new InfoCanvasVisualization(networkNodeVisualization, figure, module->getId());
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::visualizer::InfoVisualizerBase.

{
    InfoVisualizerBase::initialize(stage);
    if (!hasGUI()) return;
    if (stage == INITSTAGE_LOCAL) {
        zIndex = par("zIndex");
        networkNodeVisualizer.reference(this, "networkNodeVisualizerModule", true);
    }
}

refreshInfoVisualization()

void inet::visualizer::InfoCanvasVisualizer::refreshInfoVisualization ( const InfoVisualization *  infoVisualization, const char *  info  ) const

overrideprotectedvirtual

Implements inet::visualizer::InfoVisualizerBase.

{
    auto infoCanvasVisualization = static_cast<const InfoCanvasVisualization *>(infoVisualization);
    auto figure = infoCanvasVisualization->figure;
    figure->setText(info);
    infoCanvasVisualization->networkNodeVisualization->setAnnotationSize(figure, figure->getBounds().getSize());
}

removeInfoVisualization()

void inet::visualizer::InfoCanvasVisualizer::removeInfoVisualization ( const InfoVisualization *  infoVisualization )

overrideprotectedvirtual

Reimplemented from inet::visualizer::InfoVisualizerBase.

{
    InfoVisualizerBase::removeInfoVisualization(infoVisualization);
    auto infoCanvasVisualization = static_cast<const InfoCanvasVisualization *>(infoVisualization);
    auto figure = infoCanvasVisualization->figure;
    if (networkNodeVisualizer != nullptr)
        infoCanvasVisualization->networkNodeVisualization->removeAnnotation(figure);
}

Member Data Documentation

networkNodeVisualizer

ModuleRefByPar<NetworkNodeCanvasVisualizer> inet::visualizer::InfoCanvasVisualizer::networkNodeVisualizer

protected

Referenced by createInfoVisualization(), initialize(), and removeInfoVisualization().

zIndex

double inet::visualizer::InfoCanvasVisualizer::zIndex = NaN

protected

Referenced by createInfoVisualization(), and initialize().

---

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

• InfoCanvasVisualizer.h
• InfoCanvasVisualizer.cc