timeCode.h

Go to the documentation of this file.

//
// Copyright 2026 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_GF_TIME_CODE_H
#define PXR_BASE_GF_TIME_CODE_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/gf/api.h"
#include "pxr/base/gf/duration.h"
 
#include <algorithm>
#include <functional>
#include <iosfwd>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class GfTimeCode
{
public:
 
    constexpr GfTimeCode(double time = 0.0) noexcept
    : _time(time)
    {};
 
    explicit constexpr GfTimeCode(GfDuration duration) noexcept
    : GfTimeCode(duration.GetValue())
    {}
 
 
 
    constexpr bool operator==(const GfTimeCode &rhs) const noexcept
        { return _time == rhs._time; }
    constexpr bool operator!=(const GfTimeCode &rhs) const noexcept
        { return _time != rhs._time; }
    constexpr bool operator<(const GfTimeCode &rhs) const noexcept
        { return _time < rhs._time; }
    constexpr bool operator>(const GfTimeCode &rhs) const noexcept
        { return _time > rhs._time; }
    constexpr bool operator<=(const GfTimeCode &rhs) const noexcept
        { return _time <= rhs._time; }
    constexpr bool operator>=(const GfTimeCode &rhs) const noexcept
        { return _time >= rhs._time; }
 
    friend constexpr
    GfTimeCode operator*(const GfTimeCode& t,
                         const double amount) noexcept
        { return GfTimeCode(t._time * amount); }
    friend constexpr
    GfTimeCode operator*(const double amount,
                         const GfTimeCode& t) noexcept
        { return GfTimeCode(amount * t._time); }
    friend constexpr
    GfTimeCode operator/(const GfTimeCode& t,
                         const double amount) noexcept
        { return GfTimeCode(t._time / amount); }
 
    constexpr double operator/(const GfTimeCode &rhs) const noexcept
        { return _time / rhs._time; }
 
    friend constexpr
    GfTimeCode operator+(const GfTimeCode& lhs,
                         const GfTimeCode& rhs) noexcept
        { return GfTimeCode(lhs._time + rhs._time); }
 
    constexpr GfDuration operator-(const GfTimeCode &rhs) const noexcept
        { return GfDuration(_time - rhs._time); }
 
    friend constexpr
    GfTimeCode operator+(const GfTimeCode& lhs,
                         const GfDuration& rhs) noexcept
        { return GfTimeCode(lhs._time + rhs.GetValue()); }
    friend constexpr
    GfTimeCode operator+(const GfDuration& lhs,
                         const GfTimeCode& rhs) noexcept
        { return GfTimeCode(lhs.GetValue() + rhs._time); }
    friend constexpr
    GfTimeCode operator+(const GfTimeCode& lhs,
                         const double rhs) noexcept
        { return GfTimeCode(lhs._time + rhs); }
    friend constexpr
    GfTimeCode operator+(const double lhs,
                         const GfTimeCode& rhs) noexcept
        { return GfTimeCode(lhs + rhs._time); }
 
    friend constexpr
    GfTimeCode operator-(const GfTimeCode& lhs,
                         const GfDuration& rhs) noexcept
        { return GfTimeCode(lhs._time - rhs.GetValue()); }
    friend constexpr
    GfTimeCode operator-(const GfDuration& lhs,
                         const GfTimeCode& rhs) noexcept
        { return GfTimeCode(lhs.GetValue() - rhs._time); }
    friend constexpr
    GfTimeCode operator-(const GfTimeCode& lhs,
                         const double rhs) noexcept
        { return GfTimeCode(lhs._time - rhs); }
    friend constexpr
    GfTimeCode operator-(const double lhs,
                         const GfTimeCode& rhs) noexcept
        { return GfTimeCode(lhs - rhs._time); }
 
    constexpr GfTimeCode operator-() const noexcept
        { return GfTimeCode(-_time); }
 
    explicit constexpr operator double() const noexcept {return _time;}
 
    explicit constexpr operator GfDuration() const noexcept
    {
        return GfDuration(_time);
    }
 
    size_t GetHash() const {
        return std::hash<double>()(_time);
    }
 
    struct Hash
    {
        size_t operator()(const GfTimeCode &ap) const {
            return ap.GetHash();
        }
    };
 
    friend size_t hash_value(const GfTimeCode &ap) { return ap.GetHash(); }
 
    template <class HashState>
    friend void TfHashAppend(HashState &h, const GfTimeCode& t)
    {
        // Delegate to TfHashAppend(HashState, double)
        TfHashAppend(h, t._time);
    }
 
 
 
    constexpr double GetValue() const noexcept {
        return _time;
    }
 
 
private:
    friend inline void swap(GfTimeCode &lhs, GfTimeCode &rhs) {
        std::swap(lhs._time, rhs._time);
    }
 
    double _time;
};
 
inline constexpr
bool operator==(double time, const GfTimeCode &timeCode) noexcept
    { return GfTimeCode(time) == timeCode; }
 
inline constexpr
bool operator!=(double time, const GfTimeCode &timeCode) noexcept
    { return GfTimeCode(time) != timeCode; }
 
inline constexpr
bool operator<(double time, const GfTimeCode &timeCode) noexcept
    { return GfTimeCode(time) < timeCode; }
 
inline constexpr
bool operator>(double time, const GfTimeCode &timeCode) noexcept
    { return GfTimeCode(time) > timeCode; }
 
inline constexpr
bool operator<=(double time, const GfTimeCode &timeCode) noexcept
    { return GfTimeCode(time) <= timeCode; }
 
inline constexpr
bool operator>=(double time, const GfTimeCode &timeCode) noexcept
    { return GfTimeCode(time) >= timeCode; }
 
GF_API std::ostream& operator<<(std::ostream& out, const GfTimeCode& ap);
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_GF_TIME_CODE_H