PoValueLegend.h

/*=======================================================================
 *** 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-2022 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef  _PO_VALUE_LEGEND_
#define  _PO_VALUE_LEGEND_
 
#include <MeshViz/graph/PoLegend.h>
 
#include <MeshViz/graph/PbNumericDisplayFormat.h>
#include <MeshViz/graph/PbDataMapping.h>
 
#include <Inventor/fields/SoSFUShort.h>
#include <Inventor/fields/SoSFString.h>
 
class PbIsovaluesList ;

class  PoValueLegend : public PoLegend {
 
  SO_KIT_HEADER(PoValueLegend) ;
 
  /* Define fields for new parts */
  SO_KIT_CATALOG_ENTRY_HEADER(multFactorSep) ;
  SO_KIT_CATALOG_ENTRY_HEADER(multFactorApp) ;
  SO_KIT_CATALOG_ENTRY_HEADER(multFactor) ;
 
 
 public:
 
  /* Fields */

  SoSFString upperUndefString ;

  SoSFString lowerUndefString ;

  SoSFUShort periodValue ;

  SoSFUShort firstValue ;

  SoSFUShort lastValue ;
 
 
 
  /* Methods */

  void setIsovaluesList(PbIsovaluesList *isovaluesList) ;

  const PbIsovaluesList* getIsovaluesList() const ;

  void setDataMapping(PbDataMapping *dataMapping) ;

  const PbDataMapping *getDataMapping() const ;

  void setFormat(PbNumericDisplayFormat *format) ;

  const PbNumericDisplayFormat *getFormat() const ;
 
  /*----------------------------------------------------------------------------*/
 private:
  static void initClass() ;
    static void exitClass() ;
 
 private:
  // Box representation definition
  // This structure is the representation of one box
  struct BoxRepresentation {
    int      numColors ;          // = 0 no color, = -1 inherited color
    SbColor  colorList[2] ; 
    float    value ;
    float    value2 ;             // Use for interval legend
    float    transparency  ;
    float    transparency2 ;      // Use for interval legend  
    SbBool   isTransparency ;
    SbString string ;
 
    float    *percentPerColor ;   // Not used for the moment
    SbBool   isColorShaded ;      // Not used for the moment
  } ;
 
  enum LegendType {
    DATA_MAPPING_LEGEND,
    ISOVALUE_LEGEND,
    NO_LEGEND
  } ;
 
  enum LegendOrientation {
    HORIZONTAL_LEGEND,
    VERTICAL_LEGEND
  } ;
  
  enum MultFactorPosition {
    MULT_FACTOR_POS_UP_MIDDLE,
    MULT_FACTOR_POS_RIGHT_MIDDLE,
    MULT_FACTOR_POS_DOWN_MIDDLE
  } ;
 
  // Constructor
  PoValueLegend() ;
 
  // Methods
  virtual void   setDefaultOnNonWritingFields() ;
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
  
  // Destructor
  virtual ~PoValueLegend() ;
 
  // Manage the connection with PbBase objects
  virtual void basicObjectChange(PbBase *basicObj) ;
 
  // Compute boxes representation
  void computeBoxColors(int index, SbBool isIntervalLegend) ;
 
  // Compute undef box representation
  // lowerUndefIndex = -1 no lower undef representation
  // upperUndefIndex = -1 no upper undef representation
  void computeUndefBoxRepresentation(int lowerUndefIndex, int upperUndefIndex) ;
 
  // Compute list of values
  void computeValuesList() ;
 
  // Create box representation list
  void newBoxRepresentationList(int num) ;
 
  // Delete box representation list
  void deleteBoxRepresentationList() ;
 
  // Overloaded methods
  virtual void addElementsAllCaches() ;
  virtual void preRebuild() ;
 
  // List of boxes representation
  BoxRepresentation *m_boxRepresentationList ;
  int               m_numBoxRepresentation ;
  
  // List of values to display (this list is computed thanks to
  // data mapping and isovalues list).
  float      *m_valuesList ;
  int        m_numberValues ;
  SbBool     m_isLowerUndef, m_isUpperUndef ;
  LegendType m_legendType ; 
  
  // DataMapping Type
  PbDataMapping::ClassType m_dataMappingType ;
  float                    m_transparencyDeletedParts ;
  
  // Orientation of the legend (HORIZONTAL or VERTICAL)
  LegendOrientation m_legendOrientation ;
  
  // Multiplicative factor in the legend
  SbBool    m_isMultFactor ;
  SbString  m_multFactorExpString ;   // Exponent of the mult factor
  float     m_multFactorWidth ;
 
 private:
  // Default numeric format
  PbNumericDisplayFormat m_defaultNumericFormat ;
 
  // Numeric diplay format 
  PbNumericDisplayFormat *m_numericDisplayFormat ;
 
  // Data mapping
  PbDataMapping *m_dataMap ;
 
  // Isovalue list
  PbIsovaluesList *m_isovalList ;
 
  // Sensors
  FieldSensorList m_fieldSensorList ;
  
  // List of fields defined in this class
  SoFieldList     m_fieldList ;
} ;
 
/*----------------------------------------------------------------------------*/
 
#endif /* _PO_VALUE_LEGEND_ */