layerOffset.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_USD_SDF_LAYER_OFFSET_H
#define PXR_USD_SDF_LAYER_OFFSET_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/base/gf/timeCode.h"
 
#include <iosfwd>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class SdfLayerOffset
{
public:
 
    explicit SdfLayerOffset(double offset = 0.0, double scale = 1.0)
        : _offset(offset), _scale(scale) {}
 
 
 
    double GetOffset() const { return _offset; }
    
    double GetScale() const { return _scale; }
 
    void SetOffset(double newOffset) { _offset = newOffset; }
    
    void SetScale(double newScale) { _scale = newScale; }
 
    bool IsIdentity() const {
        // Check for the common case of exact identity.
        if (_offset == 0.0 && _scale == 1.0) {
            return true;
        }
        return *this == SdfLayerOffset {};
    }
 
    SDF_API
    bool IsValid() const;
 
    SDF_API
    SdfLayerOffset GetInverse() const;
 
 
    SDF_API
    size_t GetHash() const;
 
    struct Hash {
        size_t operator()(const SdfLayerOffset &offset) const {
            return offset.GetHash();
        }
    };
 
    friend inline size_t hash_value(const SdfLayerOffset &offset) {
        return offset.GetHash();
    }
 
 
 
    SDF_API
    bool operator==(const SdfLayerOffset &rhs) const;
 
    bool operator!=(const SdfLayerOffset &rhs) const {
        return !(*this == rhs);
    }
 
    SDF_API
    bool operator<(const SdfLayerOffset &rhs) const;
 
    bool operator>(const SdfLayerOffset& rhs) const {
        return rhs < *this;
    }
 
    bool operator>=(const SdfLayerOffset& rhs) const {
        return !(*this < rhs);
    }
 
    bool operator<=(const SdfLayerOffset& rhs) const {
        return !(*this > rhs);
    }
 
    SDF_API
    SdfLayerOffset operator*(const SdfLayerOffset &rhs) const;
 
    SDF_API
    double operator*(double rhs) const;
 
    SDF_API
    GfTimeCode operator*(const GfTimeCode &rhs) const;
 
 
private:
    double _offset;
    double _scale;
};
 
typedef std::vector<SdfLayerOffset> SdfLayerOffsetVector;
 
SDF_API
std::ostream & operator<<( std::ostream &out,
                           const SdfLayerOffset &layerOffset );
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDF_LAYER_OFFSET_H