VRS - The Virtual Rendering System

version 3.3

timerequirement.h

Go to the documentation of this file.

 /**********************************************************************
 VRS - The Virtual Rendering System
 Copyright (C) 2001 Computer Graphics Systems Group at the 
 Hasso-Plattner-Institute, 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: timerequirement.h 6014 2007-08-09 07:51:16Z Konstantin_Baumann $
// $Date: 2007-08-09 09:51:16 +0200 (Thu, 09 Aug 2007) $
// $Revision: 6014 $
// $State$
// $Author: Konstantin_Baumann $
//
// $Log$
// Revision 1.18  2005/06/30 07:19:37  baumann
// VRS::Min(), VRS::Max(), and VRS::Swap() replaced by std::min(), std::max(), and std::swap()
//
// Revision 1.17  2005/01/03 01:43:10  klimetschek
// - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
// - removed vrs.vcproj
// minor things:
// - added all glutexamples to vrs4glut.sln
// - fixed some problems in glutexamples
// - removed all project references from all VS projects (using solution wide project dependencies instead)
//
// Revision 1.16  2004/10/28 14:16:01  basch
// Class comment changed (Doxygen style)
//
// Revision 1.15  2004/03/12 16:28:41  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.14  2004/01/19 11:44:00  baumann
// serialization mechanism improved
//
// Revision 1.13  2003/11/07 14:19:26  kirsch
// removed leading underscore from include guards
//
// Revision 1.12  2003/10/21 11:41:13  baumann
// moved class VRSTime from "vrs/sg" to "vrs"
//
// Revision 1.11  2002/11/18 16:00:18  baumann
// bug fix: minimum calculation now subtracts shrinking value
//
// Revision 1.10  2002/10/29 10:32:53  baumann
// macros VRS_CLASSNAME_* and VRS_IMPL_TYPEINFO_* removed
//
// Revision 1.9  2002/02/27 15:03:29  kersting
// renamed Time to VRSTime
//
// Revision 1.8  2002/02/19 10:34:21  kosta
// undone all changes since 2002-02-15
//
// Revision 1.5  2002/02/05 07:48:26  kosta
// new persistency macros:
//     VRS_SERIALIZABLE(CLASS_NAME);
//     VRS_SERIALIZABLE_ABSTRACT_CLASS(CLASS_NAME);
//     VRS_SERIALIZABLE_NO_SO_CLASS(CLASS_NAME)
//
// Revision 1.4  2002/02/04 11:54:37  kosta
// persistency rewritten (for better namespace support)
//
// Revision 1.3  2002/01/15 16:25:55  kosta
// macros rewritten for a better namespace support
//
// Revision 1.2  2001/11/13 16:36:32  kirsch
// changed line feed to unix style (removed control-M)
//
// Revision 1.1.1.1  2001/06/08 08:09:21  kirsch
// imported alpha-version by olli 
//


#ifndef VRS_TIMEREQUIREMENT_H
#define VRS_TIMEREQUIREMENT_H

#include <vrs/time.h>

#undef min
#undef max

namespace VRS {

class VRS_CORE_API TimeRequirement {
    
public:
    TimeRequirement(bool isInfinite = false);
    TimeRequirement(
        VRSTime natural,
        VRSTime shrink,
        VRSTime stretch,
        double relativeAlignment = 0.0
        );
    void mergeMax (const TimeRequirement& tr, double k);
    void mergeMin (const TimeRequirement& tr, double k);
    bool operator==(const TimeRequirement&) const;
    
    void  setNatural(VRSTime time);
    void  setShrink(VRSTime time);
    void  setStretch(VRSTime time);
    VRSTime getNatural() const;
    VRSTime getShrink() const;
    VRSTime getStretch() const;
    
    VRSTime maximum() const;
    VRSTime minimum() const;
    
    void setAlignment(double alignment);
    double getAlignment() const;
    void  setToInfinite();
    void  setToUndefined();
    void  setToDefined();
    static const TimeRequirement infinite;
    
    bool isDefined() const;
    bool isUndefined() const;
    bool isInfinite() const;
    
    TimeRequirement operator+ (const TimeRequirement&) const;
    TimeRequirement& operator+= (const TimeRequirement&);
    TimeRequirement& operator* (double);
    TimeRequirement& operator/ (double);
    
    // persistency
    VRS_SERIALIZABLE_NO_SO_CLASS(TimeRequirement);

private:
    
    VRSTime natural_;
    VRSTime shrink_;
    VRSTime stretch_;
    double align_;
    
    enum { Infinite, Undefined, Defined };
    int state_;
};

inline VRSTime TimeRequirement::getNatural() const {
    return natural_;
}
inline VRSTime TimeRequirement::getShrink() const {
    return shrink_;
}
inline VRSTime TimeRequirement::getStretch() const {
    return stretch_;
}

inline VRSTime TimeRequirement::minimum () const {
    return VRSTime(std::max(natural_ - shrink_, 0.0));
}
inline VRSTime TimeRequirement::maximum () const {
    return natural_ + stretch_;
}

inline void TimeRequirement::setNatural(VRSTime t) {
    natural_ = t;
}
inline void TimeRequirement::setShrink(VRSTime t) {
    shrink_ = t;
}
inline void TimeRequirement::setStretch(VRSTime t) {
    stretch_ = t;
}

inline void TimeRequirement::setAlignment(double align) {
    VRS_Assertion(align>=0.0 && align<=1.0, "alignment must be in [0,1]");
    align_ = align;
}

inline double TimeRequirement::getAlignment() const { return align_; }

inline bool TimeRequirement::isDefined() const {
    return state_==Defined;
}
inline bool TimeRequirement::isUndefined() const {
    return state_==Undefined;
}
inline bool TimeRequirement::isInfinite() const {
    return state_==Infinite;
}

} // namespace VRS

#endif // VRS_TIMEREQUIREMENT_H

---

Generated on Thu May 24 06:00:16 2012 by Doxygen 1.5.6

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