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
0032 //! A framework for displaying diameters in shapes.
0033 class DsgPrs_DiameterPresentation
0034 {
0035 public:
0036
0037   DEFINE_STANDARD_ALLOC
0038
0039
0040   //! Draws the diameter of the circle aCircle displayed in
0041   //! the presentation aPresentation and with attributes
0042   //! defined by the attribute manager aDrawer. The point
0043   //! AttachmentPoint defines the point of contact
0044   //! between the circle and the diameter presentation.
0045   //! The value of the enumeration ArrowSide controls
0046   //! whether arrows will be displayed at either or both
0047   //! ends of the length. The text aText labels the diameter.
0048   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);
0049
0050   //! Draws the diameter of the arc anArc displayed in the
0051   //! presentation aPresentation and with attributes
0052   //! defined by the attribute manager aDrawer. The point
0053   //! AttachmentPoint defines the point of contact
0054   //! between the arc and the diameter presentation. The
0055   //! value of the enumeration ArrowSide controls whether
0056   //! arrows will be displayed at either or both ends of the
0057   //! length. The parameters uFirst and uLast define the
0058   //! first and last points of the arc. The text aText labels the diameter.
0059   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);
0060
0061
0062
0063
0064 protected:
0065
0066
0067
0068
0069
0070 private:
0071
0072
0073
0074
0075
0076 };
0077
0078
0079
0080
0081
0082
0083
0084 #endif // _DsgPrs_DiameterPresentation_HeaderFile