VRS - The Virtual Rendering System

version 3.3

lineariterator.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2003 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  is  free  software; you can redistribute it and/or  modify it
 * under the terms of the GNU Lesser General Public  License  as  published  by
 * the  Free  Software  Foundation;  either  version 2.1 of the License, or (at
 * your option) any later version. This library  is  distributed  in  the  hope
 * that  it will be useful, but  WITHOUT ANY WARRANTY; without even the implied
 * warranty of  MERCHANTABILITY or FITNESS FOR A PARTICULAR  PURPOSE.  See  the
 * GNU Lesser General Public License for more details. You should have received
 * a copy of the GNU Lesser+ General Public License along with this library; if
 * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: lineariterator.h 6698 2009-08-31 16:46:16Z Johannes_Bohnet $
// $Date: 2009-08-31 18:46:16 +0200 (Mon, 31 Aug 2009) $
// $Revision: 6698 $
// $State$
// $Author: Johannes_Bohnet $
//
// $Log$
// Revision 1.9  2004/11/03 10:58:28  saar
// Class comment changed (Doxygen style)
//
// Revision 1.8  2004/06/03 12:48:00  kirsch
// replaced vrs assertions with check args and internal error macros
//
// Revision 1.7  2004/03/12 16:28:39  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.6  2004/02/06 09:52:53  wendland
// added VRS_SERIALIZATION_PARENT_CLASS
//
// Revision 1.5  2004/01/19 11:43:57  baumann
// serialization mechanism improved
//
// Revision 1.4  2004/01/15 14:16:54  baumann
// serialization mechanism improved
//
// Revision 1.3  2003/07/10 11:07:56  baumann
// code cleanup
//
// Revision 1.2  2003/02/11 11:04:52  baumann
// bug fix for (size_ == 1)
//
// Revision 1.1  2003/02/10 12:10:35  baumann
// new class LinearIterator<T> added
//

#ifndef VRS_CONTAINER_LINEARITERATOR_H
#define VRS_CONTAINER_LINEARITERATOR_H

#include <vrs/container/iterator.h>

namespace VRS {

template<typename T>
class LinearIterator : public Iterator<T> {
public:
    LinearIterator(const T& startValue, const T& endValue, unsigned int size = 0)
        : startValue_(startValue), endValue_(endValue), size_(size) {
    }
    void setStartValue(const T& startValue) {
        if(startValue_ != startValue) {
            startValue_ = startValue;
            SharedObj::modified();
        }
    }
    const T& getStartValue() const { return startValue_; }
    void setEndValue(const T& endValue) {
        if(endValue_ != endValue) {
            endValue_ = endValue;
            SharedObj::modified();
        }
    }
    const T& getEndValue() const { return endValue_; }
    virtual unsigned int size() const { return size_; }
    void setSize(unsigned int size) {
        if(size_ != size) {
            size_ = size;
            SharedObj::modified();
        }
    }
    virtual T get(unsigned int index) const {
        VRS_CheckArg(index < size_, "index out of range");
        if(size_ == 1u) { return startValue_; }
        const double factor = static_cast<double>(index) / static_cast<double>(size_ - 1u);
        return ((1.0 - factor) * startValue_) + (factor * endValue_);
    }

    VRS_TYPEINFO(LinearIterator, Iterator<T>);
    VRS_SERIALIZABLE(LinearIterator);

protected:
    LinearIterator() { } // only for serialization

private:
    T startValue_;
    T endValue_;
    unsigned int size_;
};

template<class T>
inline void LinearIterator<T>::serialize(SerializationManager& doc) {
    UINT8 version = 0;
        doc.classVersion(version);

    VRS_SERIALIZATION_PARENT_CLASS(doc, Iterator<T>);
        serialization(doc, "Size", size_);
    serialization(doc, "StartValue", startValue_);
    serialization(doc, "EndValue", endValue_);
}

VRS_SERIALIZATION_REGISTRATION_TEMPLATE(LinearIterator);

} // namespace VRS

#endif // VRS_CONTAINER_LINEARITERATOR_H

---

Generated on Wed May 23 06:00:13 2012 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact