mlStylePalette.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
**
**************************************************************************************/
 
#ifndef ML_STYLE_PALETTE_H
#define ML_STYLE_PALETTE_H
 

 
// ML-includes
 
#include "mlModuleIncludes.h"
#include "mlTreeNode.h"
 
 
#include "mlBaseInit.h"
 
 
 
ML_START_NAMESPACE
 

 
#define MKT_DASH (static_cast<int>(StylePalette::mktDash))
 
 
//----------------------------------------------------------------------------------
// Base object class StylePalette

//----------------------------------------------------------------------------------
class MLBASEEXPORT StylePalette : public Base
{
public:

  StylePalette ();
  StylePalette (MLssize_t numStyles);
  StylePalette (const StylePalette &palette);

  ~StylePalette () override;

  StylePalette &operator = (const StylePalette &palette);
 
 
  // --- Type definitions ---

  typedef enum {
    lstNone = 0,
    lstSolid,
    lstDashed,
    lstDotted,
    lstNumLineStyles
  } LineStyle;

  typedef enum {
    mktNone = 0,
    mktDot,
    mktAsterisk,
    mktCircle,
    mktSquare,
    mktTriangle,
    mktPlus,
    mktCross,
    mktNumMarkerTypes,
    mktDash = -1                  
  } MarkerType;
 
 
  // --- Constants ---

  static const char *const lineStyleNames[lstNumLineStyles];

  static const char *const markerTypeNames[mktNumMarkerTypes];

  static const int defaultNumStyles;
 
 
  // --- Access methods ---

  MLssize_t getNumStyles () const { return _numStyles; }
  void setNumStyles (MLssize_t newNumStyles);

  Vector3 getColor (MLssize_t index) const;
  void getColor (MLssize_t index, float &r, float &g, float &b) const;
  void setColor (MLssize_t index, const Vector3 &color);
  void setColor (MLssize_t index, float r, float g, float b) { setColor(index, Vector3(r, g, b)); }

  LineStyle getLineStyle (MLssize_t index) const;
  void setLineStyle (MLssize_t index, LineStyle lst);
  int  getLineWidth (MLssize_t index) const;
  void setLineWidth (MLssize_t index, int lw);

  MarkerType getMarkerType (MLssize_t index) const;
  void setMarkerType (MLssize_t index, MarkerType mkt);
  int  getMarkerSize (MLssize_t index) const;
  void setMarkerSize (MLssize_t index, int ms);

  bool getAntiAlias (MLssize_t index) const;
  void setAntiAlias (MLssize_t index, bool aa);

  std::string getName (MLssize_t index) const;
  void setName (MLssize_t index, const std::string &n);

  MLssize_t getReservedEntries () const { return _reservedEntries; }
  void setReservedEntries (MLssize_t reserved);

  MLssize_t getAutoStyleIndex (MLssize_t n);

  void copyStylesFrom (const StylePalette &palette);

  void setColorDefaults ();

  const char *getLineStyleName (LineStyle lst) const {
    return lineStyleNames[static_cast<int>(lst)];
  }

  const char *getMarkerTypeName (MarkerType mkt) const {
    return markerTypeNames[static_cast<int>(mkt)];
  }

  void dumpStyles ();

  bool getStyleIndexForName(const std::string curveTitle, std::vector<MLssize_t> &indices);
 
  // --- Persistence ---

  void addStateToTree (TreeNode *parent) const override;

  void readStateFromTree (TreeNode *parent) override;

  ML_SET_ADDSTATE_VERSION(0);

  virtual StylePalette* clone() const { return new StylePalette(*this); };
  StylePalette* deepCopy() const override { return new StylePalette(*this); };
protected:
 
  // --- Methods ---

  void clear ();

  void init (MLssize_t numStyles);
 
 
private:
 
  // --- Data ---

  Vector3 *_colors;
  LineStyle *_lineStyles;
  int *_lineWidths;
  MarkerType *_markerTypes;
  int *_markerSizes;
  bool *_antiAlias;
  std::string *_names;

  MLssize_t _numStyles;

  MLssize_t _reservedEntries;
 
 
  // Runtime type system initialization
  ML_CLASS_HEADER(StylePalette)
 
};
 
 
ML_END_NAMESPACE
 
 
#endif
// __mlStylePalette_H