include/opencascade/DsgPrs_ParalPresentation.hxx

0001 // Created on: 1995-11-28
0002 // Created by: Jean-Pierre COMBE
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_ParalPresentation_HeaderFile
0018 #define _DsgPrs_ParalPresentation_HeaderFile
0019
0020 #include <Prs3d_Drawer.hxx>
0021 #include <DsgPrs_ArrowSide.hxx>
0022 #include <Prs3d_Presentation.hxx>
0023
0024 class TCollection_ExtendedString;
0025 class gp_Pnt;
0026 class gp_Dir;
0027
0028 //! A framework to define display of relations of parallelism between shapes.
0029 class DsgPrs_ParalPresentation
0030 {
0031 public:
0032   DEFINE_STANDARD_ALLOC
0033
0034   //! Defines the display of elements showing relations of
0035   //! parallelism between shapes.
0036   //! These include the two points of attachment
0037   //! AttachmentPoint1 and AttachmentPoint1, the
0038   //! direction aDirection, and the offset point OffsetPoint.
0039   //! These arguments are added to the presentation
0040   //! object aPresentation. Their display attributes are
0041   //! defined by the attribute manager aDrawer.
0042   Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
0043                                   const Handle(Prs3d_Drawer)&       aDrawer,
0044                                   const TCollection_ExtendedString& aText,
0045                                   const gp_Pnt&                     AttachmentPoint1,
0046                                   const gp_Pnt&                     AttachmentPoint2,
0047                                   const gp_Dir&                     aDirection,
0048                                   const gp_Pnt&                     OffsetPoint);
0049
0050   //! Defines the display of elements showing relations of
0051   //! parallelism between shapes.
0052   //! These include the two points of attachment
0053   //! AttachmentPoint1 and AttachmentPoint1, the
0054   //! direction aDirection, the offset point OffsetPoint and
0055   //! the text aText.
0056   //! These arguments are added to the presentation
0057   //! object aPresentation. Their display attributes are
0058   //! defined by the attribute manager aDrawer.
0059   Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& aPresentation,
0060                                   const Handle(Prs3d_Drawer)&       aDrawer,
0061                                   const TCollection_ExtendedString& aText,
0062                                   const gp_Pnt&                     AttachmentPoint1,
0063                                   const gp_Pnt&                     AttachmentPoint2,
0064                                   const gp_Dir&                     aDirection,
0065                                   const gp_Pnt&                     OffsetPoint,
0066                                   const DsgPrs_ArrowSide            ArrowSide);
0067
0068 protected:
0069 private:
0070 };
0071
0072 #endif // _DsgPrs_ParalPresentation_HeaderFile