0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / Prs3d / Prs3d_Projector.hxx
1 // Created on: 1993-03-19
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_Projector_HeaderFile
18 #define _Prs3d_Projector_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <HLRAlgo_Projector.hxx>
24 #include <Standard_Transient.hxx>
25 #include <Standard_Boolean.hxx>
26
27 class Prs3d_Projector;
28 DEFINE_STANDARD_HANDLE(Prs3d_Projector, Standard_Transient)
29
30 //! A projector object.
31 //! This object defines the parameters of a view for a
32 //! visualization algorithm. It is, for example, used by the
33 //! hidden line removal algorithms.
34 class Prs3d_Projector : public Standard_Transient
35 {
36
37 public:
38
39   
40   Standard_EXPORT Prs3d_Projector(const HLRAlgo_Projector& Pr);
41   
42   //! Constructs a projector framework from the following parameters
43   //! -   Pers is true if the view is a perspective view and
44   //! false if it is an axonometric one;
45   //! -   Focus is the focal length if a perspective view is defined;
46   //! -   DX, DY and DZ are the coordinates of the
47   //! projection vector;
48   //! -   XAt, YAt and ZAt are the coordinates of the view point;
49   //! -   XUp, YUp and ZUp are the coordinates of the
50   //! vertical direction vector.
51   Standard_EXPORT Prs3d_Projector(const Standard_Boolean Pers, const Standard_Real Focus, const Standard_Real DX, const Standard_Real DY, const Standard_Real DZ, const Standard_Real XAt, const Standard_Real YAt, const Standard_Real ZAt, const Standard_Real XUp, const Standard_Real YUp, const Standard_Real ZUp);
52   
53   //! Returns a projector object for use in a hidden line removal algorithm.
54   Standard_EXPORT HLRAlgo_Projector Projector() const;
55
56   DEFINE_STANDARD_RTTIEXT(Prs3d_Projector,Standard_Transient)
57
58 private:
59
60   HLRAlgo_Projector MyProjector;
61
62 };
63
64 #endif // _Prs3d_Projector_HeaderFile