SoLDMResourceParameters.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 LDM_RESOURCE_PARAMETER_H
#define LDM_RESOURCE_PARAMETER_H
 
#ifdef _MSC_VER
#pragma warning( push )
#pragma warning(disable:4251)
#endif
 
#include <Inventor/fields/SoFieldContainer.h>
#include <Inventor/fields/SoSubFieldContainer.h>
 
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFUShort.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFVec3i32.h>
 
#include <Inventor/SbBox.h>
 
#include <Inventor/STL/vector>
#include <Inventor/STL/cassert>
 
class SoDataSet;
class SoLDMMediator;
class SoLDMTileVisitor;
class SoLDMResourceManager;

class  SoLDMResourceParameters : public SoFieldContainer
{
  SO_FIELDCONTAINER_HEADER(SoLDMResourceParameters);
 
public:
  struct FixedResolutionReport{
    enum ReportCode
    {
      PROGRESS,
      ABORT
    };

    ReportCode what;
    int numTilesToAdd;
    int numTilesToLoad;
    int numTilesLoaded;
  };

  typedef void FixedResolutionCB(FixedResolutionReport&, void*);

  enum LoadPolicy {
    NO_USER_INTERACTION,
    ALWAYS,
    NEVER
  };

  enum TileCachePolicy {
    NONE,

    LOWRES_ONLY,

    ALL
  };
 

  SoLDMResourceParameters();

  virtual ~SoLDMResourceParameters();

  SoSFInt32 maxMainMemory;
 
  SoSFInt32 maxTexMemory;

  SoSFEnum loadPolicy;

  SoSFEnum tileCachePolicy;

  SoSFInt32 tex3LoadRate;

  SoSFInt32 max2DTexMemory;

  SoSFInt32 tex2LoadRate;

  SoSFInt32 minResolutionThreshold;

  SoSFInt32 maxResolutionThreshold;

  SoSFVec3i32 tileDimension;

  SoSFVec3i32 subTileDimension;

  SoSFInt32 loadNotificationRate;

  SoSFFloat tileHalfLife;

  SoSFBool fixedResolution;

  SoSFInt32 resolution;

  SoSFInt32 numPrefetchThread;

  SoSFBool tileBorders;

  SoSFInt32 minTilesToLoad;

  enum ViewpointRefinementPolicy
  {
    VIEWPOINT_REFINEMENT_OFF,

    VIEWPOINT_REFINEMENT_ON,

    VIEWPOINT_REFINEMENT_INHERITED_FROM_GLOBAL,
  };

  SoSFEnum viewpointRefinementPolicy;

  enum ScreenResolutionCullingPolicy
  {
    SCREEN_RESOLUTION_CULLING_OFF,

    SCREEN_RESOLUTION_CULLING_ON,

    SCREEN_RESOLUTION_CULLING_INHERITED_FROM_GLOBAL,
  };

  SoSFEnum screenResolutionCullingPolicy;

  void setMovingTimeOut(float timeout);

  float getMovingTimeOut();

  int getDataSize();

  void enableFixedResolutionMode(int resolution, FixedResolutionCB* func);

  void setGeometryPriority(SoType geometryType, float priority);

  SbBool getGeometryPriority(SoType geometryType, float& priority);
 
private:
  typedef struct GeomPriority
  {
    float   m_weight;
    SoType  m_geomId;
  } GeomPriority;

  void setDataSet(SoDataSet *ds);

  void copyParameters(SoLDMMediator *mediator);

  void fprintfResourceManager(FILE *f);

  void invalidateData();

  void setNumTiles(int numTiles);

  int getNumTiles();

  SbBox3i32 XYZToVoxel(const SbBox3f &dataBox);
 

  bool isReportDisabled();
  void setReportDisabled(bool flag);
  FixedResolutionCB* getFixedResCB();
  int getNumTilesLoaded();
  bool toReport();
  void setToReport(bool flag);
  void increaseNumTilesLoaded();
  void decreaseNumTilesLoaded();
  void resetNumTilesLoaded();
  void resetFixedResVar();
 
  void sendToLdm(SoDataSet* ds);
 
  void enableParamsNotify(SbBool state);
 
  virtual void notify(SoNotList*);
 
  inline void setResourceManager(SoLDMResourceManager* resourceManager);

  inline void forceFixedResolution(bool flag);

  inline bool isFixedResolutionForced() const;

  enum Resolution {
    BEST = -1,
    FULL = 0
  };
 
private:
 
#if 1             
SoDEPRECATED
  SoSFInt32 overlapping;
 
#endif 
 
#if 1             
SoDEPRECATED
  SoSFInt32 maxTilesInMainMem;
SoDEPRECATED
  SoSFInt32 maxTilesInTexMem;
SoDEPRECATED
  SoSFBool fixedParams;
 
#endif 
 
#if 1             
SoDEPRECATED
  SoSFInt32 max2DTextures;
 
  // TODO: the following friend dependencies should be removed once internal dependencies are removed
  friend class SoLDMResourceManager;
#endif 
 
  // Deprecated in 9700 and removed (hidden) in 10000.
  // No longer used by the default heightfield rendering algorithm( SoHeightFieldRender )
  // Use SoComplexity instead.
  SoSFInt32 maxNumTriangles;
 
  bool m_forceFixedResolution;

  SoLDMResourceParameters& operator=(const SoLDMResourceParameters& ldmrp);
  SoLDMResourceParameters(const SoLDMResourceParameters& );
 
  //Methods used in ldmParameterChangedCB
  void updateTileHalfLife(float timeInSec);
  void updateTileSize();
  void updateMaxResolutionThreshold( int threshold );
  void updateMinResolutionThreshold( int threshold );
  void updateLoadPolicy( LoadPolicy loadPolicy );
  void updateEnableFixedResolutionMode(int resolution, FixedResolutionCB* func);
  void updateDisableFixedResolutionMode();
 
  SoDataSet* m_ds;
  SoLDMResourceManager* m_resourceMgr;
 
  FixedResolutionCB* m_fixedResCB;
  int  m_numTilesLoaded;
  int  m_numTilesNeeded;
  bool m_toReport;
  bool m_reportDisable;
  bool m_isFixedRes;
  bool m_bLdmParamDebug;

  int m_previousMinThreshold;
 
  //to save current system state before using fixed res mode
  LoadPolicy         m_policyUsed;
  int                m_resolution;
  SoLDMTileVisitor*  m_fixedResVisitor;
  SoLDMTileVisitor*  m_beforeFixedResVisitor;
  bool m_beforeFixedResVisitorFlag;
 
  float m_movingTimeOut; //keep not loading for timeOut sec after the user stopped interacting.
 
  std::vector<GeomPriority> m_geomPriority;
  int getGeometryIndex(SoType geometryType);
 
  static bool s_artForceFixed;
};
 
/***************************************************************************/
inline bool
SoLDMResourceParameters::isReportDisabled()
{
  return m_reportDisable;
}
 
/***************************************************************************/
inline void
SoLDMResourceParameters::setReportDisabled(bool flag)
{
  m_reportDisable = flag;
}
 
/***************************************************************************/
inline SoLDMResourceParameters::FixedResolutionCB*
SoLDMResourceParameters::getFixedResCB()
{
  return m_fixedResCB;
}
 
/***************************************************************************/
inline int
SoLDMResourceParameters::getNumTilesLoaded()
{
  return m_numTilesLoaded;
}
 
/***************************************************************************/
inline bool
SoLDMResourceParameters::toReport()
{
  return m_toReport;
}
 
/***************************************************************************/
inline void
SoLDMResourceParameters::setToReport(bool flag)
{
  m_toReport = flag;
}
 
/***************************************************************************/
inline void
SoLDMResourceParameters::increaseNumTilesLoaded()
{
  m_numTilesLoaded++;
}
 
/***************************************************************************/
inline void
SoLDMResourceParameters::decreaseNumTilesLoaded()
{
  m_numTilesLoaded--;
}
 
/***************************************************************************/
inline void
SoLDMResourceParameters::resetNumTilesLoaded()
{
  m_numTilesLoaded = 0;
}
 
/***************************************************************************/
inline void
SoLDMResourceParameters::setResourceManager(SoLDMResourceManager* resourceManager)
{
  m_resourceMgr = resourceManager;
}
 
/***************************************************************************/
inline SoLDMResourceParameters&
SoLDMResourceParameters::operator=(const SoLDMResourceParameters& )
{
  assert(0);
  return *this;
}
 
/***************************************************************************/
inline void
SoLDMResourceParameters::forceFixedResolution(bool flag)
{
  m_forceFixedResolution = flag;
}
 
/***************************************************************************/
inline bool
SoLDMResourceParameters::isFixedResolutionForced() const
{
  return m_forceFixedResolution || s_artForceFixed;
}
 
/***************************************************************************/
extern  std::ostream& operator << (std::ostream& os, const SoLDMResourceParameters& p);
 
#ifdef _MSC_VER
#pragma warning( pop )
#endif
 
#endif