include/opencascade/DsgPrs_DatumPrs.hxx

0001 // Copyright (c) 2013-2014 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef DsgPrs_DatumPrs_HeaderFile
0015 #define DsgPrs_DatumPrs_HeaderFile
0016
0017 #include <Prs3d_Drawer.hxx>
0018 #include <Prs3d_Presentation.hxx>
0019 #include <Prs3d_Root.hxx>
0020
0021 //! A framework for displaying an XYZ trihedron.
0022 class DsgPrs_DatumPrs : public Prs3d_Root
0023 {
0024 public:
0025   DEFINE_STANDARD_ALLOC
0026
0027   //! Draw XYZ axes at specified location with attributes defined by the attribute manager
0028   //! theDrawer:
0029   //! - Prs3d_DatumAspect defines arrow, line and length trihedron axis parameters,
0030   //! - Prs3d_TextAspect defines displayed text.
0031   //! The thihedron origin and axis directions are defined by theDatum coordinate system.
0032   //! DsgPrs_XYZAxisPresentation framework is used to create graphical primitives for each axis.
0033   //! Axes are marked with "X", "Y", "Z" text.
0034   //! @param[out] thePresentation  the modified presentation
0035   //! @param[in] theDatum  the source of trihedron position
0036   //! @param[in] theDrawer  the provider of display attributes
0037   Standard_EXPORT static void Add(const Handle(Prs3d_Presentation)& thePresentation,
0038                                   const gp_Ax2&                     theDatum,
0039                                   const Handle(Prs3d_Drawer)&       theDrawer);
0040 };
0041 #endif