include/opencascade/DsgPrs_DiameterPresentation.hxx

0001 // Created on: 1996-08-21
0002 // Created by: Jacques MINOT
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 _DsgPrs_DiameterPresentation_HeaderFile
0018 #define _DsgPrs_DiameterPresentation_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022
0023 #include <Prs3d_Drawer.hxx>
0024 #include <DsgPrs_ArrowSide.hxx>
0025 #include <Prs3d_Presentation.hxx>
0026
0027 class TCollection_ExtendedString;
0028 class gp_Pnt;
0029 class gp_Circ;
0030
0031 //! A framework for displaying diameters in shapes.
0032 class DsgPrs_DiameterPresentation
0033 {
0034 public:
0035   DEFINE_STANDARD_ALLOC
0036
0037   //! Draws the diameter of the circle aCircle displayed in
0038   //! the presentation aPresentation and with attributes
0039   //! defined by the attribute manager aDrawer. The point
0040   //! AttachmentPoint defines the point of contact
0041   //! between the circle and the diameter presentation.
0042   //! The value of the enumeration ArrowSide controls
0043   //! whether arrows will be displayed at either or both
0044   //! ends of the length. The text aText labels the diameter.
0045   Standard_EXPORT static void Add(const occ::handle<Prs3d_Presentation>& aPresentation,
0046                                   const occ::handle<Prs3d_Drawer>&       aDrawer,
0047                                   const TCollection_ExtendedString&      aText,
0048                                   const gp_Pnt&                          AttachmentPoint,
0049                                   const gp_Circ&                         aCircle,
0050                                   const DsgPrs_ArrowSide                 ArrowSide,
0051                                   const bool                             IsDiamSymbol);
0052
0053   //! Draws the diameter of the arc anArc displayed in the
0054   //! presentation aPresentation and with attributes
0055   //! defined by the attribute manager aDrawer. The point
0056   //! AttachmentPoint defines the point of contact
0057   //! between the arc and the diameter presentation. The
0058   //! value of the enumeration ArrowSide controls whether
0059   //! arrows will be displayed at either or both ends of the
0060   //! length. The parameters uFirst and uLast define the
0061   //! first and last points of the arc. The text aText labels the diameter.
0062   Standard_EXPORT static void Add(const occ::handle<Prs3d_Presentation>& aPresentation,
0063                                   const occ::handle<Prs3d_Drawer>&       aDrawer,
0064                                   const TCollection_ExtendedString&      aText,
0065                                   const gp_Pnt&                          AttachmentPoint,
0066                                   const gp_Circ&                         aCircle,
0067                                   const double                           uFirst,
0068                                   const double                           uLast,
0069                                   const DsgPrs_ArrowSide                 ArrowSide,
0070                                   const bool                             IsDiamSymbol);
0071 };
0072
0073 #endif // _DsgPrs_DiameterPresentation_HeaderFile