SoInteractiveComplexity.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-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#ifndef SO_INTERACTIVE_COMPLEXITY_H
#define SO_INTERACTIVE_COMPLEXITY_H
 
#include <Inventor/nodes/SoNode.h>
#include <Inventor/fields/SoMFString.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFFloat.h>
 
#include <Inventor/STL/map>
#include <Inventor/sensors/SoAlarmSensor.h>
 
#ifdef _WIN32
#pragma warning( push )
#pragma warning(disable:4251) // disable warning 4251 "needs to have dll-interface to be used by clients of class..." caused by ScalarBoundsMap
#endif
 
class  SoInteractiveComplexity : public SoNode
{
  SO_NODE_HEADER(SoInteractiveComplexity);
 
public:
  SoInteractiveComplexity();
 
  enum InteractiveMode {
    AUTO,
    FORCE_INTERACTION,
    FORCE_STILL,
    DISABLED
  };
 
  SoMFString fieldSettings;
 
  SoSFFloat refinementDelay;
 
  SoSFEnum interactiveMode;
 
private:
  virtual void doAction(SoAction *action);
  virtual void GLRender(SoGLRenderAction *action);
 
private:
  virtual void notify(SoNotList *list);
 
  static void initClass();
  static void exitClass();
 
  double getScalarFieldValue(SoState* state, const SoSField* field);
  SbBool getBooleanFieldValue(SoState* state, const SoSFBool* field);
  int getEnumFieldValue(SoState* state, const SoSFEnum* field);
 
  bool isBounded(const SoField* field) const;
 
private:
  struct ScalarBounds
  {
    double startBound;
    double endBound;
    double increment;
    // used to return the previous val during delayed pass
    double currentVal;
    bool immediate;
  };
  typedef std::map<SbString, ScalarBounds> ScalarBoundsMap;
 
  virtual ~SoInteractiveComplexity();
 
  static SbBool isScalarField(const SoField* field);
 
  void updateFieldList();
  void addParameters(const SbString& paramString);
 
  void handleScalarParam(const SbString& paramString, const std::vector<SbString>& token);
  void handleBoolParam(const SbString& paramString, const std::vector<SbString>& token);
  void handleEnumParam(const SbString& paramString, const std::vector<SbString>& token,
                       const SoField* field);
 
  bool checkParamNumber(size_t numParam, size_t expected, const SbString& fieldName) const;
 
  void getClassAndFieldName(const SoField* field, SbString& className, SbString& fieldName) const;
 
  double getScalarFieldValue(SoState* state, const SoSField* field,
                             const SbString& classAndFieldName, bool updateValue = false);
 
  void updateAllFieldsValue(SoState* state);
 
  static void sensorCB(void *data, SoSensor *sensor);
 
  ScalarBoundsMap m_scalarBounds;
 
  SoAlarmSensor m_redrawSensor;
};
 
#if defined(_WIN32)
#pragma warning( pop )
#endif
 
#endif //SO_INTERACTIVE_COMPLEXITY_H