Loading...
Searching...
No Matches
framing.h
1//
2// Copyright 2020 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_FRAMING_H
25#define PXR_IMAGING_CAMERA_UTIL_FRAMING_H
26
27#include "pxr/pxr.h"
28#include "pxr/imaging/cameraUtil/api.h"
29
30#include "pxr/imaging/cameraUtil/conformWindow.h"
31
32#include "pxr/base/gf/rect2i.h"
33#include "pxr/base/gf/range2f.h"
34
35PXR_NAMESPACE_OPEN_SCOPE
36
80{
81public:
84 CAMERAUTIL_API
86
90 CAMERAUTIL_API
93 const GfRect2i &dataWindow,
94 float pixelAspectRatio = 1.0);
95
99 CAMERAUTIL_API
101 const GfRect2i &dataWindow);
102
104 CAMERAUTIL_API
105 bool IsValid() const;
106
107 CAMERAUTIL_API
108 bool operator==(const CameraUtilFraming& other) const;
109
110 CAMERAUTIL_API
111 bool operator!=(const CameraUtilFraming& other) const;
112
129 CAMERAUTIL_API
131 float cameraAspectRatio,
132 CameraUtilConformWindowPolicy windowPolicy) const;
133
139 CAMERAUTIL_API
141 const GfMatrix4d &projectionMatrix,
142 CameraUtilConformWindowPolicy windowPolicy) const;
143
146
150
154};
155
156PXR_NAMESPACE_CLOSE_SCOPE
157
158#endif
Framing information.
Definition: framing.h:80
CAMERAUTIL_API GfRange2f ComputeFilmbackWindow(float cameraAspectRatio, CameraUtilConformWindowPolicy windowPolicy) const
The filmback window is the rectangle in pixel space corresponding to the filmback plane.
CAMERAUTIL_API CameraUtilFraming()
Creates an invalid framing, i.e., with empty display and data window.
CAMERAUTIL_API CameraUtilFraming(const GfRect2i &dataWindow)
Creates a framing with equal display and data window (and assuming square pixels).
GfRange2f displayWindow
The display window.
Definition: framing.h:145
CAMERAUTIL_API bool IsValid() const
Is display and data window non-empty.
float pixelAspectRatio
The ratio of the width to the height of a pixel - same as OpenEXR.
Definition: framing.h:153
CAMERAUTIL_API CameraUtilFraming(const GfRange2f &displayWindow, const GfRect2i &dataWindow, float pixelAspectRatio=1.0)
Creates a framing with given display and data window and pixel aspect ratio.
GfRect2i dataWindow
The data window.
Definition: framing.h:149
CAMERAUTIL_API GfMatrix4d ApplyToProjectionMatrix(const GfMatrix4d &projectionMatrix, CameraUtilConformWindowPolicy windowPolicy) const
Given the projectionMatrix computed from a camera, applies the framing.
Stores a 4x4 matrix of double elements.
Definition: matrix4d.h:88
Basic type: 2-dimensional floating point range.
Definition: range2f.h:64
A 2D rectangle with integer coordinates.
Definition: rect2i.h:60