src/DsgPrs/DsgPrs_DatumPrs.hxx

   1 // Copyright (c) 2013-2014 OPEN CASCADE SAS
   2 //
   3 // This file is part of Open CASCADE Technology software library.
   4 //
   5 // This library is free software; you can redistribute it and/or modify it under
   6 // the terms of the GNU Lesser General Public License version 2.1 as published
   7 // by the Free Software Foundation, with special exception defined in the file
   8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
   9 // distribution for complete text of the license and disclaimer of any warranty.
  10 //
  11 // Alternatively, this file may be used under the terms of Open CASCADE
  12 // commercial license or contractual agreement.
  13
  14 #ifndef _DsgPrs_DatumPrs_H__
  15 #define _DsgPrs_DatumPrs_H__
  16
  17 #include <gp_Ax2.hxx>
  18 #include <Prs3d_Drawer.hxx>
  19 #include <Prs3d_Presentation.hxx>
  20 #include <Prs3d_Root.hxx>
  21
  22 //! A framework for displaying an XYZ trihedron.
  23 class DsgPrs_DatumPrs : public Prs3d_Root
  24 {
  25 public:
  26
  27   DEFINE_STANDARD_ALLOC
  28
  29   //! Draw XYZ axes at specified location with attributes defined by the attribute manager theDrawer:
  30   //! - Prs3d_DatumAspect defines arrow, line and lenght trihedron axis parameters,
  31   //! - Prs3d_TextAspect defines displayed text.
  32   //! The thihedron origin and axis directions are defined by theDatum coordinate system.
  33   //! DsgPrs_XYZAxisPresentation framework is used to create graphical primitives for each axis.
  34   //! Axes are marked with "X", "Y", "Z" text.
  35   //! @param thePresentation [out] the modified presentation
  36   //! @param theDatum [in] the source of trihedron position
  37   //! @param theDrawer [in] the provider of display attributes
  38   Standard_EXPORT static void Add (const Handle(Prs3d_Presentation)& thePresentation, const gp_Ax2& theDatum,
  39                                    const Handle(Prs3d_Drawer)& theDrawer);
  40
  41 };
  42 #endif