usdPrimInfoSchema.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_USD_IMAGING_USD_IMAGING_USD_PRIM_INFO_SCHEMA_H
#define PXR_USD_IMAGING_USD_IMAGING_USD_PRIM_INFO_SCHEMA_H


#include "pxr/usdImaging/usdImaging/api.h"
#include "pxr/imaging/hd/schemaTypeDefs.h"

#include "pxr/imaging/hd/schema.h"

// --(BEGIN CUSTOM CODE: Includes)--
// --(END CUSTOM CODE: Includes)--

PXR_NAMESPACE_OPEN_SCOPE

// --(BEGIN CUSTOM CODE: Declares)--
using HdTokenDataSourceContainerSchema =
    HdContainerOfTypedSampledDataSourcesSchema<HdTokenDataSource>;
// --(END CUSTOM CODE: Declares)--

#define USD_IMAGING_USD_PRIM_INFO_SCHEMA_TOKENS \
    (__usdPrimInfo) \
    (specifier) \
    (typeName) \
    (isLoaded) \
    (apiSchemas) \
    (kind) \
    (variantSelections) \
    (niPrototypePath) \
    (isNiPrototype) \
    (piPropagatedPrototypes) \
    (def) \
    (over) \
    ((class_, "class")) \

TF_DECLARE_PUBLIC_TOKENS(UsdImagingUsdPrimInfoSchemaTokens, USDIMAGING_API,
    USD_IMAGING_USD_PRIM_INFO_SCHEMA_TOKENS);

//-----------------------------------------------------------------------------


class UsdImagingUsdPrimInfoSchema : public HdSchema
{
public:

    UsdImagingUsdPrimInfoSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}

    USDIMAGING_API
    static UsdImagingUsdPrimInfoSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);


// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--


    USDIMAGING_API
    HdTokenDataSourceHandle GetSpecifier() const;

    USDIMAGING_API
    HdTokenDataSourceHandle GetTypeName() const;

    USDIMAGING_API
    HdBoolDataSourceHandle GetIsLoaded() const;

    USDIMAGING_API
    HdTokenArrayDataSourceHandle GetApiSchemas() const;

    USDIMAGING_API
    HdTokenDataSourceHandle GetKind() const;

    USDIMAGING_API
    HdTokenDataSourceContainerSchema GetVariantSelections() const;

    USDIMAGING_API
    HdPathDataSourceHandle GetNiPrototypePath() const;

    USDIMAGING_API
    HdBoolDataSourceHandle GetIsNiPrototype() const;

    USDIMAGING_API
    HdContainerDataSourceHandle GetPiPropagatedPrototypes() const; 



    USDIMAGING_API
    static const TfToken &GetSchemaToken();

    USDIMAGING_API
    static const HdDataSourceLocator &GetDefaultLocator();



    USDIMAGING_API
    static const HdDataSourceLocator &GetNiPrototypePathLocator();


    USDIMAGING_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdTokenDataSourceHandle &specifier,
        const HdTokenDataSourceHandle &typeName,
        const HdBoolDataSourceHandle &isLoaded,
        const HdTokenArrayDataSourceHandle &apiSchemas,
        const HdTokenDataSourceHandle &kind,
        const HdContainerDataSourceHandle &variantSelections,
        const HdPathDataSourceHandle &niPrototypePath,
        const HdBoolDataSourceHandle &isNiPrototype,
        const HdContainerDataSourceHandle &piPropagatedPrototypes
    );

    class Builder
    {
    public:
        USDIMAGING_API
        Builder &SetSpecifier(
            const HdTokenDataSourceHandle &specifier);
        USDIMAGING_API
        Builder &SetTypeName(
            const HdTokenDataSourceHandle &typeName);
        USDIMAGING_API
        Builder &SetIsLoaded(
            const HdBoolDataSourceHandle &isLoaded);
        USDIMAGING_API
        Builder &SetApiSchemas(
            const HdTokenArrayDataSourceHandle &apiSchemas);
        USDIMAGING_API
        Builder &SetKind(
            const HdTokenDataSourceHandle &kind);
        USDIMAGING_API
        Builder &SetVariantSelections(
            const HdContainerDataSourceHandle &variantSelections);
        USDIMAGING_API
        Builder &SetNiPrototypePath(
            const HdPathDataSourceHandle &niPrototypePath);
        USDIMAGING_API
        Builder &SetIsNiPrototype(
            const HdBoolDataSourceHandle &isNiPrototype);
        USDIMAGING_API
        Builder &SetPiPropagatedPrototypes(
            const HdContainerDataSourceHandle &piPropagatedPrototypes);

        USDIMAGING_API
        HdContainerDataSourceHandle Build();

    private:
        HdTokenDataSourceHandle _specifier;
        HdTokenDataSourceHandle _typeName;
        HdBoolDataSourceHandle _isLoaded;
        HdTokenArrayDataSourceHandle _apiSchemas;
        HdTokenDataSourceHandle _kind;
        HdContainerDataSourceHandle _variantSelections;
        HdPathDataSourceHandle _niPrototypePath;
        HdBoolDataSourceHandle _isNiPrototype;
        HdContainerDataSourceHandle _piPropagatedPrototypes;

    };

    USDIMAGING_API
    static HdTokenDataSourceHandle BuildSpecifierDataSource(
        const TfToken &specifier);

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif