HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
conformWindow.h
Go to the documentation of this file.
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_CAMERA_UTIL_CONFORM_WINDOW_H
25 #define PXR_IMAGING_CAMERA_UTIL_CONFORM_WINDOW_H
26 
27 #include "pxr/pxr.h"
29 
31 
32 class GfVec2d;
33 class GfVec4d;
34 class GfMatrix4d;
35 class GfRange2d;
36 class GfCamera;
37 class GfFrustum;
38 
39 /// \enum CameraUtilConformWindowPolicy
40 ///
41 /// Policy of how to conform a window to the given aspect ratio.
42 /// An ASCII-art explanation is given in the corresponding .cpp file.
43 ///
45  /// Modify width
47  /// Modify height
49  /// Increase width or height
51  /// Decrease width or height
53  /// Leave unchanged (This can result in stretching/shrinking if not pre-fit)
55 };
56 
57 /// Returns a window with aspect ratio \p targetAspect by applying
58 /// \p policy to \p window where \p window is encoded as GfRange2d.
62  const GfRange2d &window,
63  CameraUtilConformWindowPolicy policy, double targetAspect);
64 
65 /// Returns a window with aspect ratio \p targetAspect by applying
66 /// \p policy to \p window where \p window is encoded as vector
67 /// (left, right, bottom, top) similarly to RenderMan's RiScreenWindow.
69 GfVec4d
71  const GfVec4d &window,
72  CameraUtilConformWindowPolicy policy, double targetAspect);
73 
74 /// Returns a window with aspect ratio \p targetAspect by applying
75 /// \p policy to \p window where \p window is encoded as vector
76 /// (width, height).
78 GfVec2d
80  const GfVec2d &window,
81  CameraUtilConformWindowPolicy policy, double targetAspect);
82 
83 /// Conforms the given \p projectionMatrix to have aspect ratio \p targetAspect
84 /// by applying \p policy.
85 ///
86 /// Note that this function also supports mirroring about the x- or y-axis of
87 /// the image corresponding to flipping all signs in the second, respectively,
88 /// third column of the projection matrix. In other words, we get the same
89 /// result whether we flip the signs in the matrix and then give it to this
90 /// function or call this function first and flip the signs of the resulting
91 /// matrix.
95  const GfMatrix4d &projectionMatrix,
96  CameraUtilConformWindowPolicy policy, double targetAspect);
97 
98 /// Conforms the given \p camera to have aspect ratio \p targetAspect
99 /// by applying \p policy.
101 void
103  GfCamera *camera,
104  CameraUtilConformWindowPolicy policy, double targetAspect);
105 
106 /// Conforms the given \p frustum to have aspect ratio \p targetAspect
107 /// by applying \p policy.
109 void
111  GfFrustum *frustum,
112  CameraUtilConformWindowPolicy policy, double targetAspect);
113 
114 
116 
117 #endif
hboost::math::policies::policy< hboost::math::policies::domain_error< hboost::math::policies::ignore_error >, hboost::math::policies::pole_error< hboost::math::policies::ignore_error >, hboost::math::policies::overflow_error< hboost::math::policies::ignore_error >, hboost::math::policies::underflow_error< hboost::math::policies::ignore_error >, hboost::math::policies::denorm_error< hboost::math::policies::ignore_error >, hboost::math::policies::rounding_error< hboost::math::policies::ignore_error >, hboost::math::policies::evaluation_error< hboost::math::policies::ignore_error >, hboost::math::policies::indeterminate_result_error< hboost::math::policies::ignore_error > > policy
Definition: SYS_MathCbrt.h:35
Object-based representation of a camera.
Definition: camera.h:49
CAMERAUTIL_API void CameraUtilConformWindow(GfCamera *camera, CameraUtilConformWindowPolicy policy, double targetAspect)
Definition: vec4d.h:63
Definition: vec2d.h:63
Decrease width or height.
Definition: conformWindow.h:52
CameraUtilConformWindowPolicy
Definition: conformWindow.h:44
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Leave unchanged (This can result in stretching/shrinking if not pre-fit)
Definition: conformWindow.h:54
#define CAMERAUTIL_API
Definition: api.h:40
CAMERAUTIL_API GfRange2d CameraUtilConformedWindow(const GfRange2d &window, CameraUtilConformWindowPolicy policy, double targetAspect)
Increase width or height.
Definition: conformWindow.h:50