include/opencascade/DrawDim.hxx

0001 // Created on: 1996-01-09
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 1996-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 _DrawDim_HeaderFile
0018 #define _DrawDim_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Draw_Interpretor.hxx>
0025 #include <Standard_Boolean.hxx>
0026 #include <Standard_Real.hxx>
0027 class TopoDS_Shape;
0028 class gp_Pnt;
0029 class TopoDS_Edge;
0030 class gp_Lin;
0031 class gp_Circ;
0032 class TopoDS_Face;
0033 class gp_Pln;
0034
0035 //! This package provides Drawable Dimensions.
0036 //!
0037 //! The classes PlanarDimension and subclasses provide
0038 //! services to build drawable dimensions between
0039 //! point line and circle in a given 3d plane.
0040 //!
0041 //! The classes Dimension and subclasses provide
0042 //! services to build drawable dimensions between
0043 //! plane and cylindrical surfaces.
0044 class DrawDim
0045 {
0046 public:
0047   DEFINE_STANDARD_ALLOC
0048
0049   //! Commands
0050   //! ========
0051   Standard_EXPORT static void DrawShapeName(const TopoDS_Shape& ashape, const char* const aname);
0052
0053   Standard_EXPORT static void AllCommands(Draw_Interpretor& I);
0054
0055   //! tools
0056   //! =====
0057   Standard_EXPORT static void PlanarDimensionCommands(Draw_Interpretor& I);
0058
0059   Standard_EXPORT static gp_Pnt Nearest(const TopoDS_Shape& aShape, const gp_Pnt& apoint);
0060
0061   //! false if <e> is not a linear edge
0062   Standard_EXPORT static bool Lin(const TopoDS_Edge& e,
0063                                   gp_Lin&            l,
0064                                   bool&              infinite,
0065                                   double&            first,
0066                                   double&            last);
0067
0068   //! false if <e> is not a circular edge
0069   Standard_EXPORT static bool Circ(const TopoDS_Edge& e, gp_Circ& l, double& first, double& last);
0070
0071   //! false if <f> is not a planar face
0072   Standard_EXPORT static bool Pln(const TopoDS_Face& f, gp_Pln& p);
0073 };
0074
0075 #endif // _DrawDim_HeaderFile