0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / V3d / V3d_PositionLight.hxx
1 // Created on: 1997-11-21
2 // Created by: ZOV
3 // Copyright (c) 1997-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 _V3d_PositionLight_HeaderFile
18 #define _V3d_PositionLight_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Graphic3d_Vertex.hxx>
24 #include <V3d_TypeOfRepresentation.hxx>
25 #include <V3d_Light.hxx>
26 #include <V3d_Coordinate.hxx>
27 #include <Quantity_Parameter.hxx>
28 #include <V3d_TypeOfPickLight.hxx>
29 #include <Standard_Integer.hxx>
30 #include <Standard_Boolean.hxx>
31 class V3d_BadValue;
32 class V3d_Viewer;
33 class V3d_View;
34 class Graphic3d_Group;
35
36
37 class V3d_PositionLight;
38 DEFINE_STANDARD_HANDLE(V3d_PositionLight, V3d_Light)
39
40 //! Base class for Positional, Spot and Directional Light classes
41 class V3d_PositionLight : public V3d_Light
42 {
43
44 public:
45
46   
47   //! Defines the position of the light source. Should be redefined!
48   Standard_EXPORT virtual void SetPosition (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z) = 0;
49   
50   //! Defines the target of the light (the center
51   //! of the sphere)
52   Standard_EXPORT void SetTarget (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z);
53   
54   //! Define the radius.
55   Standard_EXPORT void SetRadius (const Quantity_Parameter Radius);
56   
57   //! Calculate the position of the light, on the hide face
58   //! of the picking sphere.
59   Standard_EXPORT void OnHideFace (const Handle(V3d_View)& aView);
60   
61   //! Calculate the position of the light, on the seen face
62   //! of the picking sphere.
63   Standard_EXPORT void OnSeeFace (const Handle(V3d_View)& aView);
64   
65   //! Tracking the light position, or the light space,
66   //! or the radius of the light space, that depends of
67   //! initial picking "WhatPick" (see the pick method).
68   //! If WhatPick is SPACELIGHT, then the parameters
69   //! Xpix, Ypix are the coordinates of a translation vector.
70   Standard_EXPORT void Tracking (const Handle(V3d_View)& aView, const V3d_TypeOfPickLight WathPick, const Standard_Integer Xpix, const Standard_Integer Ypix);
71   
72   //! Display the graphic structure of light source
73   //! in the choosen view. We have three type of representation
74   //! - SIMPLE   : Only the light source is displayed.
75   //! - PARTIAL  : The light source and the light space are
76   //! displayed.
77   //! - COMPLETE : The light source, the light space and the
78   //! radius of light space are displayed.
79   //! We can choose the "SAMELAST" as parameter of representation
80   //! In this case the graphic structure representation will be
81   //! the last displayed.
82   Standard_EXPORT virtual void Display (const Handle(V3d_View)& aView, const V3d_TypeOfRepresentation Representation = V3d_SIMPLE);
83   
84   //! Erase the graphic structure of light source.
85   Standard_EXPORT void Erase();
86   
87   //! Returns the radius of the picking sphere.
88   Standard_EXPORT Quantity_Parameter Radius() const;
89   
90   //! Returns the visibility status
91   //! If True the source is visible.
92   //! If False it's hidden.
93   Standard_EXPORT Standard_Boolean SeeOrHide (const Handle(V3d_View)& aView) const;
94   
95   //! Returns the position of the light source.
96   Standard_EXPORT virtual void Position (V3d_Coordinate& X, V3d_Coordinate& Y, V3d_Coordinate& Z) const = 0;
97   
98   //! Returns the position of the target of the light source.
99   Standard_EXPORT void Target (V3d_Coordinate& X, V3d_Coordinate& Y, V3d_Coordinate& Z) const;
100
101
102
103
104   DEFINE_STANDARD_RTTI(V3d_PositionLight,V3d_Light)
105
106 protected:
107
108   
109   Standard_EXPORT V3d_PositionLight(const Handle(V3d_Viewer)& VM);
110
111   Graphic3d_Vertex MyTarget;
112   V3d_TypeOfRepresentation MyTypeOfRepresentation;
113
114
115 private:
116
117   
118   //! Defines representation of the light source.
119   Standard_EXPORT virtual void Symbol (const Handle(Graphic3d_Group)& gsymbol, const Handle(V3d_View)& aView) const = 0;
120
121
122
123 };
124
125
126
127
128
129
130
131 #endif // _V3d_PositionLight_HeaderFile