OCCT

// Created on: 1993-06-17
// Created by: Jean Yves LEBEY
// Copyright (c) 1993-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _TopOpeBRepDS_HDataStructure_HeaderFile
#define _TopOpeBRepDS_HDataStructure_HeaderFile

#include <Standard.hxx>
#include <Standard_Type.hxx>

#include <TopOpeBRepDS_DataStructure.hxx>
#include <TCollection_AsciiString.hxx>
#include <Standard_Transient.hxx>
#include <TopAbs_ShapeEnum.hxx>
#include <Standard_Integer.hxx>
#include <TopOpeBRepDS_Config.hxx>
#include <TopOpeBRepDS_Kind.hxx>
#include <TopOpeBRepDS_Interference.hxx>
#include <NCollection_List.hxx>
class TopoDS_Shape;
class TopOpeBRepDS_Surface;
class TopOpeBRepDS_CurveIterator;
class TopOpeBRepDS_Curve;
class TopOpeBRepDS_PointIterator;
class TopOpeBRepDS_Point;
class TopOpeBRepDS_SurfaceIterator;
class TopOpeBRepDS_Interference;

class TopOpeBRepDS_HDataStructure : public Standard_Transient
{

public:
  Standard_EXPORT TopOpeBRepDS_HDataStructure();

  Standard_EXPORT void AddAncestors(const TopoDS_Shape& S);

  //! Update the data structure with shapes of type T1
  //! containing a subshape of type T2 which is stored
  //! in the DS.
  //! Used by the previous one.
  Standard_EXPORT void AddAncestors(const TopoDS_Shape&    S,
                                    const TopAbs_ShapeEnum T1,
                                    const TopAbs_ShapeEnum T2);

  //! Check the integrity of the DS
  Standard_EXPORT void ChkIntg();

  Standard_EXPORT const TopOpeBRepDS_DataStructure& DS() const;

  Standard_EXPORT TopOpeBRepDS_DataStructure& ChangeDS();

  Standard_EXPORT int NbSurfaces() const;

  Standard_EXPORT int NbCurves() const;

  Standard_EXPORT int NbPoints() const;

  //! Returns the surface of index <I>.
  Standard_EXPORT const TopOpeBRepDS_Surface& Surface(const int I) const;

  //! Returns an iterator on the curves on the surface
  //! <I>.
  Standard_EXPORT TopOpeBRepDS_CurveIterator SurfaceCurves(const int I) const;

  //! Returns the Curve of index <I>.
  Standard_EXPORT const TopOpeBRepDS_Curve& Curve(const int I) const;

  //! Returns the Curve of index <I>.
  Standard_EXPORT TopOpeBRepDS_Curve& ChangeCurve(const int I);

  //! Returns an iterator on the points on the curve
  //! <I>.
  Standard_EXPORT TopOpeBRepDS_PointIterator CurvePoints(const int I) const;

  //! Returns the point of index <I>.
  Standard_EXPORT const TopOpeBRepDS_Point& Point(const int I) const;

  Standard_EXPORT int NbShapes() const;

  //! Returns the shape of index <I> in the DS
  Standard_EXPORT const TopoDS_Shape& Shape(const int I, const bool FindKeep = true) const;

  //! Returns the index of shape <S> in the DS
  //! returns 0 if <S> is not in the DS
  Standard_EXPORT int Shape(const TopoDS_Shape& S, const bool FindKeep = true) const;

  //! Returns True if <S> has new geometries.
  Standard_EXPORT bool HasGeometry(const TopoDS_Shape& S) const;

  //! Returns True if <S> has new geometries (SOLID,FACE,EDGE)
  //! or if <S> (SHELL,WIRE) has sub-shape (FACE,EDGE)
  //! with new geometries
  Standard_EXPORT bool HasShape(const TopoDS_Shape& S, const bool FindKeep = true) const;

  //! Returns True if <S> share a geometrical domain with
  //! some other shapes.
  Standard_EXPORT bool HasSameDomain(const TopoDS_Shape& S, const bool FindKeep = true) const;

  //! Returns an iterator on the SameDomain shapes attached
  //! to the shape <S>.
  Standard_EXPORT NCollection_List<TopoDS_Shape>::Iterator SameDomain(const TopoDS_Shape& S) const;

  //! Returns orientation of shape <S> compared with its
  //! reference shape
  Standard_EXPORT TopOpeBRepDS_Config SameDomainOrientation(const TopoDS_Shape& S) const;

  //! Returns orientation of shape <S> compared with its
  //! reference shape
  Standard_EXPORT int SameDomainReference(const TopoDS_Shape& S) const;

  //! Returns an iterator on the surfaces attached to the
  //! solid <S>.
  Standard_EXPORT TopOpeBRepDS_SurfaceIterator SolidSurfaces(const TopoDS_Shape& S) const;

  //! Returns an iterator on the surfaces attached to the
  //! solid <I>.
  Standard_EXPORT TopOpeBRepDS_SurfaceIterator SolidSurfaces(const int I) const;

  //! Returns an iterator on the curves attached to the
  //! face <F>.
  Standard_EXPORT TopOpeBRepDS_CurveIterator FaceCurves(const TopoDS_Shape& F) const;

  //! Returns an iterator on the curves attached to the
  //! face <I>.
  Standard_EXPORT TopOpeBRepDS_CurveIterator FaceCurves(const int I) const;

  //! Returns an iterator on the points attached to the
  //! edge <E>.
  Standard_EXPORT TopOpeBRepDS_PointIterator EdgePoints(const TopoDS_Shape& E) const;

  Standard_EXPORT int MakeCurve(const TopOpeBRepDS_Curve& C1, TopOpeBRepDS_Curve& C2);

  Standard_EXPORT void RemoveCurve(const int iC);

  Standard_EXPORT int NbGeometry(const TopOpeBRepDS_Kind K) const;

  Standard_EXPORT int NbTopology(const TopOpeBRepDS_Kind K) const;

  Standard_EXPORT int NbTopology() const;

  //! returns True if all the edges stored as shapes in the DS
  //! are SameParameter, otherwise False.
  Standard_EXPORT bool EdgesSameParameter() const;

  Standard_EXPORT void SortOnParameter(
    const NCollection_List<occ::handle<TopOpeBRepDS_Interference>>& L1,
    NCollection_List<occ::handle<TopOpeBRepDS_Interference>>&       L2) const;

  Standard_EXPORT void SortOnParameter(
    NCollection_List<occ::handle<TopOpeBRepDS_Interference>>& L) const;

  Standard_EXPORT void MinMaxOnParameter(
    const NCollection_List<occ::handle<TopOpeBRepDS_Interference>>& L,
    double&                                                         Min,
    double&                                                         Max) const;

  //! Search, among a list of interferences accessed by the iterator
  //! <IT>, a geometry <G> whose 3D point is identical to the 3D point
  //! of the TheDSPoint <PDS>.
  //! returns True if such an interference has been found, False else.
  //! if True, iterator It points (by the Value() method) on the first
  //! interference accessing an identical 3D point.
  Standard_EXPORT bool ScanInterfList(
    NCollection_List<occ::handle<TopOpeBRepDS_Interference>>::Iterator& IT,
    const TopOpeBRepDS_Point&                                           PDS) const;

  //! Get the geometry of a DS point <PDS>.
  //! Search for it with ScanInterfList (previous method).
  //! if found, set <G,K> to the geometry,kind of the interference found.
  //! returns the value of ScanInterfList().
  Standard_EXPORT bool GetGeometry(
    NCollection_List<occ::handle<TopOpeBRepDS_Interference>>::Iterator& IT,
    const TopOpeBRepDS_Point&                                           PDS,
    int&                                                                G,
    TopOpeBRepDS_Kind&                                                  K) const;

  //! Add interference <I> to list <LI>.
  Standard_EXPORT void StoreInterference(
    const occ::handle<TopOpeBRepDS_Interference>&             I,
    NCollection_List<occ::handle<TopOpeBRepDS_Interference>>& LI,
    const TCollection_AsciiString&                            str = "");

  //! Add interference <I> to list of interference of shape <S>.
  Standard_EXPORT void StoreInterference(const occ::handle<TopOpeBRepDS_Interference>& I,
                                         const TopoDS_Shape&                           S,
                                         const TCollection_AsciiString&                str = "");

  //! Add interference <I> to list of interference of shape <IS>.
  Standard_EXPORT void StoreInterference(const occ::handle<TopOpeBRepDS_Interference>& I,
                                         const int                                     IS,
                                         const TCollection_AsciiString&                str = "");

  Standard_EXPORT void StoreInterferences(
    const NCollection_List<occ::handle<TopOpeBRepDS_Interference>>& LI,
    const TopoDS_Shape&                                             S,
    const TCollection_AsciiString&                                  str = "");

  Standard_EXPORT void StoreInterferences(
    const NCollection_List<occ::handle<TopOpeBRepDS_Interference>>& LI,
    const int                                                       IS,
    const TCollection_AsciiString&                                  str = "");

  Standard_EXPORT void ClearStoreInterferences(
    const NCollection_List<occ::handle<TopOpeBRepDS_Interference>>& LI,
    const TopoDS_Shape&                                             S,
    const TCollection_AsciiString&                                  str = "");

  Standard_EXPORT void ClearStoreInterferences(
    const NCollection_List<occ::handle<TopOpeBRepDS_Interference>>& LI,
    const int                                                       IS,
    const TCollection_AsciiString&                                  str = "");

  DEFINE_STANDARD_RTTIEXT(TopOpeBRepDS_HDataStructure, Standard_Transient)

private:
  TopOpeBRepDS_DataStructure myDS;
};

#endif // _TopOpeBRepDS_HDataStructure_HeaderFile