MeVisLab/Standard/Sources/ML/MLBase/mlStylePalette.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------


#ifndef __mlStylePalette_H
#define __mlStylePalette_H



// ML-includes

#ifndef __mlModuleIncludes_H
#include "mlModuleIncludes.h"
#endif
#ifndef __mlTreeNode_H
#include "mlTreeNode.h"
#endif

// Local includes
#ifndef __mlBaseInit_H
#include "mlBaseInit.h"
#endif



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);
  
  virtual ~StylePalette ();

  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 ();

  void setMonoDefaults ();

  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 ---

  virtual void addStateToTree (TreeNode *parent) const;
  
  virtual void readStateFromTree (TreeNode *parent);

  ML_SET_ADDSTATE_VERSION(0);

  virtual StylePalette* clone() const { return new StylePalette(*this); };
  virtual StylePalette* deepCopy() const { 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