inet::visualizer::NetworkNodeCanvasVisualization Class Reference

#include <NetworkNodeCanvasVisualization.h>

Inheritance diagram for inet::visualizer::NetworkNodeCanvasVisualization:

Classes
class	Annotation

Public Member Functions
	NetworkNodeCanvasVisualization (cModule *networkNode, double annotationSpacing, double displacementPenalty)
virtual void	refreshDisplay () override
virtual void	addAnnotation (cFigure *figure, cFigure::Point size, Displacement displacement=DISPLACEMENT_ANY, double displacementPriority=0)
virtual void	removeAnnotation (cFigure *figure)
virtual void	setAnnotationSize (cFigure *figure, cFigure::Point size)
virtual void	setAnnotationVisible (cFigure *figure, bool visible)

Protected Member Functions
virtual void	layout ()

Protected Attributes
cModule *	networkNode = nullptr
double	annotationSpacing = NaN
double	displacementPenalty = NaN
bool	isLayoutInvalid = false
cFigure::Rectangle	submoduleBounds
std::vector< Annotation >	annotations
cPanelFigure *	annotationFigure = nullptr

Constructor & Destructor Documentation

inet::visualizer::NetworkNodeCanvasVisualization::NetworkNodeCanvasVisualization	(	cModule *	networkNode,
		double	annotationSpacing,
		double	displacementPenalty
	)

                                                                                                                                         :
    cGroupFigure(networkNode->getFullName()),
    networkNode(networkNode),
    annotationSpacing(annotationSpacing),
    displacementPenalty(displacementPenalty)
{
    annotationFigure = new cPanelFigure("annotation");
    addFigure(annotationFigure);
    submoduleBounds = getEnvir()->getSubmoduleBounds(networkNode);
    submoduleBounds.x = -submoduleBounds.width / 2;
    submoduleBounds.y = -submoduleBounds.height / 2;
}

Member Function Documentation

void inet::visualizer::NetworkNodeCanvasVisualization::addAnnotation ( cFigure *  figure, cFigure::Point  size, Displacement  displacement = DISPLACEMENT_ANY, double  displacementPriority = 0  )

virtual

Referenced by inet::visualizer::TransportConnectionCanvasVisualizer::addConnectionVisualization(), inet::visualizer::Ieee80211CanvasVisualizer::addIeee80211Visualization(), inet::visualizer::RadioCanvasVisualizer::addRadioVisualization(), and inet::visualizer::StatisticCanvasVisualizer::addStatisticVisualization().

{
    annotations.push_back(Annotation(figure, size, displacementHint, displacementPriority));
    annotationFigure->addFigure(figure);
    isLayoutInvalid = true;
}

void inet::visualizer::NetworkNodeCanvasVisualization::layout ( )

protectedvirtual

Referenced by refreshDisplay().

{
    std::vector<cFigure::Rectangle> rcs;  // rectangles of annotations already positioned
    std::vector<cFigure::Point> pts;  // candidate points where annotations may be positioned
    cFigure::Rectangle extendendSubmoduleBounds = submoduleBounds;
    extendendSubmoduleBounds.x -= annotationSpacing / 2;
    extendendSubmoduleBounds.y -= annotationSpacing / 2;
    extendendSubmoduleBounds.width += annotationSpacing;
    extendendSubmoduleBounds.height += annotationSpacing;
    rcs.push_back(extendendSubmoduleBounds);
    pts.push_back(getTopLeft(extendendSubmoduleBounds));
    pts.push_back(getTopCenter(extendendSubmoduleBounds));
    pts.push_back(getTopRight(extendendSubmoduleBounds));
    pts.push_back(getCenterLeft(extendendSubmoduleBounds));
    pts.push_back(getCenterRight(extendendSubmoduleBounds));
    pts.push_back(getBottomLeft(extendendSubmoduleBounds));
    pts.push_back(getBottomCenter(extendendSubmoduleBounds));
    pts.push_back(getBottomRight(extendendSubmoduleBounds));

    std::sort(annotations.begin(), annotations.end(), Annotation::compareDisplacementPriority);

    // delete all annotation positions
    for (auto it = annotations.begin(); it != annotations.end(); it++) {
        auto& annotation = *it;
        annotation.bounds.x = NaN;
        annotation.bounds.y = NaN;
    }

    for (auto it = annotations.begin(); it != annotations.end(); it++) {
        auto& annotation = *it;
        if (!annotation.figure->isVisible())
            continue;
        cFigure::Point rs = cFigure::Point(annotation.bounds.width + annotationSpacing, annotation.bounds.height + annotationSpacing);

        // find the best minimizing the distance cost function
        double bestDistance = std::numeric_limits<double>::infinity();
        cFigure::Rectangle bestRc;

        // for all candidate points
        for (int j = 0; j < (int)pts.size(); j++) {
            cFigure::Point pt = pts[j];

            // align annotation to candidate points with its various points
            for (int k = 0; k < 8; k++) {
                cFigure::Rectangle candidateRc;
                switch (k) {
                    case 0:
                        // candidate point is top left
                        candidateRc = createRectangle(pt - cFigure::Point(0, 0), rs);
                        break;
                    case 1:
                        // candidate point is top center
                        candidateRc = createRectangle(pt - cFigure::Point(rs.x / 2, 0), rs);
                        break;
                    case 2:
                        // candidate point is top right
                        candidateRc = createRectangle(pt - cFigure::Point(rs.x, 0), rs);
                        break;
                    case 3:
                        // candidate point is center left
                        candidateRc = createRectangle(pt - cFigure::Point(0, rs.y / 2), rs);
                        break;
                    case 4:
                        // candidate point is center right
                        candidateRc = createRectangle(pt - cFigure::Point(rs.x, rs.y / 2), rs);
                        break;
                    case 5:
                        // candidate point is bottom left
                        candidateRc = createRectangle(pt - cFigure::Point(0, rs.y), rs);
                        break;
                    case 6:
                        // candidate point is bottom center
                        candidateRc = createRectangle(pt - cFigure::Point(rs.x / 2, rs.y), rs);
                        break;
                    case 7:
                        // candidate point is bottom right
                        candidateRc = createRectangle(pt - cFigure::Point(rs.x, rs.y), rs);
                        break;
                }

                double distance = 0;
                distance += getClosestDisplacementDistance(submoduleBounds, annotation.displacementHint, getTopLeft(candidateRc)) * displacementPenalty;
                distance += getClosestDisplacementDistance(submoduleBounds, annotation.displacementHint, getTopRight(candidateRc)) * displacementPenalty;
                distance += getClosestDisplacementDistance(submoduleBounds, annotation.displacementHint, getBottomLeft(candidateRc)) * displacementPenalty;
                distance += getClosestDisplacementDistance(submoduleBounds, annotation.displacementHint, getBottomRight(candidateRc)) * displacementPenalty;

                // find an already positioned annotation which would intersect the candidate rectangle
                bool intersects = false;
                for (int l = 0; l < (int)rcs.size(); l++) {
                    cFigure::Rectangle rc = rcs[l];
                    if (intersectsRectangle(candidateRc, rc)) {
                        intersects = true;
                        break;
                    }
                }
                if (intersects)
                    continue;

                // if better than the current best
                distance += getCenterCenter(submoduleBounds).distanceTo(getCenterCenter(candidateRc));
                if (distance < bestDistance) {
                    bestRc = candidateRc;
                    bestDistance = distance;
                    if (distance == 0)
                        goto found;
                }
            }
        }

    found:
        // store position and rectangle
        annotation.bounds.x = bestRc.x + annotationSpacing / 2;
        annotation.bounds.y = bestRc.y + annotationSpacing / 2;
        annotation.figure->setTransform(cFigure::Transform().translate(annotation.bounds.x, annotation.bounds.y));

        // delete candidate points covered by best rc
        for (int j = 0; j < (int)pts.size(); j++) {
            cFigure::Point pt = pts[j];

            if (containsPoint(bestRc, pt))
                pts.erase(pts.begin() + j--);
        }

        // push new candidates
        pushUnlessContains(pts, rcs, getTopLeft(bestRc));
        pushUnlessContains(pts, rcs, getTopCenter(bestRc));
        pushUnlessContains(pts, rcs, getTopRight(bestRc));
        pushUnlessContains(pts, rcs, getCenterLeft(bestRc));
        pushUnlessContains(pts, rcs, getCenterRight(bestRc));
        pushUnlessContains(pts, rcs, getBottomLeft(bestRc));
        pushUnlessContains(pts, rcs, getBottomCenter(bestRc));
        pushUnlessContains(pts, rcs, getBottomRight(bestRc));

        rcs.push_back(bestRc);
    }
}

void inet::visualizer::NetworkNodeCanvasVisualization::refreshDisplay ( )

overridevirtual

{
    if (isLayoutInvalid) {
        layout();
        isLayoutInvalid = false;
    }
}

void inet::visualizer::NetworkNodeCanvasVisualization::removeAnnotation ( cFigure *  figure )

virtual

Referenced by inet::visualizer::MediumCanvasVisualizer::radioRemoved(), inet::visualizer::TransportConnectionCanvasVisualizer::removeConnectionVisualization(), inet::visualizer::Ieee80211CanvasVisualizer::removeIeee80211Visualization(), inet::visualizer::RadioCanvasVisualizer::removeRadioVisualization(), and inet::visualizer::StatisticCanvasVisualizer::removeStatisticVisualization().

{
    for (auto it = annotations.begin(); it != annotations.end(); it++) {
        auto& annotation = *it;
        if (annotation.figure == figure) {
            annotations.erase(it);
            break;
        }
    }
    annotationFigure->removeFigure(figure);
    isLayoutInvalid = true;
}

void inet::visualizer::NetworkNodeCanvasVisualization::setAnnotationSize ( cFigure *  figure, cFigure::Point  size  )

virtual

{
    for (auto it = annotations.begin(); it != annotations.end(); it++) {
        auto& annotation = *it;
        if (annotation.figure == figure) {
            annotation.bounds.width = size.x;
            annotation.bounds.height = size.y;
            break;
        }
    }
    isLayoutInvalid = true;
}

void inet::visualizer::NetworkNodeCanvasVisualization::setAnnotationVisible ( cFigure *  figure, bool  visible  )

virtual

Referenced by inet::visualizer::MediumCanvasVisualizer::receptionEnded(), inet::visualizer::MediumCanvasVisualizer::receptionStarted(), inet::visualizer::MediumCanvasVisualizer::transmissionEnded(), and inet::visualizer::MediumCanvasVisualizer::transmissionStarted().

{
    figure->setVisible(visible);
    isLayoutInvalid = true;
}

Member Data Documentation

cPanelFigure* inet::visualizer::NetworkNodeCanvasVisualization::annotationFigure = nullptr

protected

Referenced by addAnnotation(), NetworkNodeCanvasVisualization(), and removeAnnotation().

std::vector<Annotation> inet::visualizer::NetworkNodeCanvasVisualization::annotations

protected

Referenced by addAnnotation(), layout(), removeAnnotation(), and setAnnotationSize().

double inet::visualizer::NetworkNodeCanvasVisualization::annotationSpacing = NaN

protected

Referenced by layout().

double inet::visualizer::NetworkNodeCanvasVisualization::displacementPenalty = NaN

protected

Referenced by layout().

bool inet::visualizer::NetworkNodeCanvasVisualization::isLayoutInvalid = false

protected

Referenced by addAnnotation(), refreshDisplay(), removeAnnotation(), setAnnotationSize(), and setAnnotationVisible().

cModule* inet::visualizer::NetworkNodeCanvasVisualization::networkNode = nullptr

protected

cFigure::Rectangle inet::visualizer::NetworkNodeCanvasVisualization::submoduleBounds

protected

Referenced by layout(), and NetworkNodeCanvasVisualization().

---

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

• NetworkNodeCanvasVisualization.h
• NetworkNodeCanvasVisualization.cc