TerrainViz/SbTVizData.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      : C. OGNIER (Feb 2001)
**=======================================================================*/

#ifndef SBTVIZDATA_H
#define SBTVIZDATA_H

#include <Inventor/SbLinear.h>
#include <Inventor/SbString.h>

typedef float ZType;
//typedef unsigned char ZType;
class SoDEPRECATED SbTVizData {

 public:

  enum OpenMode {
    TVIZ_UNKNOWN = 0,
    TVIZ_ASCII,
    TVIZ_BINARY
  };

  enum DataType {
    TVIZ_UCHAR = 0,
    TVIZ_USHORT,
    TVIZ_UINT32,
    TVIZ_FLOAT,
    TVIZ_CHAR,
    TVIZ_SHORT,
    TVIZ_INT32
  };

  enum Encoding {
    TVIZ_BIG_ENDIAN = 0,
    TVIZ_LITTLE_ENDIAN
  };


  enum Condition {
      TVIZ_LOWER = 0,
      TVIZ_LOWER_OR_EQUAL,
      TVIZ_EQUAL,
      TVIZ_GREATER,
      TVIZ_GREATER_OR_EQUAL
  };



  virtual ~SbTVizData(){};
  virtual float getValue(const SbVec2d& point) const = 0;
  virtual float getAvgValue() const = 0;
  virtual float getMaxValue() const = 0;
  virtual float getMinValue() const = 0;
  const SbString& getFileName() const;
  const SbVec3d&  getSize() const;
  const SbVec3d&  getOffset() const;

  void setHoleValue(float value, Condition cond);
  float getHoleValue(Condition& cond) const;

  void setHoleEdgePrecision(float holeRez);
  float getHoleEdgePrecision() const;

  DataType getDataType() const;
  OpenMode getOpenMode() const;
  Encoding getEncoding() const;
  virtual SbBool writeDataFile(const SbString& filename, OpenMode mode) = 0;

 private:
  float getRange() const;
  float getTypicalRange() const;
  float getTypicalMinHeight() const;
  float getTypicalMaxHeight() const;
  float getTypeRange() const;

  virtual SbBool isOfType(SbString& className) const = 0;

  virtual ZType getZValue(SbVec2i32 coord) const = 0;
  virtual float getModellingZValue(SbVec2i32 coord) const = 0;

  // Holes
  enum holeStatus {
    HOLE_OUT,
    HOLE_INTERSECT,
    HOLE_IN
  };

  SbBool      hasHoles() const {return holeFlag;}
  
  SbBool      isInHole(ZType v0) const;
  holeStatus  isInHole(ZType v0, ZType v1, ZType v2) const;

  SbVec2s& getStretchedSize() { return stretchedSize; }

 private:
  SbTVizData(){};

  SbBool    holeFlag;
  float     avgValue;
  float     maxValue;
  float     minValue;
  SbString  fileName;
  SbVec3d   offset;
  Encoding  encoding;
  OpenMode  openMode;
  DataType  dataType;
  float     range;
  SbVec3d   size;
  float     holeValue;
  float     holeRez;
  Condition holeCondition;
  SbVec2s   stretchedSize;

  // Typical values are values covered by the data.
  float     typicalRange;
  float     typicalMinHeight;
  float     typicalMaxHeight;

  // typeRange is the range covered by the type (char, float...) 
  // of the data (rough value from the given file/array).
  float     typeRange;
  
};

#endif

---

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