SoLDMGlobalResourceParameters.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-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#ifndef  _SO_LDM_GLOBAL_RESOURCE_PARAM_
#define  _SO_LDM_GLOBAL_RESOURCE_PARAM_
 
class SoLDMTileManager;
 
#include <LDM/SoLDM.h>
#include <Inventor/nodes/SoSubNode.h>
 
 
typedef void SoLDMLoadCB( SbBool startLoading, void *userData );
 
typedef void SoLDMMonitoringCB(SoDataSet *dataSet, double elapsedTime, double memLoaded, void *userData);
 
class  SoLDMGlobalResourceParameters
{
 
public:
  // Memory Control Parameters section
 
  static void setMaxMainMemory( int maxMainMemory );
 
  static int  getMaxMainMemory();
 
  static void setMaxTexMemory( int maxTexMemory );
 
  static int  getMaxTexMemory();
 
  static void setTex3LoadRate( int loadRate );
 
  static int  getTex3LoadRate();
 
  static void setTex2LoadRate( int loadRate );
 
  static int  getTex2LoadRate();
 
  static void         setNumIO(unsigned int numIO);
 
  static unsigned int getNumIO();
 
  // VisualFeedback Parameters section
 
  enum VisualFeedbackParam {
    DRAW_TILES,
    DRAW_SLICES_TEX,
    DRAW_TOPOLOGY,
    DRAW_TILE_OUTLINE,
    SHOW_TILES_VALUATED,
    SHOW_LOAD_UNLOAD_TILES,
    USE_FAKE_DATA
  };
 
  static void setVisualFeedbackParam( VisualFeedbackParam param, SbBool state );
 
  static SbBool getVisualFeedbackParam( VisualFeedbackParam param );
 
 
  // Viewing Parameters section
 
  static void setViewCulling( SbBool state, SbBool forceRedraw = TRUE );
 
  static SbBool getViewCulling();
 
  static void setScreenResolutionCulling( SbBool flag );
 
  static SbBool getScreenResolutionCulling();
 
  static void setIgnoreFullyTransparentTiles( SbBool state );
 
  static SbBool getIgnoreFullyTransparentTiles();
 
  static void setViewpointRefinement( SbBool state );
 
  static SbBool getViewpointRefinement();
 
  static void setSliceEqualResolution( SbBool state, SbBool forceRedraw = TRUE );
 
  static SbBool getSliceEqualResolution();
 
  static void setLoadNotificationRate(int);
 
  static int getLoadNotificationRate();
 
  static void setLoadCB( SoLDMLoadCB *func, void *userData = NULL );
 
  static void setMonitoringCB( SoLDMMonitoringCB *func, int memAmount, void *userData = NULL );
 
  static inline int64_t getDefaultMaxTexMem() { return s_defaultMaxTexMemMB; }
 
  static inline int64_t getDefaultMaxMainMem() { return s_defaultMaxMainMemMB; }
 
  static void setMax2DTexMemory(uint64_t maxMemory);
 
  static uint64_t getMax2DTexMemory();
 
#if 1             SoDEPRECATED
  static void setMoveLowResolution( SbBool state );
SoDEPRECATED
  static SbBool getMoveLowResolution();
 
#endif 
private:
 
  // These identifiers are binary fixed,
  // do not changed enum value as it will break ART scenario
  enum Cmd{
    SET_VISUAL_FEEDBACK_PARAM = 0,
    SET_MAX_MAIN_MEMORY = 1,
    SET_MAX_TEX_MEMORY = 2,
    SET_MAX_2D_TEXTURES = 3,
    SET_MAX_NUM_TRIANGLES = 4, // no more supported
    SET_TEX3_LOAD_RATE = 5,
    SET_TEX2_LOAD_RATE = 6,
    SET_NUMIO = 7,
    SET_WRITE_ALTERNATE_REP = 8,
    SET_READ_ALTERNATE_REP = 9,
    SET_DELAYED_RENDERING = 10,
    SET_VIEW_CULLING = 11,
    SET_SCREEN_RESOLUTION_CULLING = 12,
    SET_VIEWPOINT_REFINEMENT = 13,
    SET_IGNORE_FULLY_TRANSPARENT_TILES = 14,
    SET_SLICE_EQUAL_RES = 15,
    SET_MOVE_LOW_RES = 16,
    SET_LOAD_NOTIFICATION_RATE = 17
  };
 
  static void initClass();
 
  static bool isDrawingOutlines();
 
#if 1             SoDEPRECATED
  static size_t getMaxTextureSizeBytes();
 
#endif 
private:
 
// ------------------------------------------------------------
  // VisualFeedback Parameters
  static SbBool s_drawTiles;
  static SbBool s_drawSlicesTex;
  static SbBool s_drawTopology;
  static SbBool s_drawTileOutline;
  static SbBool s_showTilesLoaded;
  static SbBool s_showLoadUnloadTiles;
  static SbBool s_useFakeData;
  // ------------------------------------------------------------
  // Viewing Parameters
  static SbBool s_ignoreFullyTransparentTiles;
  static SbBool s_viewCulling;
  static SbBool s_screenResolutionCulling;
  static SbBool s_viewpointRefinement;
  static SbBool s_sliceEqualResolution;
  static SbBool s_moveLowResolution;
 
  static int64_t s_defaultMaxTexMemMB;
  static int64_t s_defaultMaxMainMemMB;
 
};
#endif // _SO_LDM_GLOBAL_RESOURCE_PARAM_