multiInterval.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_GF_MULTI_INTERVAL_H
#define PXR_BASE_GF_MULTI_INTERVAL_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/gf/interval.h"
#include "pxr/base/gf/api.h"
 
#include <iosfwd>
#include <set>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class GfMultiInterval
{
public:
    typedef std::set<GfInterval> Set;
    typedef Set::const_iterator const_iterator;
    typedef Set::const_iterator iterator;
 
    GfMultiInterval() = default;
    GF_API explicit GfMultiInterval(const GfInterval &i);
    GF_API explicit GfMultiInterval(const std::vector<GfInterval> &intervals);
 
    GF_API bool operator==(const GfMultiInterval &that) const { return _set == that._set; }
    GF_API bool operator!=(const GfMultiInterval &that) const { return !(*this == that); }
    GF_API bool operator<(const GfMultiInterval &that) const { return _set < that._set; }
    GF_API bool operator>=(const GfMultiInterval &that) const { return !(*this < that); }
    GF_API bool operator>(const GfMultiInterval &that) const { return (that < *this); }
    GF_API bool operator<=(const GfMultiInterval &that) const { return !(that < *this); }
    
 
    GF_API size_t Hash() const;
 
    friend inline size_t hash_value(const GfMultiInterval &mi) {
        return mi.Hash();
    }
 
 
    GF_API bool IsEmpty() const { return _set.empty(); }
 
    GF_API size_t GetSize() const { return _set.size(); }
 
    GF_API GfInterval GetBounds() const;
 
    GF_API bool Contains(double d) const;
 
    GF_API bool Contains(const GfInterval & i) const;
 
    GF_API bool Contains(const GfMultiInterval & s) const;
 
 
 
    GF_API void Clear() { _set.clear(); }
 
    GF_API void Add( const GfInterval & i );
    GF_API void Add( const GfMultiInterval &s );
 
    GF_API void ArithmeticAdd( const GfInterval &i );
 
    GF_API void Remove( const GfInterval & i );
    GF_API void Remove( const GfMultiInterval &s );
 
    GF_API void Intersect( const GfInterval & i );
    GF_API void Intersect( const GfMultiInterval &s );
 
    GF_API GfMultiInterval GetComplement() const;
 
 
 
    GF_API const_iterator begin() const { return _set.begin(); }
    GF_API const_iterator end() const { return _set.end(); }
 
    GF_API const_iterator lower_bound( double x ) const;
 
    GF_API const_iterator upper_bound( double x ) const;
 
    GF_API const_iterator GetNextNonContainingInterval( double x ) const;
 
    GF_API const_iterator GetPriorNonContainingInterval( double x ) const;
 
    GF_API const_iterator GetContainingInterval( double x ) const;
 
 
    static GfMultiInterval GetFullInterval() {
        return GfMultiInterval(GfInterval::GetFullInterval());
    }
 
    void swap(GfMultiInterval &other) { _set.swap(other._set); }
 
private:
    void _AssertInvariants() const;
 
    Set _set;
};
 
GF_API std::ostream & operator<<(std::ostream &out, const GfMultiInterval &s);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_MULTI_INTERVAL_H