modelSchema.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_MODEL_SCHEMA_H
#define PXR_USD_IMAGING_USD_IMAGING_MODEL_SCHEMA_H


#include "pxr/usdImaging/usdImaging/api.h"

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

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

PXR_NAMESPACE_OPEN_SCOPE

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

#define USD_IMAGING_MODEL_SCHEMA_TOKENS \
    (model) \
    (modelPath) \
    (assetIdentifier) \
    (assetName) \
    (assetVersion) \
    ((modelPathPrimvarName, "model:modelPath")) \

TF_DECLARE_PUBLIC_TOKENS(UsdImagingModelSchemaTokens, USDIMAGING_API,
    USD_IMAGING_MODEL_SCHEMA_TOKENS);

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


class UsdImagingModelSchema : public HdSchema
{
public:

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

    USDIMAGING_API
    static UsdImagingModelSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);


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


    USDIMAGING_API
    HdPathDataSourceHandle GetModelPath() const;

    USDIMAGING_API
    HdAssetPathDataSourceHandle GetAssetIdentifier() const;

    USDIMAGING_API
    HdStringDataSourceHandle GetAssetName() const;

    USDIMAGING_API
    HdStringDataSourceHandle GetAssetVersion() const; 



    USDIMAGING_API
    static const TfToken &GetSchemaToken();

    USDIMAGING_API
    static const HdDataSourceLocator &GetDefaultLocator();



    USDIMAGING_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdPathDataSourceHandle &modelPath,
        const HdAssetPathDataSourceHandle &assetIdentifier,
        const HdStringDataSourceHandle &assetName,
        const HdStringDataSourceHandle &assetVersion
    );

    class Builder
    {
    public:
        USDIMAGING_API
        Builder &SetModelPath(
            const HdPathDataSourceHandle &modelPath);
        USDIMAGING_API
        Builder &SetAssetIdentifier(
            const HdAssetPathDataSourceHandle &assetIdentifier);
        USDIMAGING_API
        Builder &SetAssetName(
            const HdStringDataSourceHandle &assetName);
        USDIMAGING_API
        Builder &SetAssetVersion(
            const HdStringDataSourceHandle &assetVersion);

        USDIMAGING_API
        HdContainerDataSourceHandle Build();

    private:
        HdPathDataSourceHandle _modelPath;
        HdAssetPathDataSourceHandle _assetIdentifier;
        HdStringDataSourceHandle _assetName;
        HdStringDataSourceHandle _assetVersion;

    };

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif