HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Header Class Reference

#include <ImfHeader.h>

Classes

class  ConstIterator
 
class  Iterator
 

Public Types

typedef std::map< Name,
Attribute * > 
AttributeMap
 

Public Member Functions

 Header (int width=64, int height=64, float pixelAspectRatio=1, const IMATH_NAMESPACE::V2f &screenWindowCenter=IMATH_NAMESPACE::V2f(0, 0), float screenWindowWidth=1, LineOrder lineOrder=INCREASING_Y, Compression=ZIP_COMPRESSION)
 
 Header (int width, int height, const IMATH_NAMESPACE::Box2i &dataWindow, float pixelAspectRatio=1, const IMATH_NAMESPACE::V2f &screenWindowCenter=IMATH_NAMESPACE::V2f(0, 0), float screenWindowWidth=1, LineOrder lineOrder=INCREASING_Y, Compression=ZIP_COMPRESSION)
 
 Header (const IMATH_NAMESPACE::Box2i &displayWindow, const IMATH_NAMESPACE::Box2i &dataWindow, float pixelAspectRatio=1, const IMATH_NAMESPACE::V2f &screenWindowCenter=IMATH_NAMESPACE::V2f(0, 0), float screenWindowWidth=1, LineOrder lineOrder=INCREASING_Y, Compression=ZIP_COMPRESSION)
 
 Header (const Header &other)
 
 ~Header ()
 
Headeroperator= (const Header &other)
 
void insert (const char name[], const Attribute &attribute)
 
void insert (const std::string &name, const Attribute &attribute)
 
void erase (const char name[])
 
void erase (const std::string &name)
 
Attributeoperator[] (const char name[])
 
const Attributeoperator[] (const char name[]) const
 
Attributeoperator[] (const std::string &name)
 
const Attributeoperator[] (const std::string &name) const
 
template<class T >
TtypedAttribute (const char name[])
 
template<class T >
const TtypedAttribute (const char name[]) const
 
template<class T >
TtypedAttribute (const std::string &name)
 
template<class T >
const TtypedAttribute (const std::string &name) const
 
template<class T >
TfindTypedAttribute (const char name[])
 
template<class T >
const TfindTypedAttribute (const char name[]) const
 
template<class T >
TfindTypedAttribute (const std::string &name)
 
template<class T >
const TfindTypedAttribute (const std::string &name) const
 
Iterator begin ()
 
ConstIterator begin () const
 
Iterator end ()
 
ConstIterator end () const
 
Iterator find (const char name[])
 
ConstIterator find (const char name[]) const
 
Iterator find (const std::string &name)
 
ConstIterator find (const std::string &name) const
 
IMATH_NAMESPACE::Box2idisplayWindow ()
 
const IMATH_NAMESPACE::Box2idisplayWindow () const
 
IMATH_NAMESPACE::Box2idataWindow ()
 
const IMATH_NAMESPACE::Box2idataWindow () const
 
float & pixelAspectRatio ()
 
const float & pixelAspectRatio () const
 
IMATH_NAMESPACE::V2fscreenWindowCenter ()
 
const IMATH_NAMESPACE::V2fscreenWindowCenter () const
 
float & screenWindowWidth ()
 
const float & screenWindowWidth () const
 
ChannelListchannels ()
 
const ChannelListchannels () const
 
LineOrderlineOrder ()
 
const LineOrderlineOrder () const
 
Compressioncompression ()
 
const Compressioncompression () const
 
void setName (const string &name)
 
stringname ()
 
const stringname () const
 
bool hasName () const
 
void setType (const string &Type)
 
stringtype ()
 
const stringtype () const
 
bool hasType () const
 
void setVersion (const int version)
 
intversion ()
 
const intversion () const
 
bool hasVersion () const
 
void setChunkCount (int chunks)
 
bool hasChunkCount () const
 
const intchunkCount () const
 
intchunkCount ()
 
void setView (const string &view)
 
bool hasView () const
 
stringview ()
 
const stringview () const
 
void setTileDescription (const TileDescription &td)
 
TileDescriptiontileDescription ()
 
const TileDescriptiontileDescription () const
 
bool hasTileDescription () const
 
void setPreviewImage (const PreviewImage &p)
 
PreviewImagepreviewImage ()
 
const PreviewImagepreviewImage () const
 
bool hasPreviewImage () const
 
void sanityCheck (bool isTiled=false, bool isMultipartFile=false) const
 
bool readsNothing ()
 
Int64 writeTo (OPENEXR_IMF_INTERNAL_NAMESPACE::OStream &os, bool isTiled=false) const
 
void readFrom (OPENEXR_IMF_INTERNAL_NAMESPACE::IStream &is, int &version)
 

Static Public Member Functions

static void setMaxImageSize (int maxWidth, int maxHeight)
 
static void setMaxTileSize (int maxWidth, int maxHeight)
 

Detailed Description

Definition at line 69 of file ImfHeader.h.

Member Typedef Documentation

typedef std::map<Name, Attribute *> Header::AttributeMap

Definition at line 219 of file ImfHeader.h.

Constructor & Destructor Documentation

Header::Header ( int  width = 64,
int  height = 64,
float  pixelAspectRatio = 1,
const IMATH_NAMESPACE::V2f screenWindowCenter = IMATH_NAMESPACE::V2f(0, 0),
float  screenWindowWidth = 1,
LineOrder  lineOrder = INCREASING_Y,
Compression  = ZIP_COMPRESSION 
)
Header::Header ( int  width,
int  height,
const IMATH_NAMESPACE::Box2i dataWindow,
float  pixelAspectRatio = 1,
const IMATH_NAMESPACE::V2f screenWindowCenter = IMATH_NAMESPACE::V2f(0, 0),
float  screenWindowWidth = 1,
LineOrder  lineOrder = INCREASING_Y,
Compression  = ZIP_COMPRESSION 
)
Header::Header ( const IMATH_NAMESPACE::Box2i displayWindow,
const IMATH_NAMESPACE::Box2i dataWindow,
float  pixelAspectRatio = 1,
const IMATH_NAMESPACE::V2f screenWindowCenter = IMATH_NAMESPACE::V2f(0, 0),
float  screenWindowWidth = 1,
LineOrder  lineOrder = INCREASING_Y,
Compression  = ZIP_COMPRESSION 
)
Header::Header ( const Header other)
Header::~Header ( )

Member Function Documentation

Iterator Header::begin ( )
ConstIterator Header::begin ( ) const
ChannelList& Header::channels ( )
const ChannelList& Header::channels ( ) const
const int& Header::chunkCount ( ) const
int& Header::chunkCount ( )
Compression& Header::compression ( )
const Compression& Header::compression ( ) const
IMATH_NAMESPACE::Box2i& Header::dataWindow ( )
const IMATH_NAMESPACE::Box2i& Header::dataWindow ( ) const
IMATH_NAMESPACE::Box2i& Header::displayWindow ( )
const IMATH_NAMESPACE::Box2i& Header::displayWindow ( ) const
Iterator Header::end ( )
ConstIterator Header::end ( ) const
void Header::erase ( const char  name[])
void Header::erase ( const std::string name)
Iterator Header::find ( const char  name[])
ConstIterator Header::find ( const char  name[]) const
Iterator Header::find ( const std::string name)
ConstIterator Header::find ( const std::string name) const
template<class T >
T * Header::findTypedAttribute ( const char  name[])

Definition at line 665 of file ImfHeader.h.

template<class T >
const T * Header::findTypedAttribute ( const char  name[]) const

Definition at line 674 of file ImfHeader.h.

template<class T >
T * Header::findTypedAttribute ( const std::string name)

Definition at line 683 of file ImfHeader.h.

template<class T >
const T * Header::findTypedAttribute ( const std::string name) const

Definition at line 691 of file ImfHeader.h.

bool Header::hasChunkCount ( ) const
bool Header::hasName ( ) const
bool Header::hasPreviewImage ( ) const
bool Header::hasTileDescription ( ) const
bool Header::hasType ( ) const
bool Header::hasVersion ( ) const
bool Header::hasView ( ) const
void Header::insert ( const char  name[],
const Attribute attribute 
)
void Header::insert ( const std::string name,
const Attribute attribute 
)
LineOrder& Header::lineOrder ( )
const LineOrder& Header::lineOrder ( ) const
string& Header::name ( )
const string& Header::name ( ) const
Header& Header::operator= ( const Header other)
Attribute& Header::operator[] ( const char  name[])
const Attribute& Header::operator[] ( const char  name[]) const
Attribute& Header::operator[] ( const std::string name)
const Attribute& Header::operator[] ( const std::string name) const
float& Header::pixelAspectRatio ( )
const float& Header::pixelAspectRatio ( ) const
PreviewImage& Header::previewImage ( )
const PreviewImage& Header::previewImage ( ) const
void Header::readFrom ( OPENEXR_IMF_INTERNAL_NAMESPACE::IStream &  is,
int version 
)
bool Header::readsNothing ( )
void Header::sanityCheck ( bool  isTiled = false,
bool  isMultipartFile = false 
) const
IMATH_NAMESPACE::V2f& Header::screenWindowCenter ( )
const IMATH_NAMESPACE::V2f& Header::screenWindowCenter ( ) const
float& Header::screenWindowWidth ( )
const float& Header::screenWindowWidth ( ) const
void Header::setChunkCount ( int  chunks)
static void Header::setMaxImageSize ( int  maxWidth,
int  maxHeight 
)
static
static void Header::setMaxTileSize ( int  maxWidth,
int  maxHeight 
)
static
void Header::setName ( const string name)
void Header::setPreviewImage ( const PreviewImage p)
void Header::setTileDescription ( const TileDescription td)
void Header::setType ( const string Type)
void Header::setVersion ( const int  version)
void Header::setView ( const string view)
TileDescription& Header::tileDescription ( )
const TileDescription& Header::tileDescription ( ) const
string& Header::type ( )
const string& Header::type ( ) const
template<class T >
T & Header::typedAttribute ( const char  name[])

Definition at line 621 of file ImfHeader.h.

template<class T >
const T & Header::typedAttribute ( const char  name[]) const

Definition at line 635 of file ImfHeader.h.

template<class T >
T & Header::typedAttribute ( const std::string name)

Definition at line 649 of file ImfHeader.h.

template<class T >
const T & Header::typedAttribute ( const std::string name) const

Definition at line 657 of file ImfHeader.h.

int& Header::version ( )
const int& Header::version ( ) const
string& Header::view ( )
const string& Header::view ( ) const
Int64 Header::writeTo ( OPENEXR_IMF_INTERNAL_NAMESPACE::OStream &  os,
bool  isTiled = false 
) const

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