DirectViz/SoDirectVizManager.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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : G.TALLEC (Oct 2006)
**=======================================================================*/


#ifndef  _SO_DIRECTVIZ_MANAGER_
#define  _SO_DIRECTVIZ_MANAGER_

#include <SoVersion.h>

// On Windows the "comment" pragma will automatically add our DirectViz
// library to the application's link string.
//#  if !defined(SOQT) || defined(LOAD_DIGVIZ_FOR_IVTUNE)

#ifdef _WIN32
#  if defined(_DEBUG)
#    define __DIRECTVIZDLL "DirectVizD.dll"
#    define __DIRECTVIZLIB "DirectVizD.lib"
#  else
#    define __DIRECTVIZDLL "DirectViz.dll"
#    define __DIRECTVIZLIB "DirectViz.lib"
#  endif
#  ifndef DirectViz_EXPORTS
#    ifndef OIV_DISABLE_AUTOLINK
#      pragma comment(lib,__DIRECTVIZLIB)
#    endif
#  endif
#else
#  define __DIRECTVIZDLL "libDirectViz"
#endif

#include <Inventor/SbLinear.h>
#include <Inventor/SbString.h>
#include <Inventor/actions/SoGLRenderAction.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/fields/SoSFInt32.h> 
#include <Inventor/fields/SoMFInt32.h> 
#include <Inventor/fields/SoSFBool.h> 
#include <Inventor/fields/SoSFFloat.h> 
#include <Inventor/fields/SoSFFieldContainer.h>
#include <Inventor/fields/SoMFBool.h> 
#include <Inventor/fields/SoSFEnum.h> 

class SoSceneManager;
class SoCamera;
class SoNode;
class SoFieldContainer;
class SoFieldSensor;
class SoSensor;
class SoDirectVizShader;
class SoDirectVizRenderAction;
class SoDirectVizRenderManager;
class SoDirectVizCacheManager;
class SoDirectVizOpenRTManager;
class SoDirectVizDialog;
class SoDirectVizAction;

#include <Inventor/SoModule.h>
SO_MODULE_HEADER( SoDirectViz, __DIRECTVIZDLL )


//
//  Class: SoDirectVizManager
//
// DirectViz rendering manager
// 
//
class SoDEPRECATED SoDirectVizManager : public SoNode{

  SO_NODE_HEADER(SoDirectVizManager);

public:

  ~SoDirectVizManager();

  enum CacheMode
  {
    READ_WRITE_MODE,
    READ_MODE,
    WRITE_MODE
  };

  enum EnvLights  
  {
      ENV_LIGHTS_0,
      ENV_LIGHTS_2,
      ENV_LIGHTS_4,
      ENV_LIGHTS_8,
      ENV_LIGHTS_16,
      ENV_LIGHTS_32,
      ENV_LIGHTS_64,
      ENV_LIGHTS_128,
      ENV_LIGHTS_256
  };

  SoSFBool accumulation;

  SoSFInt32 maxAccumulationValue;

  SoSFBool subSampling;

  SoSFFloat subSamplingFactor;

  SoSFInt32 recursionLimit;

  SoSFBool subRecursion;

  SoSFBool progressiveRendering;

  SoSFInt32 numProgressiveRenderingSteps;

  SoSFBool rendering;

  SoSFBool globalShadowing;

  SoSFBool adaptiveOversampling;

  SoSFBool softShadows;

  SoSFBool fuzzyLights;

  SoSFBool glossySurfaces;

  SoSFEnum numEnvLights;

  SoSFFloat envLightIntensityScale;

  SoSFBool fileCaching;

  SoSFBool controlDialog;

  static void init();

  static void finish();

  static bool isInitialized();

  static SoDirectVizManager *getInstance(SoSceneManager *mgr);

  int getCurrentAccumValue() const;

  void getRenderedImageSize(SbVec2s &size) const;

  double getLastRenderTime() const;

  void setCacheDirectory(SbString directory);

  void setCacheFile(SbString file,CacheMode mode = READ_WRITE_MODE);

  int getNumEnvironmentLights();

   void setCamera(SoCamera *camera);
  //----------------------------------------------------------------------------------------------------

  private:

  typedef enum{
    FORCE_RENDER = 0,//forcing viewer rendering
    CHECK_STILL_TIME,//must check still time
    GENERATING,//is generating
    SIZE_CHANGED,
    STILL,//is still
    ASK_REDRAW,//redraw asked
    FORCE_REDRAW,//true if redraw forced
    CLEAR_ACCUM_BUFFER,//true if must clear accum buffer
    FIRST_RENDER,//true if first render
    SUBSAMPLED,//true if if last image was subsampled
    FORCE_CAMERA_SETUP,
    FORCE_ACCUMULATION,
    DISABLE_SUBSAMPLING_CHECK,
    PRIVATE_BOOL_STATES
  } privateBoolStates;
  
  typedef enum{
    CURRENT_ACCUM_VALUE = 0,//current accumulation value
    CURRENT_PROGRESSIVE_RENDER,//current progressive rendering value
    PRIVATE_INT_STATES
  } privateIntStates;

  private:

  SoDirectVizManager();

  //stop rendering current frame 
  void stopFrame();

  void setManageRenderingProperties( bool manage );

  bool manageRenderingProperties();

  void forceCameraSetup();
  
  void setAccuId( unsigned int accuId );

  void forceAccumulation( bool forceAccum );

  void disableSubSamplingCheck( bool disableCheck );

  //returns enum value corresponding to number of lights
  int getEnvLightsEnumValue( int numLights );

  //returns num env lights corresponding to enum value
  int getNumEnvironmentLights( int enumValue );

  static SoDirectVizManager * getInstance();

  typedef enum{
    ACTIVE=0,
    BUILT
  } DirectVizObjectState;

  typedef enum{
    SEPARATOR=0,
    SHADER,
    ENVIRONMENT,
    TEXTURE,//RESPECT ORDER
    LIGHT,
    SHAPE,
    CAMERA,
    NUMVECTORS,
    OBJECT
  } DirectVizObjectType;

  static void initClass();

  static void exitClass();

  static void setViewer(void *viewer){_viewer = viewer;}

  static void *getViewer(){return _viewer;}

  int getNumRTObjects(DirectVizObjectType t,DirectVizObjectState s) const;

  int getNumRTObjects(DirectVizObjectType t) const;

  void setRecursionLimit(int limit,SbBool forceRedraw = true);

  static SoDirectVizManager *instance();

  SoDirectVizCacheManager *getCacheMgr();

  SoDirectVizOpenRTManager *getOpenRTMgr(){
    return _openRTMgr;
  }

  void generatePixMap();

  void internalEnable(SbBool enable);

  void render(bool forceRender = true);

  void checkCache(bool startTraversal);

  SoSceneManager *getSceneManager() const;

  void setSceneManager(SoSceneManager *sceneManager);

  void setSceneRoot(SoNode *sceneRoot);

  unsigned int getShaderClass(SoNode *node);

  unsigned int getShaderClass(SoDirectVizShader *shader);

  int getShaderClassType(SoNode *node);

  void setSceneGraph(SoNode *node);

  void setMsg(SbString msg);

  void setDialog(SoDirectVizDialog *dialog){_dialog = dialog;}

  SoDirectVizRenderManager *_renderMgr;

  static SoDirectVizManager *_directVizManager;

  SoDirectVizDialog *_dialog;

  SbBool getInitialisationState(){return _openRTInitialized;}

  void setQuality(int quality);

  bool initRendering();

  void redraw();

  void internalRedraw(SbBool fromOffscreen = FALSE);

  void initialize();

  void readConfigFile();

  void clear();

  SoDirectVizRenderAction *getRenderAction() const;

  SoDirectVizAction *_directVizAction;

  SoNode *getSceneGraph() const;

  SbVec2s _size,_lastSize;

  void storeRenderingState();
  
  void restoreRenderingState();
 
private:

    //Stored bool rendering state
    bool m_storedBoolRenderingState[PRIVATE_BOOL_STATES];
    
    //Stored int rendering state
    int m_storedIntRenderingState[PRIVATE_INT_STATES];

    //stored size
    SbVec2s m_storedSize;

    bool m_manageRenderingProperties;

 private :

  static int s_initRefCount;

  static const char *s_versionString;

  void notify(SoNotList *list);


  void setupCamera();

  SoSFFieldContainer m_sceneManager;

  SoSFFieldContainer m_sceneGraph;
    
  SoGLRenderAction *_oldAction;

  SoSceneManager *_sceneManager;

  SoSFFieldContainer m_camera;
  SoCamera * getCamera() const;
 
  SoDirectVizRenderAction *_renderAction;

  SoCamera *_camera;

  int _oldLimit;

  SoMFBool _privateBoolState;
  
  SoMFInt32 _privateIntState;
  
  SbBool m_clusterMode;

  static SbBool _openRTInitialized;

  double _lastRenderTime;

  SoDirectVizCacheManager *_cacheMgr;

  SoDirectVizOpenRTManager *_openRTMgr;

  static void *_viewer;

  friend class SoDirectVizCacheManager;
  friend class SoDirectVizRenderAction;
  friend class SoDirectVizRenderManager;
  
  static bool isGuiBase(const SoFieldContainer *fc);   
};

class SoGuiBase;
class SoSceneManager;
class SoCamera;

extern "C" {
 void directviz_init();
 void directviz_finish();
 bool directviz_check();
 int32_t directviz_getShortcutValue();
 bool directviz_isLoadedGui( bool );
 void* directviz_getViewer();
 void directviz_setViewer(void*);
 void directviz_showDialog( bool, SoNode*, SoGuiBase* );
 void directviz_hideDialog( bool );
 void directviz_deleteDialog();
 SoNode* directviz_getInstance( SoSceneManager* );
 void directviz_internalEnable( SbBool, SoSceneManager*, SoCamera*, SoNode*, SoGuiBase*);
 void directviz_setCamera( SoSceneManager*, SoCamera*, SoNode* );
};

#endif

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/