SoView2DLegend.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
 
 
#pragma once
 
#include "SoView2DSystem.h"
#include "SoView2DExtension.h"
 
#include <Inventor/fields/SoFields.h>
#include <vector>
 
class SoView2D;
class View2DFont;
 
enum LegendFontSize
{
    AUTO_SIZE_LEGEND = -1,
    SMALL_LEGEND     =  0,
    MEDIUM_LEGEND    =  1,
    LARGE_LEGEND     =  2
};
 
 
class LegendItem
{
public:
    LegendItem(){color= SbColor(1,1,1);
        line_width=1.0f;
        stipple = 0xffff;
    };
 
    LegendItem(const LegendItem &li){*this = li;};
 
    const LegendItem& operator=(const LegendItem& li){
        color = li.color;
        line_width = li.line_width;
        stipple = li.stipple;
        text = li.text;
 
        return *this;
    };
 
    SbColor  color;
    float line_width;
    unsigned short stipple;
    SbString text;
};
 
 
class SOVIEW2D_API SoView2DLegend : public SoView2DExtension
{
    SO_NODE_HEADER(SoView2DLegend);
 
public:
    enum LegendAlignPosition {
        LEGEND_TOP,
        LEGEND_BOTTOM,
        LEGEND_LEFT,
        LEGEND_RIGHT
    };
 
    enum LegendFormat {
        TEXT_LINE,
        LINE_TEXT
    };
 
    SoSFString legendString;
 
    SoSFFloat  margin;
    SoSFBool   showLegend;
    SoSFEnum   legendFontSize;
    SoSFEnum   legendAlignment;
    SoSFEnum   legendFormat;
    SoSFBool   textShadow;
    SoSFBool drawTheBox;
    SoSFColor boxColor;
 
    static void   initClass();
 
    // Constructor
    SoView2DLegend();
 
    // toggle legend display
    void toggleLegend();
 
protected:
    void   draw(View2DSliceList *dsl, View2DSlice* dslice, int slice) override;
 
    // evaluates keyboard and mouse events
    bool   evalEvent(SoView2D* view2d, View2DSliceList* slicelist, View2DEvent* ec, View2DEventPhase phase) override;
 
    virtual bool implementsManagedInteraction() const { return true; }
 
    bool implementsManagedInteractionAndClassicEventHandling() const override { return true; }
 
    void editingOnChanged(SoField* field) override;
 
private:
    void   parseString(const SbString &string);
 
    void   drawLegend(View2DSlice* slice, const float dx1, const float dy1, const float dx2, const float dy2, const int width, const int height,
                      View2DFont *font, const int fontSize, const int pos, const bool drawBox=FALSE);
 
    int    getFontSize(const int fontGroup) const;
 
    std::vector<LegendItem>_legendVector;
 
    long  _lastEventSecs;
    long  _lastEventUSecs;
 
    SoCommandAction* _toggleLegendAction;
};