GiProgressiveMesh.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
#ifndef ODGI_PROGRESSIVEMESH_H_INCLUDED
#define ODGI_PROGRESSIVEMESH_H_INCLUDED
 
#include "OdStreamBuf.h"
#include "OdVector.h"
#include "Ge/GeExtents3d.h"
#include "GiGeometry.h"
class OdGiViewport;
class OdGiProgressiveMesh;

class ODGI_EXPORT OdGiDataExtractor
{
public:
  virtual bool registerDataBegin( OdUInt8 dataId, OdUInt64 localOffset ) = 0;
  virtual bool registerDataEnd( OdUInt8 dataId, OdUInt64 localOffset ) = 0;
  virtual OdUInt64 tell() = 0;
  virtual bool beginExtraction( OdUInt8 dataId ) = 0;
  virtual bool endExtraction( OdUInt8 dataId ) = 0;
  virtual bool seekFromLocalOffset( OdUInt64 offset ) = 0;
  virtual void extractBytes( void* buffer, OdUInt32 numBytes ) = 0;
  virtual double extractDouble();
  virtual OdInt64 extractInt64();
  virtual OdInt32 extractInt32();
  virtual OdInt16 extractInt16();
  virtual OdUInt8 extractByte();
  virtual bool extractBool();
};

struct ODGI_EXPORT OdGiProgressiveMeshVertexData
{
  enum VertexDataFlags
  {
    kVertexDataNormals = 1,
    kVertexDataColors = 1 << 1,
    kVertexDataUVs = 1 << 2
  };

  OdVector< OdGeVector3d > normals;
  OdVector< OdCmEntityColor > colors;
  OdVector< OdGePoint3d > UV;
};

struct ODGI_EXPORT OdGiProgressiveMeshFaceData
{
  enum FaceDataFlags
  {
    kFaceDataMaterials = 1,
    kFaceDataColors = 1 << 1,
    kFaceDataNormals = 1 <<2
  };

  OdVector< OdDbStub* > materials;
  OdVector< OdCmEntityColor > colors;
  OdVector< OdGeVector3d > normals;
};

struct ODGI_EXPORT OdGiProgressiveMeshEdgeData
{
  enum EdgeDataFlags
  {
    kEdgeDataVisibilities = 1
  };

  OdVector< OdUInt8 > visibilities;
};

class ODGI_EXPORT OdGiProgressiveMeshObjectIdConverter
{
public:
  virtual OdInt64 dbStubToInt( OdDbStub* ) const = 0;
  virtual OdDbStub* intToDbStub( OdInt64 ) const = 0;
};

class ODGI_EXPORT OdGiProgressiveMeshAutoLODSelectCallback
{
public:
  virtual OdUInt32 selectLOD( const OdGiProgressiveMesh* pPM, const OdGiViewport* pView, const OdGeMatrix3d* pModelToWorldTransform ) const = 0;
};

class ODGI_EXPORT OdGiProgressiveMeshAutoLODSelectOptions
{
public:
  OdGiProgressiveMeshAutoLODSelectOptions()
  {
    m_nMinPixels = 10;
    m_nMaxPixels = (OdUInt32)( 300.0 * sqrt( 3.0 ) );
  }

  ~OdGiProgressiveMeshAutoLODSelectOptions() {}
  OdUInt32 maxPixels() const { return m_nMaxPixels; }
  void setMaxPixels( OdUInt32 nMax ) { m_nMaxPixels = nMax; }
  OdUInt32 minPixels() const { return m_nMinPixels; }
  void setMinPixels( OdUInt32 nMin ) { m_nMinPixels = nMin; }
//DOM-IGNORE-BEGIN
protected:
  OdUInt32 m_nMinPixels;
  OdUInt32 m_nMaxPixels;
//DOM-IGNORE-END
};

class ODGI_EXPORT OdGiProgressiveMesh : public OdRxObject
{
public:
  enum ProgressiveMeshStreamVersion
  {
    kVersion1,
    kVersion2,
    kVersionActual = kVersion2
  };

  enum ProgressiveMeshAutoSelectLOD
  {
    kCustom = 0,            //Custom LOD select by callback
    kSqrInterpolation = 1,  //Square interpolation LOD select
    kSqrtInterpolation = 2  //Square root interpolation LOD select
  };
  ODRX_DECLARE_MEMBERS(OdGiProgressiveMesh);
  virtual bool obtainShell( OdVector< OdGePoint3d >& pts, OdVector< OdInt32 >& faces ) const = 0;
  virtual OdUInt32 obtainVertexData( OdGiProgressiveMeshVertexData& data, OdUInt32 flags ) const = 0;
  virtual OdUInt32 obtainFaceData( OdGiProgressiveMeshFaceData& data, OdUInt32 flags ) const = 0;
  virtual OdUInt32 obtainEdgeData( OdGiProgressiveMeshEdgeData& data, OdUInt32 flags ) const = 0;
  virtual OdUInt32 numLODs() const = 0;
  virtual OdUInt32 currentLOD() const = 0;
  virtual bool setLOD( OdUInt32 ) = 0;
  virtual OdUInt32 selectLOD( ProgressiveMeshAutoSelectLOD lod, const OdGiViewport* pView, const OdGeMatrix3d* pModelToWorldTransform = NULL ) = 0;
  virtual OdGiProgressiveMeshAutoLODSelectOptions& autoSelectLODOptions() = 0;
  virtual const OdGiProgressiveMeshAutoLODSelectOptions& autoSelectLODOptions() const = 0;
  virtual void setAutoSelectLODOptions( const OdGiProgressiveMeshAutoLODSelectOptions& options ) = 0;
  virtual void setCustomLODAutoSelectCallback( OdGiProgressiveMeshAutoLODSelectCallback* pCallback ) = 0;
  virtual OdGiProgressiveMeshAutoLODSelectCallback* getCustomLODAutoSelectCallback() const = 0;
  virtual OdUInt32 numFaces() const = 0;
  virtual OdUInt32 numVertices() const = 0;
  virtual const OdGeExtents3d& extents() const = 0;
  virtual bool write( OdStreamBuf* pBuff, const OdGiProgressiveMeshObjectIdConverter* pConverter = NULL, ProgressiveMeshStreamVersion version = kVersionActual ) const = 0;
  virtual bool isInPartialMode() const = 0;
  virtual void endPartialMode() = 0;
  virtual OdUInt64 getObjectSize() const = 0;
};

typedef OdSmartPtr<OdGiProgressiveMesh> OdGiProgressiveMeshPtr;

class ODGI_EXPORT OdGiProgressiveMeshGeneratorOptions
{
public:
  OdGiProgressiveMeshGeneratorOptions();
  
  ~OdGiProgressiveMeshGeneratorOptions();

  OdUInt32 minVertices() const { return m_minVertices; }
  void setMinVertices( OdUInt32 n ) { m_minVertices = n; }
  OdUInt32 minFaces() const { return m_minFaces; }
  void setMinFaces( OdUInt32 n ) { m_minFaces = n; }
  double worstDiherial() const { return m_worstDiherial; }
  void setWorstDiherial( double d ) { m_worstDiherial = d; }
  double smallestCost() const { return m_minCost; }
  void setSmallestCost( double d ) { m_minCost = d; }
  double worstCost() const { return m_worstCost; }
  void setWorstCost( double d ) { m_worstCost = d; }
  double infinity() const { return m_infinity; }
  void setInfinity( double d ) { m_infinity = d; }
  bool getFitNormals() const { return GETBIT( m_flags, kFlag_FitNormals ); }
  double normalErrorFactor() const { return m_normalErrorFactor; }
  void setFitNormals( bool bFit, double errorFactor )
  {
    SETBIT( m_flags, kFlag_FitNormals, bFit );
    m_normalErrorFactor = errorFactor;
  }

  bool getFitColors() const { return GETBIT( m_flags, kFlag_FitColors ); }
  double colorErrorFactor() const { return m_colorErrorFactor; }
  void setFitColors( bool bFit, double errorFactor )
  {
    SETBIT( m_flags, kFlag_FitColors, bFit );
    m_colorErrorFactor = errorFactor;
  }

  double sharpEdgesScaleFactor() const { return m_sharpEdgesScaleFactor; }
  void setSharpEdgesScaleFactor( double d ) { m_sharpEdgesScaleFactor = d; }

  double nextCostThresholdFactor() const { return m_nextCostThresholdFactor; }
  void setNextCostThresholdFactor( double d ) { m_nextCostThresholdFactor = d; }

  bool getDiffMaxPenalty() const { return GETBIT( m_flags, kFlag_DesH ); }
  double diffMaxPenaltyFactor() const { return m_desdFactor; }
  void setDiffMaxPenalty( bool bSet, double factor )
  {
    SETBIT( m_flags, kFlag_DesH, bSet );
    m_desdFactor = factor;
  }

  bool getSumPenalty() const { return GETBIT( m_flags, kFlag_DesN ); }
  double sumPenaltyFactor() const { return m_desnFactor; }
  void setSumPenalty( bool bSet, double factor )
  {
    SETBIT( m_flags, kFlag_DesN, bSet );
    m_desnFactor = factor;
  }

  OdUInt8 strictSharp() const { return m_strictSharp; }
  //Unsupported for now
  /*void setStrictSharp( OdUInt8 val ) 
  { 
    ODA_ASSERT( val < 3 );
    m_strictSharp = val;
  }*/
  OdUInt32 numFaceSamplePoints() const { return m_numFaceSamplePoints; }
  void setNumFaceSamplePoints( OdUInt32 n ) { m_numFaceSamplePoints = n; }
 
//DOM-IGNORE-BEGIN
private:
  enum OptionFlags
  {
    kFlag_FitNormals = 1,
    kFlag_FitColors = 1 << 1,
    kFlag_DesH = 1 << 2,
    kFlag_DesN = 1 << 3
  };
  OdUInt8 m_flags;
  OdUInt32 m_minVertices;
  OdUInt32 m_minFaces;
  double m_worstDiherial;
  double m_worstCost;
  double m_minCost;
  double m_infinity;
  double m_normalErrorFactor;     //normal error (0..2) to dist/diam rms, need to constant in front of normal error term
  double m_colorErrorFactor;      //color rms (0..sqrt(3)) to dist/diam rms, need to constant in front of color error term
  double m_sharpEdgesScaleFactor; //scale number of sharp edge samples
  double m_nextCostThresholdFactor;
  double m_desdFactor;            //penalize diff max #desc to balance tree
  double m_desnFactor;            //penalize sum #desc to balance tree
  OdUInt8 m_strictSharp;          //disallow disc. curve topo type changes {0, 1, 2}
  OdUInt32 m_numFaceSamplePoints; //number of face sample points, -1 means == face num
//DOM-IGNORE-END
};

class ODGI_EXPORT OdGiProgressiveMeshGenerator
{
public:
  enum Status
  {
    kStatus_Ok = 0,                               //Progressive mesh is OK
    kStatus_DegenerateFacesIgnored = 1,           //Some faces from input are skipped since they are degenerative
    kStatus_NonManifoldFacesIgnored = 1 << 1,     //Some faces from input are skipped since they cause non-manifold
    kStatus_InvalidFacesIgnored = 1 << 2,         //Some faces from input are skipped since they are invalid (not 3 or 4 points, contains points out of input points range, etc)
    kStatus_ZeroNormalFacesIgnored = 1 << 3,      //Some faces from input are skipped since they have zero normal
    kStatus_NonTriangleFaceTriangulated = 1 << 4  //Some faces from input were not triangle and were triangulated
  };

  static OdGiProgressiveMeshGenerator* createObject();

  virtual ~OdGiProgressiveMeshGenerator() {};

  virtual OdUInt8 setupInitialShell( OdInt32 nPoints, const OdGePoint3d * points, OdInt32 faceListSize, const OdInt32 * faces ) = 0;
  virtual OdGiProgressiveMeshPtr buildProgressiveMesh( const OdGiVertexData* pVertexData = NULL, const OdGiFaceData* pFaceData = NULL, const OdGiEdgeData* pEdgeData = NULL ) = 0;
  virtual OdGiProgressiveMeshPtr createProgressiveMeshFrom( OdStreamBuf* pBuff, const OdGiProgressiveMeshObjectIdConverter* pConverter = NULL, 
    OdGiProgressiveMesh::ProgressiveMeshStreamVersion version = OdGiProgressiveMesh::kVersionActual ) const = 0;
  virtual OdGiProgressiveMeshPtr createPartialProgressiveMeshFrom( OdStreamBuf* pBuff, OdGiDataExtractor* pDataExtractor,
    const OdGiProgressiveMeshObjectIdConverter* pConverter = NULL,
    OdGiProgressiveMesh::ProgressiveMeshStreamVersion version = OdGiProgressiveMesh::kVersionActual ) const = 0;
  virtual const OdGiProgressiveMeshGeneratorOptions& options() const = 0;
  virtual OdGiProgressiveMeshGeneratorOptions& options() = 0;
  virtual void setOptions( const OdGiProgressiveMeshGeneratorOptions& ) = 0;
};

class ODGI_EXPORT OdGiProgressiveMeshEx : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdGiProgressiveMeshEx);
  virtual bool obtainShell( OdVector< OdGePoint3d >& pts, OdVector< OdInt32 >& faces ) const = 0;
  virtual OdUInt32 obtainVertexData( OdGiProgressiveMeshVertexData& data, OdUInt32 flags ) const = 0;
  virtual OdUInt32 obtainFaceData( OdGiProgressiveMeshFaceData& data, OdUInt32 flags ) const = 0;
  virtual OdUInt32 obtainEdgeData( OdGiProgressiveMeshEdgeData& data, OdUInt32 flags ) const = 0;
  virtual OdUInt32 numLODs() const = 0;
  virtual OdUInt32 currentLOD() const = 0;
  virtual bool setLOD( OdUInt32 ) = 0;
  virtual OdUInt32 numFaces() const = 0;
  virtual OdUInt32 numVertices() const = 0;
  virtual const OdGeExtents3d& extents() const = 0;
  virtual bool write( OdStreamBuf* pBuff, const OdGiProgressiveMeshObjectIdConverter* pConverter = NULL, OdGiProgressiveMesh::ProgressiveMeshStreamVersion version = OdGiProgressiveMesh::kVersionActual ) const = 0;
  virtual bool isProgressiveMeshGenerated() const = 0;
  virtual void setupInitialShell( OdInt32 nPoints, const OdGePoint3d * points, OdInt32 faceListSize, const OdInt32 * faces ) = 0;
  virtual bool buildProgressiveMesh( const OdGiVertexData* pVertexData = NULL, const OdGiFaceData* pFaceData = NULL, const OdGiEdgeData* pEdgeData = NULL ) = 0;
  virtual bool readProgressiveMeshExFrom( OdStreamBuf* pBuff, const OdGiProgressiveMeshObjectIdConverter* pConverter = NULL, 
    OdGiProgressiveMesh::ProgressiveMeshStreamVersion version = OdGiProgressiveMesh::kVersionActual ) = 0;
  virtual bool readPartialProgressiveMeshExFrom( OdStreamBuf* pBuff, OdGiDataExtractor* pDataExtractor, const OdGiProgressiveMeshObjectIdConverter* pConverter = NULL,
    OdGiProgressiveMesh::ProgressiveMeshStreamVersion version = OdGiProgressiveMesh::kVersionActual ) = 0;

  virtual const OdGiProgressiveMeshGeneratorOptions& options() const = 0;
  virtual OdGiProgressiveMeshGeneratorOptions& options() = 0;
  virtual void setOptions( const OdGiProgressiveMeshGeneratorOptions& ) = 0;
  virtual void setGenerationAbortFlags( OdUInt8 flags ) = 0;
  virtual OdUInt8 generationAbortFlags() const = 0;
  virtual void setProgressiveMesh( OdGiProgressiveMeshPtr pMesh ) = 0;
  virtual OdGiProgressiveMeshPtr progressiveMesh() const = 0;
  virtual bool hasData() const = 0;
  virtual OdUInt64 getObjectSize() const = 0;
};

typedef OdSmartPtr<OdGiProgressiveMeshEx> OdGiProgressiveMeshExPtr;
 
#endif