Header Class Reference

#include <ImfHeader.h>

Inheritance diagram for Header:

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

Public Member Functions
IMF_EXPORT	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)
IMF_EXPORT	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)
IMF_EXPORT	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)
IMF_EXPORT	Header (const Header &other)
IMF_EXPORT	Header (Header &&other)
IMF_EXPORT	~Header ()
IMF_EXPORT Header &	operator= (const Header &other)
IMF_EXPORT Header &	operator= (Header &&other)
IMF_EXPORT void	insert (const char name[], const Attribute &attribute)
IMF_EXPORT void	insert (const std::string &name, const Attribute &attribute)
IMF_EXPORT void	erase (const char name[])
IMF_EXPORT void	erase (const std::string &name)
IMF_EXPORT Attribute &	operator[] (const char name[])
IMF_EXPORT const Attribute &	operator[] (const char name[]) const
IMF_EXPORT Attribute &	operator[] (const std::string &name)
IMF_EXPORT const Attribute &	operator[] (const std::string &name) const
template<class T >
T &	typedAttribute (const char name[])
template<class T >
const T &	typedAttribute (const char name[]) const
template<class T >
T &	typedAttribute (const std::string &name)
template<class T >
const T &	typedAttribute (const std::string &name) const
template<class T >
T *	findTypedAttribute (const char name[])
template<class T >
const T *	findTypedAttribute (const char name[]) const
template<class T >
T *	findTypedAttribute (const std::string &name)
template<class T >
const T *	findTypedAttribute (const std::string &name) const
IMF_EXPORT Iterator	begin ()
IMF_EXPORT ConstIterator	begin () const
IMF_EXPORT Iterator	end ()
IMF_EXPORT ConstIterator	end () const
IMF_EXPORT Iterator	find (const char name[])
IMF_EXPORT ConstIterator	find (const char name[]) const
IMF_EXPORT Iterator	find (const std::string &name)
IMF_EXPORT ConstIterator	find (const std::string &name) const
IMF_EXPORT IMATH_NAMESPACE::Box2i &	displayWindow ()
IMF_EXPORT const IMATH_NAMESPACE::Box2i &	displayWindow () const
IMF_EXPORT IMATH_NAMESPACE::Box2i &	dataWindow ()
IMF_EXPORT const IMATH_NAMESPACE::Box2i &	dataWindow () const
IMF_EXPORT float &	pixelAspectRatio ()
IMF_EXPORT const float &	pixelAspectRatio () const
IMF_EXPORT IMATH_NAMESPACE::V2f &	screenWindowCenter ()
IMF_EXPORT const IMATH_NAMESPACE::V2f &	screenWindowCenter () const
IMF_EXPORT float &	screenWindowWidth ()
IMF_EXPORT const float &	screenWindowWidth () const
IMF_EXPORT ChannelList &	channels ()
IMF_EXPORT const ChannelList &	channels () const
IMF_EXPORT LineOrder &	lineOrder ()
IMF_EXPORT const LineOrder &	lineOrder () const
IMF_EXPORT Compression &	compression ()
IMF_EXPORT const Compression &	compression () const
IMF_EXPORT void	resetDefaultCompressionLevels ()
IMF_EXPORT int &	zipCompressionLevel ()
IMF_EXPORT int	zipCompressionLevel () const
IMF_EXPORT float &	dwaCompressionLevel ()
IMF_EXPORT float	dwaCompressionLevel () const
IMF_EXPORT void	setName (const string &name)
IMF_EXPORT string &	name ()
IMF_EXPORT const string &	name () const
IMF_EXPORT bool	hasName () const
IMF_EXPORT void	setType (const string &Type)
IMF_EXPORT string &	type ()
IMF_EXPORT const string &	type () const
IMF_EXPORT bool	hasType () const
IMF_EXPORT void	setVersion (const int version)
IMF_EXPORT int &	version ()
IMF_EXPORT const int &	version () const
IMF_EXPORT bool	hasVersion () const
IMF_EXPORT void	setChunkCount (int chunks)
IMF_EXPORT bool	hasChunkCount () const
IMF_EXPORT const int &	chunkCount () const
IMF_EXPORT int &	chunkCount ()
IMF_EXPORT void	setView (const string &view)
IMF_EXPORT bool	hasView () const
IMF_EXPORT string &	view ()
IMF_EXPORT const string &	view () const
IMF_EXPORT void	setTileDescription (const TileDescription &td)
IMF_EXPORT TileDescription &	tileDescription ()
IMF_EXPORT const TileDescription &	tileDescription () const
IMF_EXPORT bool	hasTileDescription () const
IMF_EXPORT void	setPreviewImage (const PreviewImage &p)
IMF_EXPORT PreviewImage &	previewImage ()
IMF_EXPORT const PreviewImage &	previewImage () const
IMF_EXPORT bool	hasPreviewImage () const
IMF_EXPORT void	sanityCheck (bool isTiled=false, bool isMultipartFile=false) const
IMF_EXPORT bool	readsNothing ()
IMF_EXPORT uint64_t	writeTo (OPENEXR_IMF_INTERNAL_NAMESPACE::OStream &os, bool isTiled=false) const
IMF_EXPORT void	readFrom (OPENEXR_IMF_INTERNAL_NAMESPACE::IStream &is, int &version)
IMF_EXPORT	Iterator ()
IMF_EXPORT	Iterator (const Header::AttributeMap::iterator &i)
IMF_EXPORT Iterator &	operator++ ()
IMF_EXPORT Iterator	operator++ (int)
IMF_EXPORT const char *	name () const
IMF_EXPORT Attribute &	attribute () const
IMF_EXPORT	ConstIterator ()
IMF_EXPORT	ConstIterator (const Header::AttributeMap::const_iterator &i)
IMF_EXPORT	ConstIterator (const Header::Iterator &other)
IMF_EXPORT ConstIterator &	operator++ ()
IMF_EXPORT ConstIterator	operator++ (int)
IMF_EXPORT const char *	name () const
IMF_EXPORT const Attribute &	attribute () const

Static Public Member Functions
static IMF_EXPORT void	setMaxImageSize (int maxWidth, int maxHeight)
static IMF_EXPORT void	setMaxTileSize (int maxWidth, int maxHeight)
static IMF_EXPORT void	getMaxImageSize (int &maxWidth, int &maxHeight)
static IMF_EXPORT void	getMaxTileSize (int &maxWidth, int &maxHeight)

Friends
class	Header::ConstIterator
bool	operator== (const ConstIterator &, const ConstIterator &)
bool	operator!= (const ConstIterator &, const ConstIterator &)

Detailed Description

Definition at line 36 of file ImfHeader.h.

Member Typedef Documentation

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

Definition at line 200 of file ImfHeader.h.

Constructor & Destructor Documentation

IMF_EXPORT 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
	)

IMF_EXPORT 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
	)

IMF_EXPORT 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
	)

IMF_EXPORT Header::Header

(

const Header &

other

)

IMF_EXPORT Header::Header

(

Header &&

other

)

IMF_EXPORT Header::~Header

(

)

Member Function Documentation

IMF_EXPORT Attribute& Header::attribute

(

)

const

IMF_EXPORT const Attribute& Header::attribute

(

)

const

IMF_EXPORT Iterator Header::begin

(

)

IMF_EXPORT ConstIterator Header::begin

(

)

const

IMF_EXPORT ChannelList& Header::channels

(

)

IMF_EXPORT const ChannelList& Header::channels

(

)

const

IMF_EXPORT const int& Header::chunkCount

(

)

const

IMF_EXPORT int& Header::chunkCount

(

)

IMF_EXPORT Compression& Header::compression

(

)

IMF_EXPORT const Compression& Header::compression

(

)

const

IMF_EXPORT Header::ConstIterator

(

)

IMF_EXPORT Header::ConstIterator

(

const Header::AttributeMap::const_iterator &

i

)

IMF_EXPORT Header::ConstIterator

(

const Header::Iterator &

other

)

IMF_EXPORT IMATH_NAMESPACE::Box2i& Header::dataWindow

(

)

IMF_EXPORT const IMATH_NAMESPACE::Box2i& Header::dataWindow

(

)

const

IMF_EXPORT IMATH_NAMESPACE::Box2i& Header::displayWindow

(

)

IMF_EXPORT const IMATH_NAMESPACE::Box2i& Header::displayWindow

(

)

const

IMF_EXPORT float& Header::dwaCompressionLevel

(

)

IMF_EXPORT float Header::dwaCompressionLevel

(

)

const

IMF_EXPORT Iterator Header::end

(

)

IMF_EXPORT ConstIterator Header::end

(

)

const

IMF_EXPORT void Header::erase

(

const char

name[]

)

IMF_EXPORT void Header::erase

(

const std::string &

name

)

IMF_EXPORT Iterator Header::find

(

const char

name[]

)

IMF_EXPORT ConstIterator Header::find

(

const char

name[]

)

const

IMF_EXPORT Iterator Header::find

(

const std::string &

name

)

IMF_EXPORT ConstIterator Header::find

(

const std::string &

name

)

const

template<class T >

T * Header::findTypedAttribute

(

const char

name[]

)

Definition at line 699 of file ImfHeader.h.

template<class T >

const T * Header::findTypedAttribute

(

const char

name[]

)

const

Definition at line 707 of file ImfHeader.h.

template<class T >

T * Header::findTypedAttribute

(

const std::string &

name

)

Definition at line 715 of file ImfHeader.h.

template<class T >

const T * Header::findTypedAttribute

(

const std::string &

name

)

const

Definition at line 722 of file ImfHeader.h.

static IMF_EXPORT void Header::getMaxImageSize ( int &  maxWidth, int &  maxHeight  )

static

static IMF_EXPORT void Header::getMaxTileSize ( int &  maxWidth, int &  maxHeight  )

static

IMF_EXPORT bool Header::hasChunkCount

(

)

const

IMF_EXPORT bool Header::hasName

(

)

const

IMF_EXPORT bool Header::hasPreviewImage

(

)

const

IMF_EXPORT bool Header::hasTileDescription

(

)

const

IMF_EXPORT bool Header::hasType

(

)

const

IMF_EXPORT bool Header::hasVersion

(

)

const

IMF_EXPORT bool Header::hasView

(

)

const

IMF_EXPORT void Header::insert	(	const char	name[],
		const Attribute &	attribute
	)

IMF_EXPORT void Header::insert	(	const std::string &	name,
		const Attribute &	attribute
	)

IMF_EXPORT Header::Iterator

(

)

IMF_EXPORT Header::Iterator

(

const Header::AttributeMap::iterator &

i

)

IMF_EXPORT LineOrder& Header::lineOrder

(

)

IMF_EXPORT const LineOrder& Header::lineOrder

(

)

const

IMF_EXPORT string& Header::name

(

)

IMF_EXPORT const string& Header::name

(

)

const

IMF_EXPORT const char* Header::name

(

)

const

IMF_EXPORT const char* Header::name

(

)

const

IMF_EXPORT Iterator& Header::operator++

(

)

IMF_EXPORT Iterator Header::operator++

(

int

)

IMF_EXPORT ConstIterator& Header::operator++

(

)

IMF_EXPORT ConstIterator Header::operator++

(

int

)

IMF_EXPORT Header& Header::operator=

(

const Header &

other

)

IMF_EXPORT Header& Header::operator=

(

Header &&

other

)

IMF_EXPORT Attribute& Header::operator[]

(

const char

name[]

)

IMF_EXPORT const Attribute& Header::operator[]

(

const char

name[]

)

const

IMF_EXPORT Attribute& Header::operator[]

(

const std::string &

name

)

IMF_EXPORT const Attribute& Header::operator[]

(

const std::string &

name

)

const

IMF_EXPORT float& Header::pixelAspectRatio

(

)

IMF_EXPORT const float& Header::pixelAspectRatio

(

)

const

IMF_EXPORT PreviewImage& Header::previewImage

(

)

IMF_EXPORT const PreviewImage& Header::previewImage

(

)

const

IMF_EXPORT void Header::readFrom	(	OPENEXR_IMF_INTERNAL_NAMESPACE::IStream &	is,
		int &	version
	)

IMF_EXPORT bool Header::readsNothing

(

)

IMF_EXPORT void Header::resetDefaultCompressionLevels

(

)

IMF_EXPORT void Header::sanityCheck	(	bool	isTiled = false,
		bool	isMultipartFile = false
	)		const

IMF_EXPORT IMATH_NAMESPACE::V2f& Header::screenWindowCenter

(

)

IMF_EXPORT const IMATH_NAMESPACE::V2f& Header::screenWindowCenter

(

)

const

IMF_EXPORT float& Header::screenWindowWidth

(

)

IMF_EXPORT const float& Header::screenWindowWidth

(

)

const

IMF_EXPORT void Header::setChunkCount

(

int

chunks

)

static IMF_EXPORT void Header::setMaxImageSize ( int  maxWidth, int  maxHeight  )

static

static IMF_EXPORT void Header::setMaxTileSize ( int  maxWidth, int  maxHeight  )

static

IMF_EXPORT void Header::setName

(

const string &

name

)

IMF_EXPORT void Header::setPreviewImage

(

const PreviewImage &

p

)

IMF_EXPORT void Header::setTileDescription

(

const TileDescription &

td

)

IMF_EXPORT void Header::setType

(

const string &

Type

)

IMF_EXPORT void Header::setVersion

(

const int

version

)

IMF_EXPORT void Header::setView

(

const string &

view

)

IMF_EXPORT TileDescription& Header::tileDescription

(

)

IMF_EXPORT const TileDescription& Header::tileDescription

(

)

const

IMF_EXPORT string& Header::type

(

)

IMF_EXPORT const string& Header::type

(

)

const

template<class T >

T & Header::typedAttribute

(

const char

name[]

)

Definition at line 661 of file ImfHeader.h.

template<class T >

const T & Header::typedAttribute

(

const char

name[]

)

const

Definition at line 673 of file ImfHeader.h.

template<class T >

T & Header::typedAttribute

(

const std::string &

name

)

Definition at line 685 of file ImfHeader.h.

template<class T >

const T & Header::typedAttribute

(

const std::string &

name

)

const

Definition at line 692 of file ImfHeader.h.

IMF_EXPORT int& Header::version

(

)

IMF_EXPORT const int& Header::version

(

)

const

IMF_EXPORT string& Header::view

(

)

IMF_EXPORT const string& Header::view

(

)

const

IMF_EXPORT uint64_t Header::writeTo	(	OPENEXR_IMF_INTERNAL_NAMESPACE::OStream &	os,
		bool	isTiled = false
	)		const

IMF_EXPORT int& Header::zipCompressionLevel

(

)

IMF_EXPORT int Header::zipCompressionLevel

(

)

const

Friends And Related Function Documentation

friend class Header::ConstIterator

friend

Definition at line 508 of file ImfHeader.h.

bool operator!= ( const ConstIterator &  , const ConstIterator &    )

friend

bool operator== ( const ConstIterator &  , const ConstIterator &    )

friend

---

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

• OpenEXR/ImfHeader.h