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