GeomAPI_ShapeHierarchy.h

// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef GeomAPI_ShapeHierarchy_H_
#define GeomAPI_ShapeHierarchy_H_
 
#include "GeomAPI.h"
#include "GeomAPI_Shape.h"
 
#include <map>
#include <set>
#include <vector>
 
class GeomAPI_ShapeHierarchy
{
  typedef std::pair<GeomShapePtr, ListOfShape> ShapeAndSubshapes;
  typedef std::map<GeomShapePtr, GeomShapePtr, GeomAPI_Shape::Comparator> MapShapeToShape;
  typedef std::map<GeomShapePtr, size_t, GeomAPI_Shape::Comparator> MapShapeToIndex;
  typedef std::set<GeomShapePtr, GeomAPI_Shape::Comparator> SetOfShape;
 
  ListOfShape myObjects; 
  MapShapeToShape myParent; 
  MapShapeToIndex  myParentIndices;
  std::vector<ShapeAndSubshapes> mySubshapes;
 
  SetOfShape myProcessedObjects;
  MapShapeToShape myModifiedObjects;
 
public:
  GEOMAPI_EXPORT void addObject(const GeomShapePtr& theObject);
 
  GEOMAPI_EXPORT void addParent(const GeomShapePtr& theShape, const GeomShapePtr& theParent);
 
  GEOMAPI_EXPORT GeomShapePtr parent(const GeomShapePtr& theShape, bool theMarkProcessed = true);
  GEOMAPI_EXPORT GeomShapePtr root(const GeomShapePtr& theShape, bool theMarkProcessed = true);
 
  GEOMAPI_EXPORT void markProcessed(const GeomShapePtr& theShape);
  GEOMAPI_EXPORT void markProcessed(const ListOfShape& theShapes);
 
  GEOMAPI_EXPORT void markModified(const GeomShapePtr& theSource, const GeomShapePtr& theModified);
 
  GEOMAPI_EXPORT void splitCompound(const GeomShapePtr& theCompShape,
                                    ListOfShape& theUsed,
                                    ListOfShape& theNotUsed) const;
 
  GEOMAPI_EXPORT void compoundsOfUnusedObjects(ListOfShape& theDestination) const;
 
  GEOMAPI_EXPORT void topLevelObjects(ListOfShape& theDestination) const;
 
  GEOMAPI_EXPORT bool empty() const;
 
  const ListOfShape& objects() const { return myObjects; }
  GEOMAPI_EXPORT const ListOfShape& objects(GeomShapePtr theParent) const;
  GEOMAPI_EXPORT void objectsByType(ListOfShape& theShapesByType, ListOfShape& theOtherShapes,
      const GeomAPI_Shape::ShapeType theMinType = GeomAPI_Shape::COMPOUND,
      const GeomAPI_Shape::ShapeType theMaxType = GeomAPI_Shape::SHAPE) const;
 
private:
  GeomShapePtr collectSubs(const GeomShapePtr theTopLevelCompound,
                           const SetOfShape& theExcluded = SetOfShape(),
                           const MapShapeToShape& theModified = MapShapeToShape()) const;
 
public:
  class iterator : public std::iterator<std::forward_iterator_tag, GeomShapePtr>
  {
  public:
    GEOMAPI_EXPORT iterator() {}
 
  protected:
    iterator(GeomAPI_ShapeHierarchy* theHierarchy, bool isBegin = true);
 
    void skipAlreadyProcessed();
 
  public:
    GEOMAPI_EXPORT bool operator==(const iterator&) const;
    GEOMAPI_EXPORT bool operator!=(const iterator&) const;
 
    GEOMAPI_EXPORT iterator& operator++();
    GEOMAPI_EXPORT iterator  operator++(int);
 
    GEOMAPI_EXPORT GeomShapePtr operator*() const;
 
  private:
    GeomAPI_ShapeHierarchy* myHierarchy;
    ListOfShape::iterator myObject;
 
    friend class GeomAPI_ShapeHierarchy;
  };
 
  GEOMAPI_EXPORT iterator begin();
  GEOMAPI_EXPORT iterator end();
};
 
#endif