object.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_OBJECT_H
#define PXR_EXEC_ESF_OBJECT_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/exec/esf/api.h"
#include "pxr/exec/esf/fixedSizePolymorphicHolder.h"
#include "pxr/exec/esf/schemaConfigKey.h"
#include "pxr/exec/esf/stage.h"
 
#include "pxr/usd/sdf/path.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class EsfAttribute;
class EsfJournal;
class EsfObject;
class EsfPrim;
class EsfRelationship;
class TfToken;
class TfType;
class VtValue;
 
class ESF_API_TYPE EsfObjectInterface : public EsfFixedSizePolymorphicBase
{
public:
    ESF_API ~EsfObjectInterface() override;
 
    ESF_API bool IsValid(EsfJournal *journal) const;
 
    ESF_API SdfPath GetPath(EsfJournal *journal) const;
 
    ESF_API TfToken GetName(EsfJournal *journal) const;
 
    ESF_API EsfPrim GetPrim(EsfJournal *journal) const;
 
    ESF_API SdfPathVector GetIncomingConnections(EsfJournal *journal) const;
 
    EsfStage GetStage() const {
        return _GetStage();
    }
 
    ESF_API EsfSchemaConfigKey GetSchemaConfigKey(EsfJournal *journal) const;
 
 
    ESF_API VtValue GetMetadata(const TfToken &key) const;
 
    ESF_API bool IsValidMetadataKey(const TfToken &key) const;
 
    ESF_API TfType GetMetadataValueType(const TfToken &key) const;
 
 
    virtual bool IsPrim() const = 0;
 
    virtual bool IsAttribute() const = 0;
 
    virtual bool IsRelationship() const = 0;
 
    virtual EsfObject AsObject() const = 0;
 
    virtual EsfAttribute AsAttribute() const = 0;
 
    virtual EsfRelationship AsRelationship() const = 0;
 
    virtual EsfPrim AsPrim() const = 0;
 
protected:
    EsfObjectInterface(const SdfPath &path) : _path(path) {}
 
    const SdfPath &_GetPath() const { return _path; }
 
    virtual EsfStage _GetStage() const = 0;
 
    static EsfSchemaConfigKey CreateSchemaConfigKey(const void *const id) {
        return EsfSchemaConfigKey(id);
    }
 
private:
    // Object path that will be added to EsfJournals.
    SdfPath _path;
 
    // These methods must be implemented by the scene adapter implementation.
    virtual bool _IsValid() const = 0;
    virtual TfToken _GetName() const = 0;
    virtual EsfPrim _GetPrim() const = 0;
    virtual SdfPathVector _GetIncomingConnections() const = 0;
    virtual EsfSchemaConfigKey _GetSchemaConfigKey() const = 0;
    virtual VtValue _GetMetadata(const TfToken &key) const = 0;
    virtual bool _IsValidMetadataKey(const TfToken &key) const = 0;
    virtual TfType _GetMetadataValueType(const TfToken &key) const = 0;
};
 
class EsfObject : public EsfFixedSizePolymorphicHolder<EsfObjectInterface, 48>
{
public:
    using EsfFixedSizePolymorphicHolder::EsfFixedSizePolymorphicHolder;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif