attribute.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_H
#define PXR_EXEC_ESF_ATTRIBUTE_H

/// \file

#include "pxr/pxr.h"

#include "pxr/exec/esf/api.h"
#include "pxr/exec/esf/attributeQuery.h"
#include "pxr/exec/esf/fixedSizePolymorphicHolder.h"
#include "pxr/exec/esf/property.h"

#include "pxr/usd/sdf/path.h"
#include "pxr/usd/sdf/valueTypeName.h"

PXR_NAMESPACE_OPEN_SCOPE

class EsfJournal;

/// Attribute abstraction for scene adapter implementations.
///
/// The attribute abstraction closely resembles the read-only interface of
/// UsdAttribute. 
///
/// The public methods of this class are called by the exec network compiler.
/// Each method takes an argument of type EsfJournal* which captures the
/// conditions for recompilation.
///
class ESF_API_TYPE EsfAttributeInterface : public EsfPropertyInterface
{
public:
    ESF_API ~EsfAttributeInterface() override;

    /// \see UsdAttribute::GetValueTypeName
    ESF_API SdfValueTypeName GetValueTypeName(EsfJournal *journal) const;

    /// Returns an object for caching and querying value resolution information.
    /// \see UsdAttributeQuery
    /// 
    ESF_API EsfAttributeQuery GetQuery() const;

    /// \see UsdAttribute::GetConnections
    ESF_API SdfPathVector GetConnections(EsfJournal *journal) const;

protected:
    /// This constructor may only be called by the scene adapter implementation.
    EsfAttributeInterface(const SdfPath &path) : EsfPropertyInterface(path) {}

private:
    // These methods must be implemented by the scene adapter implementation.
    virtual SdfValueTypeName _GetValueTypeName() const = 0;
    virtual EsfAttributeQuery _GetQuery() const = 0;
    virtual SdfPathVector _GetConnections() const = 0;
};

/// Holds an implementation of EsfAttributeInterface in a fixed-size buffer.
///
/// The buffer is large enough to fit an implementation that wraps a
/// UsdAttribute. The size is specified as an integer literal to prevent
/// introducing Usd as a dependency.
///
class EsfAttribute
    : public EsfFixedSizePolymorphicHolder<EsfAttributeInterface, 48>
{
public:
    using EsfFixedSizePolymorphicHolder::EsfFixedSizePolymorphicHolder;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif