MoLegend.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#ifndef  _MoLegend_
#define  _MoLegend_
 
#include <MeshVizXLM/mapping/nodes/MoMeshBaseRepresentation.h>
#include <MeshVizXLM/mapping/interfaces/MiColorMapping.h>
 
#include <MeshVizXLM/MbVec3.h>
 
#include <Inventor/misc/SoRef.h>
#include <Inventor/caches/SoCache.h>
#include <Inventor/fields/SoSFDouble.h>
#include <Inventor/fields/SoSFVec2f.h>
#include <Inventor/fields/SoSFUInt32.h>
 
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable:4251)
#endif
 
class SoState;
class SbColorRGBA;
class MdSurfaceMeshRectilinear;
 
class MxScalarSetIj;
class MdSurfaceMesh;
class MdLevelColorMapping;
class MdLinearColorMapping;
class MdPredefinedColorMapping;
 
 
class MESHVIZXLM_DMAP_API MoLegend : public MoMeshBaseRepresentation {
 
  SO_NODE_HEADER(MoLegend) ;
 
public:
 
  MoLegend() ;
 
  SoSFVec2f bottomLeft;
 
  SoSFVec2f topRight;
 
  SoSFDouble minValue;
 
  SoSFDouble maxValue;
 
  SoSFBool vertical;
 
  SoSFString title;
 
  SoSFFloat titleFontSize;
 
  SoSFColor titleColor;
 
  enum Position {   
    POS_BOTTOM,  
    POS_TOP,     
    POS_RIGHT,   
    POS_LEFT     
  } ;
 
  SoSFEnum titlePosition;
 
  SoSFBool displayValues;
 
 
  SoSFInt32 numValues;
 
  SoSFColor valuesColor;
    
  SoSFFloat valuesFontSize;
 
  enum Notation {
    NOTATION_DEFAULT,
    NOTATION_FIXED,
    NOTATION_SCIENTIFIC
  };
 
  SoSFEnum valueNotation;
 
  SoSFUInt32 valuePrecision;
 
  /*----------------------------------------------------------------------------*/
  private:
  virtual void doAction(SoAction *action);
 
  private:
  static void initClass() ;
  static void exitClass() ;
 
private:
  virtual ~MoLegend() ;  
 
  void fillLegend(SoState* state);
  void fillLevelCM(SoState* state, const MdLevelColorMapping& levelCM);
  void fillLinearCM(SoState* state, const MdLinearColorMapping& linearCM);
  void fillPredefCM(SoState* state, const MdPredefinedColorMapping& predefCM);
  void fillCustomCM(SoState* state, const MiColorMapping<double,SbColorRGBA>& customCM);
  void createMesh(SoState* state, int ind, std::vector<float>& coords0, std::vector<float> coords1, float xmin, float xmax, double vmin, double vmax);
  void getLegendRange(const MiColorMapping<double, SbColorRGBA>& cmap,double& vmin,double& vmax);
 
  void drawTitle(SoState* state);
  void drawValues(SoState* state,double vmin, double vmax);
  
  void clear();
 
  MdSurfaceMesh* m_surface;
  SoSeparator*   m_textGroup;
  SoSeparator*   m_valuesGroup;
  MdSurfaceMeshRectilinear* m_legendMesh;
  MxScalarSetIj* m_scalarSet;
private:
  SoRef<SoCache> m_cache;
  void buildCache( SoState *state );
  SbBool checkCache( SoState *state );
} ;
 
#ifdef _WIN32
#pragma warning(pop)
#endif
 
#endif /* _MoLegend_ */