attributeQuery.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_EXEC_ESF_ATTRIBUTE_QUERY_H
#define PXR_EXEC_ESF_ATTRIBUTE_QUERY_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/exec/esf/api.h"
#include "pxr/exec/esf/fixedSizePolymorphicHolder.h"
 
#include "pxr/base/ts/spline.h"
#include "pxr/base/vt/value.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/usd/usd/timeCode.h"
 
#include <optional>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class ESF_API_TYPE EsfAttributeQueryInterface :
    public EsfFixedSizePolymorphicBase
{
public:
    ESF_API ~EsfAttributeQueryInterface() override;
 
    bool IsValid() const {
        return _IsValid();
    }
 
    SdfPath GetPath() const {
        return _GetPath();
    }
 
    void Initialize() {
        _Initialize();
    }
 
    bool Get(VtValue *value, UsdTimeCode time) const {
        return _Get(value, time);
    }
 
    std::optional<TsSpline> GetSpline() const {
        return _GetSpline();
    }
 
    bool ValueSourceMightBeTimeVarying() const {
        return _ValueSourceMightBeTimeVarying();
    }
 
    bool IsTimeVarying(UsdTimeCode from, UsdTimeCode to) const {
        return _IsTimeVarying(from, to);
    }
 
protected:
    EsfAttributeQueryInterface() = default;
 
private:
    // These methods must be implemented by the scene adapter implementation.
    virtual bool _IsValid() const = 0;
    virtual SdfPath _GetPath() const = 0;
    virtual void _Initialize() = 0;
    virtual bool _Get(VtValue *value, UsdTimeCode time) const = 0;
    virtual std::optional<TsSpline> _GetSpline() const = 0;
    virtual bool _ValueSourceMightBeTimeVarying() const = 0;
    virtual bool _IsTimeVarying(UsdTimeCode from, UsdTimeCode to) const = 0;
};
 
class EsfAttributeQuery
    : public EsfFixedSizePolymorphicHolder<EsfAttributeQueryInterface, 176>
{
public:
    using EsfFixedSizePolymorphicHolder::EsfFixedSizePolymorphicHolder;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif