src/BRepBuilderAPI/BRepBuilderAPI_Copy.hxx

   1 // Created on: 1994-12-12
   2 // Created by: Jacques GOUSSARD
   3 // Copyright (c) 1994-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _BRepBuilderAPI_Copy_HeaderFile
  18 #define _BRepBuilderAPI_Copy_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <BRepBuilderAPI_ModifyShape.hxx>
  25
  26 class TopoDS_Shape;
  27
  28 //! Duplication of a shape.
  29 //! A Copy object provides a framework for:
  30 //! -   defining the construction of a duplicate shape,
  31 //! -   implementing the construction algorithm, and
  32 //! -   consulting the result.
  33 class BRepBuilderAPI_Copy  : public BRepBuilderAPI_ModifyShape
  34 {
  35 public:
  36
  37   DEFINE_STANDARD_ALLOC
  38
  39   //! Constructs an empty copy framework. Use the function
  40   //! Perform to copy shapes.
  41   Standard_EXPORT BRepBuilderAPI_Copy();
  42
  43   //! Constructs a copy framework and copies the shape S.
  44   //! Use the function Shape to access the result.
  45   //! If copyMesh is True, triangulation contained in original shape will be
  46   //! copied along with geometry (by default, triangulation gets lost).
  47   //! If copyGeom is False, only topological objects will be copied, while
  48   //! geometry and triangulation will be shared with original shape.
  49   //! Note: the constructed framework can be reused to copy
  50   //! other shapes: just specify them with the function Perform.
  51   Standard_EXPORT BRepBuilderAPI_Copy(const TopoDS_Shape& S, const Standard_Boolean copyGeom = Standard_True, const Standard_Boolean copyMesh = Standard_False);
  52
  53   //! Copies the shape S.
  54   //! Use the function Shape to access the result.
  55   //! If copyMesh is True, triangulation contained in original shape will be
  56   //! copied along with geometry (by default, triangulation gets lost).
  57   //! If copyGeom is False, only topological objects will be copied, while
  58   //! geometry and triangulation will be shared with original shape.
  59   Standard_EXPORT void Perform (const TopoDS_Shape& S, const Standard_Boolean copyGeom = Standard_True, const Standard_Boolean copyMesh = Standard_False);
  60
  61 };
  62
  63 #endif // _BRepBuilderAPI_Copy_HeaderFile