GiShellToolkit.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_SHELLTOOLKIT_H_INCLUDED
#define ODGI_SHELLTOOLKIT_H_INCLUDED
 
#include "OdVector.h"
#include "Ge/GeExtents3d.h"
#include "GiGeometry.h"

class ODGI_EXPORT OdGiShellToolkit : public OdRxObject
{
public:
  
  enum ShellToolkitOption
  {
    kUnifyVertices = 1,
    kTriangulateHoles = 1 << 1,
    kForceTriangulation = 1 << 2,
    kKeepInitialData = 1 << 3
  };
  
  class ODGI_EXPORT OdGiShellFaceOrientationCallback
  {
  public:
    
    virtual bool isFaceOrientedCorrectly( const OdGePoint3d* pts, const OdInt32* face ) const
    {
      return true;
    }
  };
  
  struct ODGI_EXPORT OdGiShellOriginalFaceDescription
  {
    OdUInt32 nShell;
    OdUInt32 nOffset;
  };
  
  struct ODGI_EXPORT OdGiShellFaceDescription
  {
    OdUInt32 nOffset;
  };
  
  struct ODGI_EXPORT OdGiShellEdgeDescription
  {
    OdGiShellFaceDescription face;
    OdUInt32 nEdge;
  };

  struct ODGI_EXPORT OdGiShellEdgeVisibilityDescription
  {
    OdGiShellEdgeDescription edge;
    bool bVisible;
  };

  struct ODGI_EXPORT OdGiShellEdgeVisibilityOptions
  {
    bool bDuplicateEdges;
    bool bVisibleOnly;
    bool bIgnoreFlatHoles;
    
    OdGiShellEdgeVisibilityOptions() : bDuplicateEdges( false ), bVisibleOnly( true ), bIgnoreFlatHoles( false ){}
    
    OdGiShellEdgeVisibilityOptions( bool bDuplicate, bool bVisible, bool bNoFlatHoles = false ) : bDuplicateEdges( bDuplicate ), bVisibleOnly( bVisible ), bIgnoreFlatHoles( bNoFlatHoles ) {}
  };
 
  ODRX_DECLARE_MEMBERS( OdGiShellToolkit );
  
  static OdSmartPtr<OdGiShellToolkit> create();
  
  virtual bool addShell( OdUInt32 nPoints, const OdGePoint3d* pPoints, OdUInt32 nFaces, const OdInt32* pFaces, OdUInt8 options = OdGiShellToolkit::kTriangulateHoles ) = 0;
  
  virtual void clear() = 0;
  
  virtual bool hasDupilcateVertices() const = 0;
  
  virtual OdUInt32 numSharpEdges( bool bOnlyCount = true ) const = 0;
  
  virtual OdUInt32 numSingularEdges( bool bOnlyCount = true ) const = 0;
  
  virtual OdUInt32 numDegeneratedFaces() const = 0;
  
  virtual bool hasDuplicateFaces( OdUInt32* pFirstDuplicateFace = NULL, bool bRollFaces = false ) const = 0;
  
  virtual bool checkFacesOrientation() const = 0;
  
  virtual bool checkFacesOrientation( const OdGiShellFaceOrientationCallback* pCallback ) const = 0;
  
  virtual void unifyVertices() = 0;
  
  virtual void removeDegenerateFaces() = 0;
  
  virtual void removeDuplicateFaces( bool bRollFaces = false ) = 0;
  
  virtual bool fixFaceOrientation( bool bRestoreModel = true ) = 0;
  
  virtual bool fixFaceOrientation( const OdGiShellFaceOrientationCallback* pCallback, bool bRestoreModel = true ) = 0;
  
  virtual OdGeTol& tolerance() = 0;
  
  virtual const OdGeTol& tolerance() const = 0;
  
  virtual OdUInt32 numVertices() const = 0;
  
  virtual const OdGePoint3d* vertices() const = 0;
  
  virtual OdUInt32 faceListSize() const = 0;
  
  virtual const OdInt32* faceList() const = 0;
  
  virtual void getSharpEdges( OdArray< OdGiShellEdgeDescription >& edges, bool bOnlyCount = true, bool bIgnoreZeroHoldes = false ) const = 0;
  
  virtual void getSingularEdges( OdArray< OdGiShellToolkit::OdGiShellEdgeDescription >& edges, bool bOnlyCount = true ) const = 0;
  
  virtual void getIncorrectOrientedFaces( OdArray< OdGiShellFaceDescription >& faces, bool bAddNotOriented = true ) const = 0;
  
  virtual void getIncorrectOrientedFaces( const OdGiShellFaceOrientationCallback* pCallback, OdArray< OdGiShellFaceDescription >& faces, bool bAddNotOriented = true ) const = 0;
  
  virtual bool getOriginalFaceDescription( OdUInt32 nFaceOffset, OdGiShellOriginalFaceDescription& result ) const = 0;
  
  virtual void filterEdgesByCreaseAngle( OdArray< OdGiShellToolkit::OdGiShellEdgeDescription >& edges, double dAngle ) const = 0;
  
  virtual OdUInt32 numNonTriangleFaces() const = 0;
  
  virtual void triangulate() = 0;

  virtual bool calculateFaceNormals( OdArray< OdGeVector3d >& normals ) const = 0;

  virtual bool calculateAverageVertexNormals( OdArray< OdGeVector3d >& normals ) const = 0;

  typedef OdGeVector3d( *OdGiCalculateNormalCallback )( OdGiShellToolkit* pToolkit, OdUInt32 nVertexIndex );

  virtual bool calculateAverageVertexNormals( OdArray< OdGeVector3d >& normals, double creaseAngelLimit, OdGiCalculateNormalCallback pCallback = NULL ) const = 0;
  
  virtual bool calculateEdgeVisibilitiesByCreaseAngle( OdArray< bool >& visibilities, double creaseAngle ) const = 0;

  virtual bool calculateEdgeVisibilitiesByCreaseAngle( OdArray< OdGiShellEdgeVisibilityDescription >& visibilities, double creaseAngle, const OdGiShellEdgeVisibilityOptions& options = OdGiShellEdgeVisibilityOptions() ) const = 0;
};

typedef OdSmartPtr<OdGiShellToolkit> OdGiShellToolkitPtr;
 
#endif