Back to home page

EIC code displayed by LXR

 
 

    


File indexing completed on 2026-09-26 09:02:34

0001 // Created on: 1993-07-06
0002 // Created by: Remi LEQUETTE
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016 
0017 #ifndef _BRepBuilderAPI_HeaderFile
0018 #define _BRepBuilderAPI_HeaderFile
0019 
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023 
0024 #include <Standard_Real.hxx>
0025 class Geom_Plane;
0026 
0027 //! The BRepBuilderAPI package provides an Application
0028 //! Programming Interface for the BRep topology data
0029 //! structure.
0030 //!
0031 //! The API is a set of classes aiming to provide:
0032 //!
0033 //! * High level and simple calls for the most common
0034 //! operations.
0035 //!
0036 //! * Keeping an access on the low-level
0037 //! implementation of high-level calls.
0038 //!
0039 //! * Examples of programming of high-level operations
0040 //! from low-level operations.
0041 //!
0042 //! * A complete coverage of modelling:
0043 //!
0044 //! - Creating vertices ,edges, faces, solids.
0045 //!
0046 //! - Sweeping operations.
0047 //!
0048 //! - Boolean operations.
0049 //!
0050 //! - Global properties computation.
0051 //!
0052 //! The API provides classes to build objects:
0053 //!
0054 //! * The constructors of the classes provides the
0055 //! different constructions methods.
0056 //!
0057 //! * The class keeps as fields the different tools
0058 //! used to build the object.
0059 //!
0060 //! * The class provides a casting method to get
0061 //! automatically the result with a function-like
0062 //! call.
0063 //!
0064 //! For example to make a vertex <V> from a point <P>
0065 //! one can write:
0066 //!
0067 //! V = BRepBuilderAPI_MakeVertex(P);
0068 //!
0069 //! or
0070 //!
0071 //! BRepBuilderAPI_MakeVertex MV(P);
0072 //! V = MV.Vertex();
0073 //!
0074 //! For tolerances a default precision is used which
0075 //! can be changed by the packahe method
0076 //! BRepBuilderAPI::Precision.
0077 //!
0078 //! For error handling the BRepBuilderAPI commands raise only
0079 //! the NotDone error. When Done is false on a command
0080 //! the error description can be asked to the command.
0081 //!
0082 //! In theory the commands can be called with any
0083 //! arguments, argument checking is performed by the
0084 //! command.
0085 class BRepBuilderAPI
0086 {
0087 public:
0088   DEFINE_STANDARD_ALLOC
0089 
0090   //! Sets the current plane.
0091   Standard_EXPORT static void Plane(const occ::handle<Geom_Plane>& P);
0092 
0093   //! Returns the current plane.
0094   Standard_EXPORT static const occ::handle<Geom_Plane>& Plane();
0095 
0096   //! Sets the default precision. The current Precision
0097   //! is returned.
0098   Standard_EXPORT static void Precision(const double P);
0099 
0100   //! Returns the default precision.
0101   Standard_EXPORT static double Precision();
0102 };
0103 
0104 #endif // _BRepBuilderAPI_HeaderFile