1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 //    names, trademarks, service marks, or product names of the Licensor
11 //    and its affiliates, except as required to comply with Section 4(c) of
12 //    the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 //     http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_IMAGING_HD_ST_UNIT_TEST_GLDRAWING_H
25 #define PXR_IMAGING_HD_ST_UNIT_TEST_GLDRAWING_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/hdSt/api.h"
29 #include "pxr/base/gf/frustum.h"
30 #include "pxr/base/gf/matrix4d.h"
31 #include "pxr/base/gf/vec3f.h"
32 
33 #include <string>
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 
38 class HdSt_UnitTestWindow;
39 
40 /// \class HdSt_UnitTestGLDrawing
41 ///
42 /// A helper class for unit tests which need to perform GL drawing.
43 ///
44 class HdSt_UnitTestGLDrawing {
45 public:
46     HDST_API
47     HdSt_UnitTestGLDrawing();
48     HDST_API
49     virtual ~HdSt_UnitTestGLDrawing();
50 
51     HDST_API
52     int GetWidth() const;
53     HDST_API
54     int GetHeight() const;
55     HDST_API
56     void RunTest(int argc, char *argv[]);
57     HDST_API
58     void RunOffscreenTest();
59 
60     virtual void InitTest() = 0;
61     HDST_API virtual void UninitTest();
62     virtual void DrawTest() = 0;        // interactive mode
63     virtual void OffscreenTest() = 0;   // offscreen mode (automated test)
64 
65     HDST_API
66     virtual void MousePress(int button, int x, int y, int modKeys);
67     HDST_API
68     virtual void MouseRelease(int button, int x, int y, int modKeys);
69     HDST_API
70     virtual void MouseMove(int x, int y, int modKeys);
71     HDST_API
72     virtual void KeyRelease(int key);
73 
74     HDST_API
75     virtual void Idle();
76 
77     HDST_API
78     bool WriteToFile(std::string const & attachment,
79                      std::string const & filename) const;
80 
81 protected:
82     HDST_API
83     virtual void ParseArgs(int argc, char *argv[]);
84 
SetCameraRotate(float rx,float ry)85     void SetCameraRotate(float rx, float ry) {
86         _rotate[0] = rx; _rotate[1] = ry;
87     }
SetCameraTranslate(GfVec3f t)88     void SetCameraTranslate(GfVec3f t) {
89         _translate = t;
90     }
GetCameraTranslate()91     GfVec3f GetCameraTranslate() const {
92         return _translate;
93     }
94     HDST_API
95     GfMatrix4d GetViewMatrix() const;
96     HDST_API
97     GfMatrix4d GetProjectionMatrix() const;
98     HDST_API
99     GfFrustum GetFrustum() const;
100 
GetMousePos()101     GfVec2i GetMousePos() const { return GfVec2i(_mousePos[0], _mousePos[1]); }
102 
103 private:
104     HdSt_UnitTestWindow *_widget;
105     float _rotate[2];
106     GfVec3f _translate;
107 
108     int _mousePos[2];
109     bool _mouseButton[3];
110 };
111 
112 
113 PXR_NAMESPACE_CLOSE_SCOPE
114 
115 #endif // PXR_IMAGING_HD_ST_UNIT_TEST_GLDRAWING_H
116