usd: Time-varying composing value types implementation.

(Internal change: 2393523)

Author: gitamohr

pxr/exec/esf/attributeQuery.h

@@ -119,7 +119,7 @@ class ESF_API_TYPE EsfAttributeQueryInterface :
 /// introducing Usd as a dependency.
 ///
 class EsfAttributeQuery
-    : public EsfFixedSizePolymorphicHolder<EsfAttributeQueryInterface, 160>
+    : public EsfFixedSizePolymorphicHolder<EsfAttributeQueryInterface, 168>
 {
 public:
     using EsfFixedSizePolymorphicHolder::EsfFixedSizePolymorphicHolder;

pxr/usd/usd/attribute.cpp

@@ -102,8 +102,7 @@ UsdAttribute::GetBracketingTimeSamples(double desiredTime,
                                        bool* hasTimeSamples) const
 {
     return _GetStage()->_GetBracketingTimeSamples(
-        *this, desiredTime, /*requireAuthored*/ false,
-        lower, upper, hasTimeSamples);
+        *this, desiredTime, lower, upper, hasTimeSamples);
 }
 
 bool
@@ -211,7 +210,8 @@ template <typename T>
 bool 
 UsdAttribute::_Get(T* value, UsdTimeCode time) const 
 {
-    return _GetStage()->_GetValue(time, *this, value);
+    SdfAbstractDataTypedValue<T> av(value);
+    return _GetStage()->_GetValue(time, *this, &av);
 }
 
 bool 

pxr/usd/usd/attribute.h

@@ -497,13 +497,17 @@ class UsdAttribute : public UsdProperty {
     UsdResolveInfo
     GetResolveInfo(UsdTimeCode time) const;
 
-    /// Perform value resolution to determine the source of the resolved
-    /// value of this attribute at any non-default time. 
+    /// Perform value resolution to determine the proximal source of the
+    /// resolved value of this attribute at any non-default time.
     ///
-    /// Often (i.e. unless the attribute is affected by 
-    /// \ref Usd_Page_ValueClips "Value Clips") the source of the resolved value
+    /// Often (i.e. unless the attribute is affected by \ref Usd_Page_ValueClips
+    /// "Value Clips" or the authored values are composing value types like
+    /// VtArrayEdits or SdfPathExpressions) the source of the resolved value
     /// does not vary over time. See UsdAttributeQuery as an example that takes
-    /// advantage of this quality of value resolution.
+    /// advantage of this quality of value resolution.  Call the
+    /// GetResolveInfo() overload that takes a `time` to get a more complete
+    /// picture, and see UsdResolveInfo::GetSource() for more information.
+    /// 
     USD_API
     UsdResolveInfo
     GetResolveInfo() const;

pxr/usd/usd/attributeQuery.cpp

@@ -131,6 +131,8 @@ USD_API
 bool 
 UsdAttributeQuery::_Get(T* value, UsdTimeCode time) const
 {
+    SdfAbstractDataTypedValue<T> result(value);
+    
     // If the requested time is default but the resolved value source is time
     // varying, then the stored resolve info won't give us the correct value 
     // for default time. In this case we have to get the resolve info at default
@@ -148,24 +150,46 @@ UsdAttributeQuery::_Get(T* value, UsdTimeCode time) const
                 _attr, &defaultResolveInfo, &defaultTime);
         }
         return _attr._GetStage()->_GetValueFromResolveInfo(
-            defaultResolveInfo, defaultTime, _attr, value);
+            defaultResolveInfo, defaultTime, _attr, &result);
     }
 
     return _attr._GetStage()->_GetValueFromResolveInfo(
-        _resolveInfo, time, _attr, value);
+        _resolveInfo, time, _attr, &result, _resolveTarget.get());
 }
 
 bool 
 UsdAttributeQuery::Get(VtValue* value, UsdTimeCode time) const
 {
-    return _Get(value, time);
+    // If the requested time is default but the resolved value source is time
+    // varying, then the stored resolve info won't give us the correct value 
+    // for default time. In this case we have to get the resolve info at default
+    // time and query the value from that.
+    if (time.IsDefault() && 
+            _resolveInfo.ValueSourceMightBeTimeVarying()) {
+
+        static const UsdTimeCode defaultTime = UsdTimeCode::Default();
+        UsdResolveInfo defaultResolveInfo;
+        if (_resolveTarget && TF_VERIFY(!_resolveTarget->IsNull())) {
+            _attr._GetStage()->_GetResolveInfoWithResolveTarget(
+                _attr, *_resolveTarget, &defaultResolveInfo, &defaultTime);
+        } else {
+            _attr._GetStage()->_GetResolveInfo(
+                _attr, &defaultResolveInfo, &defaultTime);
+        }
+        return _attr._GetStage()->_GetValueFromResolveInfo(
+            defaultResolveInfo, defaultTime, _attr, value);
+    }
+
+    return _attr._GetStage()->_GetValueFromResolveInfo(
+        _resolveInfo, time, _attr, value, _resolveTarget.get());
 }
 
 bool 
 UsdAttributeQuery::GetTimeSamples(std::vector<double>* times) const
 {
-    return _attr._GetStage()->_GetTimeSamplesInIntervalFromResolveInfo(
-        _resolveInfo, _attr, GfInterval::GetFullInterval(), times);
+    return _attr._GetStage()->_GetTimeSamplesInInterval(
+        _attr, GfInterval::GetFullInterval(), times,
+        &_resolveInfo, _resolveTarget.get());
 }
 
 TsSpline
@@ -194,8 +218,9 @@ bool
 UsdAttributeQuery::GetTimeSamplesInInterval(const GfInterval& interval,
                                             std::vector<double>* times) const
 {
-    return _attr._GetStage()->_GetTimeSamplesInIntervalFromResolveInfo(
-        _resolveInfo, _attr, interval, times);
+    return _attr._GetStage()->
+        _GetTimeSamplesInInterval(_attr, interval, times,
+                                  &_resolveInfo, _resolveTarget.get());
 }
 
 /* static */
@@ -237,9 +262,9 @@ UsdAttributeQuery::GetUnionedTimeSamplesInInterval(
 
         // This will work even if the attributes belong to different 
         // USD stages.
-        success = attr.GetStage()->_GetTimeSamplesInIntervalFromResolveInfo(
-                attrQuery._resolveInfo, attr, interval, &attrSampleTimes) 
-                && success;
+        success = attr.GetStage()->_GetTimeSamplesInInterval(
+            attr, interval, &attrSampleTimes, &attrQuery._resolveInfo,
+            attrQuery._resolveTarget.get()) && success;
 
         // Merge attrSamplesTimes into the times vector.
         Usd_MergeTimeSamples(times, attrSampleTimes, &tempUnionSampleTimes);
@@ -251,8 +276,8 @@ UsdAttributeQuery::GetUnionedTimeSamplesInInterval(
 size_t
 UsdAttributeQuery::GetNumTimeSamples() const
 {
-    return _attr._GetStage()->_GetNumTimeSamplesFromResolveInfo(
-        _resolveInfo, _attr);
+    return _attr._GetStage()->_GetNumTimeSamples(
+        _attr, &_resolveInfo, _resolveTarget.get());
 }
 
 bool 
@@ -261,9 +286,9 @@ UsdAttributeQuery::GetBracketingTimeSamples(double desiredTime,
                                             double* upper, 
                                             bool* hasTimeSamples) const
 {
-    return _attr._GetStage()->_GetBracketingTimeSamplesFromResolveInfo(
-        _resolveInfo, _attr, desiredTime, /* authoredOnly */ false,
-        lower, upper, hasTimeSamples);
+    return _attr._GetStage()->_GetBracketingTimeSamples(
+        _attr, desiredTime, lower, upper, hasTimeSamples,
+        &_resolveInfo, _resolveTarget.get());
 }
 
 bool 
@@ -305,8 +330,8 @@ UsdAttributeQuery::GetFallbackValue(VtValue* value) const
 bool 
 UsdAttributeQuery::ValueMightBeTimeVarying() const
 {
-    return _attr._GetStage()->_ValueMightBeTimeVaryingFromResolveInfo(
-        _resolveInfo, _attr);
+    return _attr._GetStage()->
+        _ValueMightBeTimeVaryingFromResolveInfo(_resolveInfo, _attr);
 }
 
 ARCH_PRAGMA_PUSH

pxr/usd/usd/clip.cpp

@@ -26,6 +26,8 @@
 #include "pxr/base/gf/interval.h"
 #include "pxr/base/tf/preprocessorUtilsLite.h"
 #include "pxr/base/tf/stringUtils.h"
+#include "pxr/base/vt/array.h"
+#include "pxr/base/vt/arrayEdit.h"
 
 #include <optional>
 #include <ostream>
@@ -809,6 +811,18 @@ _ConvertValueForTime(const Usd_Clip::ExternalTime &extTime,
     }
 }
 
+// Similarly we convert arrayEdits of SdfTimeCodes.
+inline
+void
+_ConvertValueForTime(const Usd_Clip::ExternalTime &extTime, 
+                     const Usd_Clip::InternalTime &intTime,
+                     VtArrayEdit<SdfTimeCode> *value)
+{
+    for (SdfTimeCode &tc: value->GetMutableLiterals()) {
+        _ConvertValueForTime(extTime, intTime, &tc);
+    }
+}
+
 // Helpers for accessing the typed value from type erased values, needed for
 // converting SdfTimeCodes.
 template <class T>
@@ -854,6 +868,11 @@ _ConvertTypeErasedValueForTime(const Usd_Clip::ExternalTime &extTime,
         _UncheckedSwap(value, rawVal);
         _ConvertValueForTime(extTime, intTime, &rawVal);
         _UncheckedSwap(value, rawVal);
+    } else if (_IsHolding<VtArrayEdit<SdfTimeCode>>(*value)) {
+        VtArrayEdit<SdfTimeCode> rawVal;
+        _UncheckedSwap(value, rawVal);
+        _ConvertValueForTime(extTime, intTime, &rawVal);
+        _UncheckedSwap(value, rawVal);
     }
 }
 
@@ -887,28 +906,44 @@ template <class T>
 static bool
 _Interpolate(
     const SdfLayerRefPtr& clip, const SdfPath &clipPath,
-    Usd_Clip::InternalTime clipTime, Usd_InterpolatorBase* interpolator,
+    Usd_Clip::InternalTime clipTime, Usd_Interpolator const & interpolator,
     T* value)
 {
     double lowerInClip, upperInClip;
     if (clip->GetBracketingTimeSamplesForPath(
             clipPath, clipTime, &lowerInClip, &upperInClip)) {
-            
-        return Usd_GetOrInterpolateValue(
-            clip, clipPath, clipTime, lowerInClip, upperInClip,
-            interpolator, value);
+
+        Usd_InterpolationSampleSeries samples;
+        if (interpolator.GetInterpolatingSamples(
+                clip, clipPath, clipTime,
+                lowerInClip, upperInClip, &samples)) {
+            Usd_Interpolate(&samples, clipTime);
+            Usd_SetValue(value, samples[0].value);
+            return true;
+        }
+        return false;
     }
 
     return false;
 }
 
 }; // End anonymous namespace
 
+const std::type_info &
+Usd_Clip::QueryTimeSampleTypeid(const SdfPath &path, UsdTimeCode time) const
+{
+    const SdfPath clipPath = _TranslatePathToClip(path);
+    const InternalTime clipTime = _TranslateTimeToInternal(time);
+    const SdfLayerRefPtr& clip = _GetLayerForClip();
+
+    return clip->QueryTimeSampleTypeid(clipPath, clipTime);
+}
+
 template <class T>
 bool 
 Usd_Clip::QueryTimeSample(
     const SdfPath& path, UsdTimeCode time, 
-    Usd_InterpolatorBase* interpolator, T* value) const
+    Usd_Interpolator const & interpolator, T* value) const
 {
     const SdfPath clipPath = _TranslatePathToClip(path);
     const InternalTime clipTime = _TranslateTimeToInternal(time);
@@ -929,24 +964,24 @@ Usd_Clip::QueryTimeSample(
 #define _INSTANTIATE_QUERY_TIME_SAMPLE(unused, elem)            \
     template bool Usd_Clip::QueryTimeSample(                    \
         const SdfPath&, UsdTimeCode,                            \
-        Usd_InterpolatorBase*,                                  \
+        Usd_Interpolator const &,                               \
         SDF_VALUE_CPP_TYPE(elem)*) const;                       \
     template bool Usd_Clip::QueryTimeSample(                    \
         const SdfPath&, UsdTimeCode,                            \
-        Usd_InterpolatorBase*,                                  \
+        Usd_Interpolator const &,                               \
         SDF_VALUE_CPP_ARRAY_TYPE(elem)*) const;
 
 TF_PP_SEQ_FOR_EACH(_INSTANTIATE_QUERY_TIME_SAMPLE, ~, SDF_VALUE_TYPES)
 #undef _INSTANTIATE_QUERY_TIME_SAMPLE
 
 template bool Usd_Clip::QueryTimeSample(
     const SdfPath&, UsdTimeCode,
-    Usd_InterpolatorBase*,
+    Usd_Interpolator const &,
     SdfAbstractDataValue*) const;
 
 template bool Usd_Clip::QueryTimeSample(
     const SdfPath&, UsdTimeCode,
-    Usd_InterpolatorBase*,
+    Usd_Interpolator const &,
     VtValue*) const;
 
 PXR_NAMESPACE_CLOSE_SCOPE

pxr/usd/usd/clip.h

@@ -24,7 +24,7 @@ PXR_NAMESPACE_OPEN_SCOPE
 
 TF_DECLARE_WEAK_PTRS(PcpLayerStack);
 
-class Usd_InterpolatorBase;
+class Usd_Interpolator;
 class UsdTimeCode;
 
 /// Returns true if the given scene description metadata \p fieldName is
@@ -151,7 +151,12 @@ struct Usd_Clip
     template <class T>
     bool QueryTimeSample(
         const SdfPath& path, UsdTimeCode time, 
-        Usd_InterpolatorBase* interpolator, T* value) const;
+        Usd_Interpolator const &interpolator, T* value) const;
+
+    /// If there is a time sample for \p path at \p time, return its value's
+    /// typeid(), otherwise return typeid(void).
+    const std::type_info &QueryTimeSampleTypeid(
+        const SdfPath &path, UsdTimeCode time) const;
 
     /// Return true if this clip has authored time samples for the attribute
     /// corresponding to the given \p path. Clips may add time sample times

pxr/usd/usd/clipSet.cpp

@@ -478,7 +478,7 @@ Usd_ClipSet::_ClipContributesValue(
     }
 
     // Use the clip if a default value specified in the manifest.
-    if (Usd_HasDefault<int>(manifestClip, path, nullptr) 
+    if (Usd_HasDefault<VtValue>(manifestClip, path, nullptr) 
             != Usd_DefaultValueResult::None) {
         return true;
     }
@@ -707,6 +707,24 @@ Usd_ClipSet::GetTimeSamplesInInterval(
     return timeSamples;
 }
 
+const std::type_info &
+Usd_ClipSet::QueryTimeSampleTypeid(const SdfPath &path, UsdTimeCode time) const
+{
+    const Usd_ClipRefPtr& clip = 
+        GetActiveClip(time, false /*timeHasJumpDiscontinuity*/);
+
+    // First query the clip for time sample typeid at the specified time.
+    const std::type_info &type = clip->QueryTimeSampleTypeid(path, time);
+    if (type != typeid(void)) {
+        return type;
+    }
+
+    // If no value exists in the clip, get the default value from the manifest.
+    const std::type_info *typePtr = &typeid(void);
+    Usd_HasDefault<VtValue>(manifestClip, path, nullptr, &typePtr);
+    return *typePtr;
+}
+
 size_t
 Usd_ClipSet::_FindClipIndexForTime(double time) const
 {

pxr/usd/usd/clipSet.h

@@ -135,7 +135,12 @@ class Usd_ClipSet
     template <class T>
     bool QueryTimeSample(
         const SdfPath& path, UsdTimeCode time, 
-        Usd_InterpolatorBase* interpolator, T* value) const;
+        Usd_Interpolator const &interpolator, T* value) const;
+
+    /// If there is a time sample for \p path at \p time, return its value's
+    /// typeid(), otherwise return typeid(void).
+    const std::type_info &QueryTimeSampleTypeid(
+        const SdfPath& path, UsdTimeCode time) const;
 
     /// Query time samples for an attribute at \p path at pre-time \p time if
     /// samples represent a jump discontinuity.
@@ -146,7 +151,7 @@ class Usd_ClipSet
     template <class T>
     bool QueryPreTimeSampleWithJumpDiscontinuity(
         const SdfPath& path, UsdTimeCode time, 
-        Usd_InterpolatorBase* interpolator, T* value) const;
+        Usd_Interpolator const &interpolator, T* value) const;
 
     std::string name;
     PcpLayerStackPtr sourceLayerStack;
@@ -186,7 +191,7 @@ template <class T>
 inline bool
 Usd_ClipSet::QueryTimeSample(
     const SdfPath& path, UsdTimeCode time, 
-    Usd_InterpolatorBase* interpolator, T* value) const
+    Usd_Interpolator const &interpolator, T* value) const
 {
     const Usd_ClipRefPtr& clip = 
         GetActiveClip(time, false /*timeHasJumpDiscontinuity*/);
@@ -207,7 +212,7 @@ template <class T>
 inline bool
 Usd_ClipSet::QueryPreTimeSampleWithJumpDiscontinuity(
     const SdfPath& path, UsdTimeCode time,
-    Usd_InterpolatorBase* interpolator, T* value) const
+    Usd_Interpolator const &interpolator, T* value) const
 {
     if (!time.IsPreTime()) {
         return false;
@@ -234,7 +239,7 @@ template <class T>
 inline bool
 Usd_QueryTimeSample(
     const Usd_ClipSetRefPtr& clipSet, const SdfPath& path,
-    double time, Usd_InterpolatorBase* interpolator, T* result)
+    double time, Usd_Interpolator const &interpolator, T* result)
 {
     return clipSet->QueryTimeSample(path, time, interpolator, result);
 }