HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
screenWindowParameters.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_SCREEN_WINDOW_PARAMETERS_H
25 #define PXR_IMAGING_CAMERA_UTIL_SCREEN_WINDOW_PARAMETERS_H
26 
27 #include "pxr/pxr.h"
29 #include "pxr/base/gf/camera.h"
30 
32 
33 
34 /// \class CameraUtilScreenWindowParameters
35 ///
36 /// Given a camera object, compute parameters suitable for setting up
37 /// RenderMan.
38 ///
40 {
41 public:
42  /// Constructs screenwindow parameter. The optional \p fitDirection
43  /// indicates in which direction the screenwindow will have length 2.
46  GfCamera::FOVDirection fitDirection =
48 
49  /// The vector (left, right, bottom, top) defining the rectangle in the
50  /// image plane.
51  /// Give these parameters to RiScreenWindow.
52  const GfVec4d & GetScreenWindow() const { return _screenWindow; }
53 
54  /// The field of view. More precisely, the full angle perspective field
55  /// of view (in degrees) between screen space coordinates (-1,0) and
56  /// (1,0).
57  /// Give these parameters to RiProjection as parameter after
58  /// "perspective".
59  double GetFieldOfView() const { return _fieldOfView; }
60 
61  /// Returns the inverse of the transform for a camera that is y-Up
62  /// and z-facing (vs the OpenGL camera that is (-z)-facing).
63  /// Write this transform with RiConcatTransform before
64  /// RiWorldBegin.
65  const GfMatrix4d & GetZFacingViewMatrix() const {
66  return _zFacingViewMatrix;
67  }
68 
69 private:
70  GfVec4d _screenWindow;
71  double _fieldOfView;
72  GfMatrix4d _zFacingViewMatrix;
73 };
74 
75 
77 
78 #endif // PXR_IMAGING_CAMERA_UTIL_SCREEN_WINDOW_PARAMETERS_H
CAMERAUTIL_API CameraUtilScreenWindowParameters(const GfCamera &camera, GfCamera::FOVDirection fitDirection=GfCamera::FOVHorizontal)
FOVDirection
Direction used for Field of View or orthographic size.
Definition: camera.h:59
Object-based representation of a camera.
Definition: camera.h:49
const GfVec4d & GetScreenWindow() const
Definition: vec4d.h:62
const GfMatrix4d & GetZFacingViewMatrix() const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
#define CAMERAUTIL_API
Definition: api.h:40