systemSchema.h

Go to the documentation of this file.

//
// Copyright 2023 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
 
/* ************************************************************************** */
/* **                                                                      ** */
/* ** This file is generated by a script.                                  ** */
/* **                                                                      ** */
/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
/* ** Edit hdSchemaDefs.py instead to make changes.                        ** */
/* **                                                                      ** */
/* ************************************************************************** */
 
#ifndef PXR_IMAGING_HDAR_SYSTEM_SCHEMA_H
#define PXR_IMAGING_HDAR_SYSTEM_SCHEMA_H
 
 
#include "pxr/imaging/hdar/api.h"
 
#include "pxr/imaging/hd/schema.h"
 
// --(BEGIN CUSTOM CODE: Includes)--
#include "pxr/base/tf/declarePtrs.h"
// --(END CUSTOM CODE: Includes)--
 
PXR_NAMESPACE_OPEN_SCOPE
 
// --(BEGIN CUSTOM CODE: Declares)--
TF_DECLARE_REF_PTRS(HdSceneIndexBase);
// --(END CUSTOM CODE: Declares)--
 
#define HDAR_SYSTEM_SCHEMA_TOKENS \
    (assetResolution) \
    (resolverContext) \
 
TF_DECLARE_PUBLIC_TOKENS(HdarSystemSchemaTokens, HDAR_API,
    HDAR_SYSTEM_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
// The HdarSystemSchema specifies a container that will hold "system" data
// that is relevant to asset resolution.
//
 
class HdarSystemSchema : public HdSchema
{
public:
 
    HdarSystemSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    HDAR_API
    static HdarSystemSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
 
    HDAR_API
    static HdContainerDataSourceHandle GetFromPath(
            HdSceneIndexBaseRefPtr const &inputScene,
            SdfPath const &fromPath,
            SdfPath *foundAtPath);
 
// --(END CUSTOM CODE: Schema Methods)--
 
 
    HDAR_API
    HdResolverContextDataSourceHandle GetResolverContext() const; 
 
 
 
    HDAR_API
    static const TfToken &GetSchemaToken();
 
    HDAR_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
 
    HDAR_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdResolverContextDataSourceHandle &resolverContext
    );
 
    class Builder
    {
    public:
        HDAR_API
        Builder &SetResolverContext(
            const HdResolverContextDataSourceHandle &resolverContext);
 
        HDAR_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdResolverContextDataSourceHandle _resolverContext;
 
    };
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif