src/DsgPrs/DsgPrs_DiameterPresentation.hxx

   1 // Created on: 1996-08-21
   2 // Created by: Jacques MINOT
   3 // Copyright (c) 1996-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 _DsgPrs_DiameterPresentation_HeaderFile
  18 #define _DsgPrs_DiameterPresentation_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22
  23 #include <Prs3d_Drawer.hxx>
  24 #include <DsgPrs_ArrowSide.hxx>
  25 #include <Prs3d_Presentation.hxx>
  26
  27 class TCollection_ExtendedString;
  28 class gp_Pnt;
  29 class gp_Circ;
  30
  31
  32 //! A framework for displaying diameters in shapes.
  33 class DsgPrs_DiameterPresentation
  34 {
  35 public:
  36
  37   DEFINE_STANDARD_ALLOC
  38
  39
  40   //! Draws the diameter of the circle aCircle displayed in
  41   //! the presentation aPresentation and with attributes
  42   //! defined by the attribute manager aDrawer. The point
  43   //! AttachmentPoint defines the point of contact
  44   //! between the circle and the diameter presentation.
  45   //! The value of the enumeration ArrowSide controls
  46   //! whether arrows will be displayed at either or both
  47   //! ends of the length. The text aText labels the diameter.
  48   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint, const gp_Circ& aCircle, const DsgPrs_ArrowSide ArrowSide, const Standard_Boolean IsDiamSymbol);
  49
  50   //! Draws the diameter of the arc anArc displayed in the
  51   //! presentation aPresentation and with attributes
  52   //! defined by the attribute manager aDrawer. The point
  53   //! AttachmentPoint defines the point of contact
  54   //! between the arc and the diameter presentation. The
  55   //! value of the enumeration ArrowSide controls whether
  56   //! arrows will be displayed at either or both ends of the
  57   //! length. The parameters uFirst and uLast define the
  58   //! first and last points of the arc. The text aText labels the diameter.
  59   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint, const gp_Circ& aCircle, const Standard_Real uFirst, const Standard_Real uLast, const DsgPrs_ArrowSide ArrowSide, const Standard_Boolean IsDiamSymbol);
  60
  61
  62
  63
  64 protected:
  65
  66
  67
  68
  69
  70 private:
  71
  72
  73
  74
  75
  76 };
  77
  78
  79
  80
  81
  82
  83
  84 #endif // _DsgPrs_DiameterPresentation_HeaderFile