include/opencascade/DsgPrs_RadiusPresentation.hxx

0001 // Created on: 1995-03-01
0002 // Created by: Arnaud BOUZY
0003 // Copyright (c) 1995-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_RadiusPresentation_HeaderFile
0018 #define _DsgPrs_RadiusPresentation_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 to define display of radii.
0032 class DsgPrs_RadiusPresentation
0033 {
0034 public:
0035   DEFINE_STANDARD_ALLOC
0036
0037   //! Adds the point AttachmentPoint, the circle aCircle,
0038   //! the text aText, and the parameters firstparam and
0039   //! lastparam to the presentation object aPresentation.
0040   //! The display attributes of these elements is defined by
0041   //! the attribute manager aDrawer.
0042   //! If the Boolean drawFromCenter is false, the
0043   //! arrowhead will point towards the center of aCircle.
0044   //! If the Boolean reverseArrow is true, the arrowhead
0045   //! will point away from the attachment point.
0046   Standard_EXPORT static void Add(const occ::handle<Prs3d_Presentation>& aPresentation,
0047                                   const occ::handle<Prs3d_Drawer>&       aDrawer,
0048                                   const TCollection_ExtendedString&      aText,
0049                                   const gp_Pnt&                          AttachmentPoint,
0050                                   const gp_Circ&                         aCircle,
0051                                   const double                           firstparam,
0052                                   const double                           lastparam,
0053                                   const bool                             drawFromCenter = true,
0054                                   const bool                             reverseArrow   = false);
0055
0056   //! Adds the point AttachmentPoint, the circle aCircle,
0057   //! the text aText, and the parameters firstparam and
0058   //! lastparam to the presentation object aPresentation.
0059   //! The display attributes of these elements is defined by
0060   //! the attribute manager aDrawer.
0061   //! The value of the enumeration Arrowside determines
0062   //! the type of arrow displayed: whether there will be
0063   //! arrowheads at both ends or only one, for example.
0064   //! If the Boolean drawFromCenter is false, the
0065   //! arrowhead will point towards the center of aCircle.
0066   //! If the Boolean reverseArrow is true, the arrowhead
0067   //! will point away from the attachment point.
0068   Standard_EXPORT static void Add(const occ::handle<Prs3d_Presentation>& aPresentation,
0069                                   const occ::handle<Prs3d_Drawer>&       aDrawer,
0070                                   const TCollection_ExtendedString&      aText,
0071                                   const gp_Pnt&                          AttachmentPoint,
0072                                   const gp_Circ&                         aCircle,
0073                                   const double                           firstparam,
0074                                   const double                           lastparam,
0075                                   const DsgPrs_ArrowSide                 ArrowSide,
0076                                   const bool                             drawFromCenter = true,
0077                                   const bool                             reverseArrow   = false);
0078
0079   //! Adds the circle aCircle, the text aText, the points
0080   //! AttachmentPoint, Center and EndOfArrow to the
0081   //! presentation object aPresentation.
0082   //! The display attributes of these elements is defined by
0083   //! the attribute manager aDrawer.
0084   //! The value of the enumeration Arrowside determines
0085   //! the type of arrow displayed: whether there will be
0086   //! arrowheads at both ends or only one, for example.
0087   //! If the Boolean drawFromCenter is false, the
0088   //! arrowhead will point towards the center of aCircle.
0089   //! If the Boolean reverseArrow is true, the arrowhead
0090   //! will point away from the attachment point.
0091   Standard_EXPORT static void Add(const occ::handle<Prs3d_Presentation>& aPresentation,
0092                                   const occ::handle<Prs3d_Drawer>&       aDrawer,
0093                                   const TCollection_ExtendedString&      aText,
0094                                   const gp_Pnt&                          AttachmentPoint,
0095                                   const gp_Pnt&                          Center,
0096                                   const gp_Pnt&                          EndOfArrow,
0097                                   const DsgPrs_ArrowSide                 ArrowSide,
0098                                   const bool                             drawFromCenter = true,
0099                                   const bool                             reverseArrow   = false);
0100 };
0101
0102 #endif // _DsgPrs_RadiusPresentation_HeaderFile