include/opencascade/DsgPrs_XYZAxisPresentation.hxx

0001 // Created on: 1997-02-10
0002 // Created by: Odile Olivier
0003 // Copyright (c) 1997-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_XYZAxisPresentation_HeaderFile
0018 #define _DsgPrs_XYZAxisPresentation_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Prs3d_Presentation.hxx>
0025
0026 class Prs3d_LineAspect;
0027 class gp_Dir;
0028 class gp_Pnt;
0029 class Prs3d_ArrowAspect;
0030 class Prs3d_TextAspect;
0031
0032 //! A framework for displaying the axes of an XYZ trihedron.
0033 class DsgPrs_XYZAxisPresentation
0034 {
0035 public:
0036   DEFINE_STANDARD_ALLOC
0037
0038   //! Draws each axis of a trihedron displayed in the
0039   //! presentation aPresentation and with lines shown by
0040   //! the values of aLineAspect. Each axis is defined by:
0041   //! -   the first and last points aPfirst and aPlast
0042   //! -   the direction aDir and
0043   //! -   the value aVal which provides a value for length.
0044   //! The value for length is provided so that the trihedron
0045   //! can vary in length relative to the scale of shape display.
0046   //! Each axis will be identified as X, Y, or Z by the text aText.
0047   Standard_EXPORT static void Add(const occ::handle<Prs3d_Presentation>& aPresentation,
0048                                   const occ::handle<Prs3d_LineAspect>&   anLineAspect,
0049                                   const gp_Dir&                          aDir,
0050                                   const double                           aVal,
0051                                   const char* const                      aText,
0052                                   const gp_Pnt&                          aPfirst,
0053                                   const gp_Pnt&                          aPlast);
0054
0055   //! draws the presentation X ,Y ,Z axis
0056   Standard_EXPORT static void Add(const occ::handle<Prs3d_Presentation>& aPresentation,
0057                                   const occ::handle<Prs3d_LineAspect>&   aLineAspect,
0058                                   const occ::handle<Prs3d_ArrowAspect>&  anArrowAspect,
0059                                   const occ::handle<Prs3d_TextAspect>&   aTextAspect,
0060                                   const gp_Dir&                          aDir,
0061                                   const double                           aVal,
0062                                   const char* const                      aText,
0063                                   const gp_Pnt&                          aPfirst,
0064                                   const gp_Pnt&                          aPlast);
0065 };
0066
0067 #endif // _DsgPrs_XYZAxisPresentation_HeaderFile