6e813620c88a5dee6f0e27e22534b31c59e40b8a
[occt.git] / src / Prs3d / Prs3d_Arrow.hxx
1 // Created on: 1993-04-15
2 // Created by: Jean-Louis Frenkel
3 // Copyright (c) 1993-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _Prs3d_Arrow_HeaderFile
18 #define _Prs3d_Arrow_HeaderFile
19
20 #include <Prs3d_Root.hxx>
21 #include <Quantity_PlaneAngle.hxx>
22 #include <Quantity_Length.hxx>
23
24 class gp_Pnt;
25 class gp_Dir;
26
27 //! Provides class methods to draw an arrow at a given location, along a given direction and using a given angle.
28 class Prs3d_Arrow : public Prs3d_Root
29 {
30 public:
31
32   DEFINE_STANDARD_ALLOC
33
34   //! Defines the representation of the arrow.
35   //! Note that this method does NOT assign any presentation aspects to the primitives group!
36   //! @param theGroup     presentation group to add primitives
37   //! @param theLocation  location of the arrow tip
38   //! @param theDirection direction of the arrow
39   //! @param theAngle     angle of opening of the arrow head
40   //! @param theLength    length of the arrow (from the tip)
41   Standard_EXPORT static void Draw (const Handle(Graphic3d_Group)& theGroup,
42                                     const gp_Pnt& theLocation,
43                                     const gp_Dir& theDirection,
44                                     const Quantity_PlaneAngle theAngle,
45                                     const Quantity_Length theLength);
46
47   //! Alias to another method Draw() for backward compatibility.
48   Standard_DEPRECATED("Prs3d_Arrow::Draw() taking Graphic3d_Group should be used instead")
49   static void Draw (const Handle(Prs3d_Presentation)& thePrs,
50                     const gp_Pnt& theLocation,
51                     const gp_Dir& theDirection,
52                     const Quantity_PlaneAngle theAngle,
53                     const Quantity_Length theLength)
54   {
55     Draw (Prs3d_Root::CurrentGroup (thePrs), theLocation, theDirection, theAngle, theLength);
56   }
57
58 };
59
60 #endif // _Prs3d_Arrow_HeaderFile