HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample Class Reference

#include <CameraSample.h>

Public Member Functions

 CameraSample ()
 Creates a default sample with a bunch of defaults set. More...
 
 CameraSample (double iTop, double iBottom, double iLeft, double iRight)
 
void getScreenWindow (double &oTop, double &oBottom, double &oLeft, double &oRight)
 
double getFocalLength () const
 get the camera focal length in millimeters. More...
 
void setFocalLength (double iVal)
 set the camera focal length in millimeters. More...
 
double getHorizontalAperture () const
 get the horizontal camera film back in centimeters More...
 
void setHorizontalAperture (double iVal)
 set the horizontal camera film back in centimeters More...
 
double getHorizontalFilmOffset () const
 get the horizontal film back offset in centimeters More...
 
void setHorizontalFilmOffset (double iVal)
 set the horizontal film back offset in centimeters More...
 
double getVerticalAperture () const
 get the vertical camera film back in centimeters More...
 
void setVerticalAperture (double iVal)
 set the vertical camera film back in centimeters More...
 
double getVerticalFilmOffset () const
 get the vertical film back offset in centimeters More...
 
void setVerticalFilmOffset (double iVal)
 set the vertical film back offset in centimeters More...
 
double getLensSqueezeRatio () const
 
void setLensSqueezeRatio (double iVal)
 
double getOverScanLeft ()
 
void setOverScanLeft (double iVal)
 
double getOverScanRight () const
 
void setOverScanRight (double iVal)
 
double getOverScanTop () const
 
void setOverScanTop (double iVal)
 
double getOverScanBottom () const
 
void setOverScanBottom (double iVal)
 
double getFStop () const
 get the f-stop (focal length divided by "effective" lens diameter) More...
 
void setFStop (double iVal)
 set the f-stop (focal length divided by "effective" lens diameter) More...
 
double getFocusDistance () const
 
void setFocusDistance (double iVal)
 
double getShutterOpen () const
 get the frame relative shutter open time in seconds. More...
 
void setShutterOpen (double iVal)
 set the frame relative shutter open time in seconds. More...
 
double getShutterClose () const
 get the frame relative shutter close time in seconds. More...
 
void setShutterClose (double iVal)
 set the frame relative shutter open time in seconds. More...
 
double getNearClippingPlane () const
 
void setNearClippingPlane (double iVal)
 
double getFarClippingPlane () const
 
void setFarClippingPlane (double iVal)
 
Abc::Box3d getChildBounds () const
 
void setChildBounds (const Abc::Box3d &iBounds)
 
double getCoreValue (std::size_t iIndex) const
 
double getFieldOfView () const
 
std::size_t addOp (FilmBackXformOp iOp)
 
FilmBackXformOp getOp (std::size_t iIndex) const
 
FilmBackXformOpoperator[] (const std::size_t &iIndex)
 
const FilmBackXformOpoperator[] (const std::size_t &iIndex) const
 
Abc::M33d getFilmBackMatrix () const
 Returns the concatenated 3x3 film back matrix. More...
 
std::size_t getNumOps () const
 
std::size_t getNumOpChannels () const
 
void reset ()
 

Detailed Description

Definition at line 49 of file CameraSample.h.

Constructor & Destructor Documentation

Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::CameraSample ( )
inline

Creates a default sample with a bunch of defaults set.

Definition at line 54 of file CameraSample.h.

Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::CameraSample ( double  iTop,
double  iBottom,
double  iLeft,
double  iRight 
)

Create a default sample and set the defaults so that they calculate the provided screen window.

Member Function Documentation

std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::addOp ( FilmBackXformOp  iOp)
Abc::Box3d Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getChildBounds ( ) const
inline

Definition at line 177 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getCoreValue ( std::size_t  iIndex) const
double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getFarClippingPlane ( ) const
inline

get the distance from the camera to the far clipping plane in centimeters

Definition at line 171 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getFieldOfView ( ) const
Abc::M33d Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getFilmBackMatrix ( ) const

Returns the concatenated 3x3 film back matrix.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getFocalLength ( ) const
inline

get the camera focal length in millimeters.

Definition at line 64 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getFocusDistance ( ) const
inline

get the distance from the camera to the object being focused on in centimeters

Definition at line 143 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getFStop ( ) const
inline

get the f-stop (focal length divided by "effective" lens diameter)

Definition at line 136 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getHorizontalAperture ( ) const
inline

get the horizontal camera film back in centimeters

Definition at line 70 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getHorizontalFilmOffset ( ) const
inline

get the horizontal film back offset in centimeters

Definition at line 76 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getLensSqueezeRatio ( ) const
inline

get the amount the camera's lens compresses the image horizontally (width / height aspect ratio)

Definition at line 96 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getNearClippingPlane ( ) const
inline

get the distance from the camera to the near clipping plane in centimeters

Definition at line 163 of file CameraSample.h.

std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getNumOpChannels ( ) const
std::size_t Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getNumOps ( ) const
FilmBackXformOp Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getOp ( std::size_t  iIndex) const
double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getOverScanBottom ( ) const
inline

get over scan fractional percentage for the bottom part of the screen window

Definition at line 129 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getOverScanLeft ( )
inline

get over scan fractional percentage for the left part of the screen window

Definition at line 105 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getOverScanRight ( ) const
inline

get over scan fractional percentage for the right part of the screen window

Definition at line 113 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getOverScanTop ( ) const
inline

get over scan fractional percentage for the top part of the screen window

Definition at line 121 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getScreenWindow ( double &  oTop,
double &  oBottom,
double &  oLeft,
double &  oRight 
)
double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getShutterClose ( ) const
inline

get the frame relative shutter close time in seconds.

Definition at line 156 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getShutterOpen ( ) const
inline

get the frame relative shutter open time in seconds.

Definition at line 150 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getVerticalAperture ( ) const
inline

get the vertical camera film back in centimeters

Definition at line 83 of file CameraSample.h.

double Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::getVerticalFilmOffset ( ) const
inline

get the vertical film back offset in centimeters

Definition at line 89 of file CameraSample.h.

FilmBackXformOp& Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::operator[] ( const std::size_t &  iIndex)
const FilmBackXformOp& Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::operator[] ( const std::size_t &  iIndex) const
void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::reset ( )
inline

Definition at line 202 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setChildBounds ( const Abc::Box3d iBounds)
inline

Definition at line 178 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setFarClippingPlane ( double  iVal)
inline

set the distance from the camera to the near clipping plane in centimeters

Definition at line 175 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setFocalLength ( double  iVal)
inline

set the camera focal length in millimeters.

Definition at line 67 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setFocusDistance ( double  iVal)
inline

set the distance from the camera to the object being focused on in centimeters

Definition at line 147 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setFStop ( double  iVal)
inline

set the f-stop (focal length divided by "effective" lens diameter)

Definition at line 139 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setHorizontalAperture ( double  iVal)
inline

set the horizontal camera film back in centimeters

Definition at line 73 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setHorizontalFilmOffset ( double  iVal)
inline

set the horizontal film back offset in centimeters

Definition at line 79 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setLensSqueezeRatio ( double  iVal)
inline

set the amount the camera's lens compresses the image horizontally (width / height aspect ratio)

Definition at line 100 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setNearClippingPlane ( double  iVal)
inline

set the distance from the camera to the near clipping plane in centimeters

Definition at line 167 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setOverScanBottom ( double  iVal)
inline

set over scan fractional percentage for the bottom part of the screen window

Definition at line 133 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setOverScanLeft ( double  iVal)
inline

set over scan fractional percentage for the left part of the screen window

Definition at line 109 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setOverScanRight ( double  iVal)
inline

set over scan fractional percentage for the right part of the screen window

Definition at line 117 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setOverScanTop ( double  iVal)
inline

get over scan fractional percentage for the top part of the screen window

Definition at line 125 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setShutterClose ( double  iVal)
inline

set the frame relative shutter open time in seconds.

Definition at line 159 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setShutterOpen ( double  iVal)
inline

set the frame relative shutter open time in seconds.

Definition at line 153 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setVerticalAperture ( double  iVal)
inline

set the vertical camera film back in centimeters

Definition at line 86 of file CameraSample.h.

void Alembic::AbcGeom::ALEMBIC_VERSION_NS::CameraSample::setVerticalFilmOffset ( double  iVal)
inline

set the vertical film back offset in centimeters

Definition at line 92 of file CameraSample.h.


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