sceneIndexCreateArgsSchema.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_SCENE_INDEX_CREATE_ARGS_SCHEMA_H
#define PXR_USD_IMAGING_USD_IMAGING_SCENE_INDEX_CREATE_ARGS_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)--
TF_DECLARE_REF_PTRS(UsdStage);
using UsdStageRefPtrDataSource = HdTypedSampledDataSource<UsdStageRefPtr>;
using UsdStageRefPtrDataSourceHandle = UsdStageRefPtrDataSource::Handle;
// --(END CUSTOM CODE: Declares)--

#define USD_IMAGING_SCENE_INDEX_CREATE_ARGS_SCHEMA_TOKENS \
    (usdImagingSceneIndexCreateArgs) \
    (stage) \
    (includeUnloadedPrims) \
    (displayUnloadedPrimsWithBounds) \
    (addDrawModeSceneIndex) \

TF_DECLARE_PUBLIC_TOKENS(UsdImagingSceneIndexCreateArgsSchemaTokens, USDIMAGING_API,
    USD_IMAGING_SCENE_INDEX_CREATE_ARGS_SCHEMA_TOKENS);

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


class UsdImagingSceneIndexCreateArgsSchema : public HdSchema
{
public:

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

    USDIMAGING_API
    static UsdImagingSceneIndexCreateArgsSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);


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


    USDIMAGING_API
    UsdStageRefPtrDataSourceHandle GetStage() const;

    USDIMAGING_API
    HdBoolDataSourceHandle GetIncludeUnloadedPrims() const;

    USDIMAGING_API
    HdBoolDataSourceHandle GetDisplayUnloadedPrimsWithBounds() const;

    USDIMAGING_API
    HdBoolDataSourceHandle GetAddDrawModeSceneIndex() const; 



    USDIMAGING_API
    static const TfToken &GetSchemaToken();

    USDIMAGING_API
    static const HdDataSourceLocator &GetDefaultLocator();



    USDIMAGING_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const UsdStageRefPtrDataSourceHandle &stage,
        const HdBoolDataSourceHandle &includeUnloadedPrims,
        const HdBoolDataSourceHandle &displayUnloadedPrimsWithBounds,
        const HdBoolDataSourceHandle &addDrawModeSceneIndex
    );

    class Builder
    {
    public:
        USDIMAGING_API
        Builder &SetStage(
            const UsdStageRefPtrDataSourceHandle &stage);
        USDIMAGING_API
        Builder &SetIncludeUnloadedPrims(
            const HdBoolDataSourceHandle &includeUnloadedPrims);
        USDIMAGING_API
        Builder &SetDisplayUnloadedPrimsWithBounds(
            const HdBoolDataSourceHandle &displayUnloadedPrimsWithBounds);
        USDIMAGING_API
        Builder &SetAddDrawModeSceneIndex(
            const HdBoolDataSourceHandle &addDrawModeSceneIndex);

        USDIMAGING_API
        HdContainerDataSourceHandle Build();

    private:
        UsdStageRefPtrDataSourceHandle _stage;
        HdBoolDataSourceHandle _includeUnloadedPrims;
        HdBoolDataSourceHandle _displayUnloadedPrimsWithBounds;
        HdBoolDataSourceHandle _addDrawModeSceneIndex;

    };

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif