///////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2014, Industrial Light & Magic, a division of Lucas
// Digital Ltd. LLC
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Industrial Light & Magic nor the names of
// its contributors may be used to endorse or promote products derived
// from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
///////////////////////////////////////////////////////////////////////////
#ifndef INCLUDED_IMF_FLAT_IMAGE_LEVEL_H
#define INCLUDED_IMF_FLAT_IMAGE_LEVEL_H
//----------------------------------------------------------------------------
//
// class FlatImageLevel
// class FlatImageLevel::Iterator
// class FlatImageLevel::ConstIterator
//
// For an explanation of images, levels and channels,
// see the comments in header file Image.h.
//
//----------------------------------------------------------------------------
#include <ImfFlatImageChannel.h>
#include <ImfImageLevel.h>
#include <ImathBox.h>
#include <string>
#include <map>
#include "ImfExport.h"
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_ENTER
class FlatImage;
class IMF_EXPORT FlatImageLevel : public ImageLevel
{
public:
//
// Access to the flat image to which the level belongs.
//
FlatImage & flatImage();
const FlatImage & flatImage() const;
//
// Accessing channels by name:
//
// findChannel(n) returns a pointer to the image channel with
// name n, or 0 if no such channel exists.
//
// channel(n) returns a reference to the image channel with
// name n, or throws an Iex::ArgExc exception if
// no such channel exists.
//
// findTypedChannel<T>(n) returns a pointer to the image channel with
// name n and type T, or 0 if no such channel
// exists.
//
// typedChannel(n) returns a reference to the image channel with
// name n and type T, or throws an Iex::ArgExc
// exception if no such channel exists.
//
FlatImageChannel * findChannel (const std::string& name);
const FlatImageChannel * findChannel (const std::string& name) const;
FlatImageChannel & channel (const std::string& name);
const FlatImageChannel & channel (const std::string& name) const;
template <class T>
TypedFlatImageChannel<T> * findTypedChannel
(const std::string& name);
template <class T>
const TypedFlatImageChannel<T> * findTypedChannel
(const std::string& name) const;
template <class T>
TypedFlatImageChannel<T> & typedChannel
(const std::string& name);
template <class T>
const TypedFlatImageChannel<T> & typedChannel
(const std::string& name) const;
//
// Iterator-style access to channels
//
typedef std::map <std::string, FlatImageChannel *> ChannelMap;
class Iterator;
class ConstIterator;
Iterator begin();
ConstIterator begin() const;
Iterator end();
ConstIterator end() const;
private:
friend class FlatImage;
//
// The constructor and destructor are private.
// Image levels exist only as part of an image.
//
FlatImageLevel (FlatImage& image,
int xLevelNumber,
int yLevelNumber,
const IMATH_NAMESPACE::Box2i& dataWindow);
virtual ~FlatImageLevel ();
virtual void resize (const IMATH_NAMESPACE::Box2i& dataWindow);
virtual void shiftPixels (int dx, int dy);
virtual void insertChannel (const std::string& name,
PixelType type,
int xSampling,
int ySampling,
bool pLinear);
virtual void eraseChannel (const std::string& name);
virtual void clearChannels ();
virtual void renameChannel (const std::string &oldName,
const std::string &newName);
virtual void renameChannels (const RenamingMap &oldToNewNames);
ChannelMap _channels;
};
class FlatImageLevel::Iterator
{
public:
Iterator ();
Iterator (const FlatImageLevel::ChannelMap::iterator& i);
//
// Advance the iterator
//
Iterator & operator ++ ();
Iterator operator ++ (int);
//
// Access to the channel to which the iterator points,
// and to the name of that channel.
//
const std::string & name () const;
FlatImageChannel & channel () const;
private:
friend class FlatImageLevel::ConstIterator;
FlatImageLevel::ChannelMap::iterator _i;
};
class FlatImageLevel::ConstIterator
{
public:
ConstIterator ();
ConstIterator (const FlatImageLevel::ChannelMap::const_iterator& i);
ConstIterator (const FlatImageLevel::Iterator& other);
//
// Advance the iterator
//
ConstIterator & operator ++ ();
ConstIterator operator ++ (int);
//
// Access to the channel to which the iterator points,
// and to the name of that channel.
//
const std::string & name () const;
const FlatImageChannel & channel () const;
private:
friend bool operator ==
(const ConstIterator &, const ConstIterator &);
friend bool operator !=
(const ConstIterator &, const ConstIterator &);
FlatImageLevel::ChannelMap::const_iterator _i;
};
//-----------------------------------------------------------------------------
// Implementation of templates and inline functions
//-----------------------------------------------------------------------------
template <class T>
TypedFlatImageChannel<T> *
FlatImageLevel::findTypedChannel (const std::string& name)
{
return dynamic_cast <TypedFlatImageChannel<T>*> (findChannel (name));
}
template <class T>
const TypedFlatImageChannel<T> *
FlatImageLevel::findTypedChannel (const std::string& name) const
{
return dynamic_cast <const TypedFlatImageChannel<T>*> (findChannel (name));
}
template <class T>
TypedFlatImageChannel<T> &
FlatImageLevel::typedChannel (const std::string& name)
{
TypedFlatImageChannel<T> * ptr = findTypedChannel<T> (name);
if (ptr == 0)
throwBadChannelNameOrType (name);
return *ptr;
}
template <class T>
const TypedFlatImageChannel<T> &
FlatImageLevel::typedChannel (const std::string& name) const
{
const TypedFlatImageChannel<T> * ptr = findTypedChannel<T> (name);
if (ptr == 0)
throwBadChannelNameOrType (name);
return *ptr;
}
inline
FlatImageLevel::Iterator::Iterator (): _i()
{
// empty
}
inline
FlatImageLevel::Iterator::Iterator (const FlatImageLevel::ChannelMap::iterator& i):
_i (i)
{
// empty
}
inline FlatImageLevel::Iterator &
FlatImageLevel::Iterator::operator ++ ()
{
++_i;
return *this;
}
inline FlatImageLevel::Iterator
FlatImageLevel::Iterator::operator ++ (int)
{
Iterator tmp = *this;
++_i;
return tmp;
}
inline const std::string &
FlatImageLevel::Iterator::name () const
{
return _i->first;
}
inline FlatImageChannel &
FlatImageLevel::Iterator::channel () const
{
return *_i->second;
}
inline
FlatImageLevel::ConstIterator::ConstIterator (): _i()
{
// empty
}
inline
FlatImageLevel::ConstIterator::ConstIterator
(const FlatImageLevel::ChannelMap::const_iterator& i): _i (i)
{
// empty
}
inline
FlatImageLevel::ConstIterator::ConstIterator
(const FlatImageLevel::Iterator& other): _i (other._i)
{
// empty
}
inline FlatImageLevel::ConstIterator &
FlatImageLevel::ConstIterator::operator ++ ()
{
++_i;
return *this;
}
inline FlatImageLevel::ConstIterator
FlatImageLevel::ConstIterator::operator ++ (int)
{
ConstIterator tmp = *this;
++_i;
return tmp;
}
inline const std::string &
FlatImageLevel::ConstIterator::name () const
{
return _i->first;
}
inline const FlatImageChannel &
FlatImageLevel::ConstIterator::channel () const
{
return *_i->second;
}
inline bool
operator == (const FlatImageLevel::ConstIterator& x,
const FlatImageLevel::ConstIterator& y)
{
return x._i == y._i;
}
inline bool
operator != (const FlatImageLevel::ConstIterator& x,
const FlatImageLevel::ConstIterator& y)
{
return !(x == y);
}
OPENEXR_IMF_INTERNAL_NAMESPACE_HEADER_EXIT
#endif