HdCamera Class Reference

Hydra schema for a camera that pulls the params (see above) during Sync. More...

Inheritance diagram for HdCamera:

Public Types
enum	DirtyBits : HdDirtyBits {   Clean = 0, DirtyTransform = 1 << 0, DirtyParams = 1 << 1, DirtyClipPlanes = 1 << 2,   DirtyWindowPolicy = 1 << 3, AllDirty }
enum	Projection { Perspective = 0, Orthographic }
using	ClipPlanesVector = std::vector< GfVec4d >

Public Member Functions
HD_API	HdCamera (SdfPath const &id)
HD_API void	Sync (HdSceneDelegate *sceneDelegate, HdRenderParam *renderParam, HdDirtyBits *dirtyBits) override
	Sprim API. More...
HD_API HdDirtyBits	GetInitialDirtyBitsMask () const override
	Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim. More...
GfMatrix4d const &	GetTransform () const
	Camera parameters accessor API. More...
Projection	GetProjection () const
	Returns whether camera is orthographic and perspective. More...
float	GetHorizontalAperture () const
	Returns horizontal aperture in world units. More...
float	GetVerticalAperture () const
	Returns vertical aperture in world units. More...
float	GetHorizontalApertureOffset () const
	Returns horizontal aperture offset in world units. More...
float	GetVerticalApertureOffset () const
	Returns vertical aperture offset in world units. More...
float	GetFocalLength () const
	Returns focal length in world units. More...
GfRange1f const &	GetClippingRange () const
	Returns near and far plane in world units. More...
std::vector< GfVec4d > const &	GetClipPlanes () const
	Returns any additional clipping planes defined in camera space. More...
float	GetFStop () const
	Returns fstop of camera. More...
float	GetFocusDistance () const
	Returns focus distance in world units. More...
double	GetShutterOpen () const
double	GetShutterClose () const
float	GetExposure () const
CameraUtilConformWindowPolicy const &	GetWindowPolicy () const
	Returns the window policy of the camera. More...
HD_API GfMatrix4d	ComputeProjectionMatrix () const
	Convenience API for rasterizers. More...
Public Member Functions inherited from HdSprim
HD_API	HdSprim (SdfPath const &id)
SdfPath const &	GetId () const
	Returns the identifier by which this state is known. More...
virtual HD_API void	Finalize (HdRenderParam *renderParam)
	Finalizes object resources. More...

Protected Attributes
GfMatrix4d	_transform
Projection	_projection
float	_horizontalAperture
float	_verticalAperture
float	_horizontalApertureOffset
float	_verticalApertureOffset
float	_focalLength
GfRange1f	_clippingRange
std::vector< GfVec4d >	_clipPlanes
float	_fStop
float	_focusDistance
double	_shutterOpen
double	_shutterClose
float	_exposure
CameraUtilConformWindowPolicy	_windowPolicy

Detailed Description

Hydra schema for a camera that pulls the params (see above) during Sync.

Backends that use additional camera parameters can inherit from HdCamera and pull on them.

Definition at line 79 of file camera.h.

Member Function Documentation

ComputeProjectionMatrix()

HD_API GfMatrix4d ComputeProjectionMatrix

(

)

const

Convenience API for rasterizers.

Computes the projection matrix for a camera from its physical properties.

GetClippingRange()

GfRange1f const& GetClippingRange ( ) const

inline

Returns near and far plane in world units.

Definition at line 165 of file camera.h.

GetClipPlanes()

std::vector<GfVec4d> const& GetClipPlanes ( ) const

inline

Returns any additional clipping planes defined in camera space.

Definition at line 170 of file camera.h.

GetFocalLength()

float GetFocalLength ( ) const

inline

Returns focal length in world units.

Definition at line 160 of file camera.h.

GetFocusDistance()

float GetFocusDistance ( ) const

inline

Returns focus distance in world units.

Definition at line 180 of file camera.h.

GetFStop()

float GetFStop ( ) const

inline

Returns fstop of camera.

Definition at line 175 of file camera.h.

GetHorizontalAperture()

float GetHorizontalAperture ( ) const

inline

Returns horizontal aperture in world units.

Definition at line 140 of file camera.h.

GetHorizontalApertureOffset()

float GetHorizontalApertureOffset ( ) const

inline

Returns horizontal aperture offset in world units.

Definition at line 150 of file camera.h.

GetInitialDirtyBitsMask()

HD_API HdDirtyBits GetInitialDirtyBitsMask ( ) const

overridevirtual

Returns the minimal set of dirty bits to place in the change tracker for use in the first sync of this prim.

Typically this would be all dirty bits.

Implements HdSprim.

GetProjection()

Projection GetProjection ( ) const

inline

Returns whether camera is orthographic and perspective.

Definition at line 135 of file camera.h.

GetTransform()

GfMatrix4d const& GetTransform ( ) const

inline

Camera parameters accessor API.

Returns camera transform

Definition at line 130 of file camera.h.

GetVerticalAperture()

float GetVerticalAperture ( ) const

inline

Returns vertical aperture in world units.

Definition at line 145 of file camera.h.

GetVerticalApertureOffset()

float GetVerticalApertureOffset ( ) const

inline

Returns vertical aperture offset in world units.

Definition at line 155 of file camera.h.

GetWindowPolicy()

CameraUtilConformWindowPolicy const& GetWindowPolicy ( ) const

inline

Returns the window policy of the camera.

If no opinion is authored, we default to "CameraUtilFit"

Definition at line 198 of file camera.h.

Sync()

HD_API void Sync ( HdSceneDelegate *  sceneDelegate, HdRenderParam *  renderParam, HdDirtyBits *  dirtyBits  )

overridevirtual

Sprim API.

Synchronizes state from the delegate to this object.

Implements HdSprim.

Reimplemented in HdPrmanCamera.

---

The documentation for this class was generated from the following file:

• pxr/imaging/hd/camera.h