All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
conformWindow.h
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_CAMERAUTIL_CONFORM_WINDOW_H
25 #define PXR_CAMERAUTIL_CONFORM_WINDOW_H
26 
27 #include "pxr/pxr.h"
28 #include "pxr/imaging/cameraUtil/api.h"
29 
30 PXR_NAMESPACE_OPEN_SCOPE
31 
32 class GfVec2d;
33 class GfVec4d;
34 class GfMatrix4d;
35 class GfRange2d;
36 class GfCamera;
37 class GfFrustum;
38 
44 enum CameraUtilConformWindowPolicy {
46  CameraUtilMatchVertically,
48  CameraUtilMatchHorizontally,
50  CameraUtilFit,
52  CameraUtilCrop,
54  CameraUtilDontConform
55 };
56 
59 CAMERAUTIL_API
61 CameraUtilConformedWindow(
62  const GfRange2d &window,
63  CameraUtilConformWindowPolicy policy, double targetAspect);
64 
68 CAMERAUTIL_API
69 GfVec4d
70 CameraUtilConformedWindow(
71  const GfVec4d &window,
72  CameraUtilConformWindowPolicy policy, double targetAspect);
73 
77 CAMERAUTIL_API
78 GfVec2d
79 CameraUtilConformedWindow(
80  const GfVec2d &window,
81  CameraUtilConformWindowPolicy policy, double targetAspect);
82 
92 CAMERAUTIL_API
94 CameraUtilConformedWindow(
95  const GfMatrix4d &projectionMatrix,
96  CameraUtilConformWindowPolicy policy, double targetAspect);
97 
100 CAMERAUTIL_API
101 void
102 CameraUtilConformWindow(
103  GfCamera *camera,
104  CameraUtilConformWindowPolicy policy, double targetAspect);
105 
108 CAMERAUTIL_API
109 void
110 CameraUtilConformWindow(
111  GfFrustum *frustum,
112  CameraUtilConformWindowPolicy policy, double targetAspect);
113 
114 
115 PXR_NAMESPACE_CLOSE_SCOPE
116 
117 #endif
Object-based representation of a camera.
Definition: camera.h:49
Basic type for a vector of 4 double components.
Definition: vec4d.h:63
Basic type for a vector of 2 double components.
Definition: vec2d.h:63
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
Basic type: 2-dimensional floating point range.
Definition: range2d.h:64
Basic type: View frustum.
Definition: frustum.h:87