legacyTaskSchema.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_HD_LEGACY_TASK_SCHEMA_H
#define PXR_IMAGING_HD_LEGACY_TASK_SCHEMA_H
 
 
#include "pxr/imaging/hd/api.h"
 
#include "pxr/imaging/hd/schema.h"
 
// --(BEGIN CUSTOM CODE: Includes)--
#include "pxr/imaging/hd/rprimCollection.h"
// --(END CUSTOM CODE: Includes)--
 
PXR_NAMESPACE_OPEN_SCOPE
 
// --(BEGIN CUSTOM CODE: Declares)--
 
using HdRprimCollectionDataSource = HdTypedSampledDataSource<HdRprimCollection>;
using HdRprimCollectionDataSourceHandle = HdRprimCollectionDataSource::Handle;
 
using HdTokenVectorDataSource = HdTypedSampledDataSource<TfTokenVector>;
using HdTokenVectorDataSourceHandle = HdTokenVectorDataSource::Handle;
 
using HdLegacyTaskFactorySharedPtr = std::shared_ptr<class HdLegacyTaskFactory>;
using HdLegacyTaskFactoryDataSource =
    HdTypedSampledDataSource<HdLegacyTaskFactorySharedPtr>;
using HdLegacyTaskFactoryDataSourceHandle =
    HdLegacyTaskFactoryDataSource::Handle;
 
 
// --(END CUSTOM CODE: Declares)--
 
#define HD_LEGACY_TASK_SCHEMA_TOKENS \
    (task) \
    (factory) \
    (parameters) \
    (collection) \
    (renderTags) \
 
TF_DECLARE_PUBLIC_TOKENS(HdLegacyTaskSchemaTokens, HD_API,
    HD_LEGACY_TASK_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
// The HdLegacyTaskSchema specifies a Hydra task by providing a task factory
// and data.
//
 
class HdLegacyTaskSchema : public HdSchema
{
public:
 
    HdLegacyTaskSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    HD_API
    static HdLegacyTaskSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--
 
 
    HD_API
    HdLegacyTaskFactoryDataSourceHandle GetFactory() const;
 
    HD_API
    HdSampledDataSourceHandle GetParameters() const;
 
    HD_API
    HdRprimCollectionDataSourceHandle GetCollection() const;
 
    HD_API
    HdTokenVectorDataSourceHandle GetRenderTags() const; 
 
 
 
    HD_API
    static const TfToken &GetSchemaToken();
 
    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
 
    HD_API
    static const HdDataSourceLocator &GetFactoryLocator();
 
    HD_API
    static const HdDataSourceLocator &GetParametersLocator();
 
    HD_API
    static const HdDataSourceLocator &GetCollectionLocator();
 
    HD_API
    static const HdDataSourceLocator &GetRenderTagsLocator();
 
 
    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdLegacyTaskFactoryDataSourceHandle &factory,
        const HdSampledDataSourceHandle &parameters,
        const HdRprimCollectionDataSourceHandle &collection,
        const HdTokenVectorDataSourceHandle &renderTags
    );
 
    class Builder
    {
    public:
        HD_API
        Builder &SetFactory(
            const HdLegacyTaskFactoryDataSourceHandle &factory);
        HD_API
        Builder &SetParameters(
            const HdSampledDataSourceHandle &parameters);
        HD_API
        Builder &SetCollection(
            const HdRprimCollectionDataSourceHandle &collection);
        HD_API
        Builder &SetRenderTags(
            const HdTokenVectorDataSourceHandle &renderTags);
 
        HD_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdLegacyTaskFactoryDataSourceHandle _factory;
        HdSampledDataSourceHandle _parameters;
        HdRprimCollectionDataSourceHandle _collection;
        HdTokenVectorDataSourceHandle _renderTags;
 
    };
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif