rileyRenderViewSchema.h

Go to the documentation of this file.

//
// Copyright 2023 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache 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 EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_RENDER_VIEW_SCHEMA_H
#define EXT_RMANPKG_25_0_PLUGIN_RENDERMAN_PLUGIN_HD_PRMAN_RILEY_RENDER_VIEW_SCHEMA_H
 
 
#include "hdPrman/api.h"
#include "hdPrman/rileyParamListSchema.h"
 
#include "pxr/imaging/hd/schema.h"
#include "pxr/imaging/hd/version.h"
 
// --(BEGIN CUSTOM CODE: Includes)--
// --(END CUSTOM CODE: Includes)--
 
PXR_NAMESPACE_OPEN_SCOPE
 
// --(BEGIN CUSTOM CODE: Declares)--
// --(END CUSTOM CODE: Declares)--
 
#define HD_PRMAN_RILEY_RENDER_VIEW_SCHEMA_TOKENS \
    (rileyRenderView) \
    (renderTarget) \
    (camera) \
    (integrator) \
    (displayFilters) \
    (sampleFilters) \
    (params) \
    (importance) \
    (weighted) \
 
TF_DECLARE_PUBLIC_TOKENS(HdPrmanRileyRenderViewSchemaTokens, HDPRMAN_API,
    HD_PRMAN_RILEY_RENDER_VIEW_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
 
class HdPrmanRileyRenderViewSchema : public HdSchema
{
public:
 
    HdPrmanRileyRenderViewSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    HDPRMAN_API
    static HdPrmanRileyRenderViewSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--
 
 
    HDPRMAN_API
    HdPathDataSourceHandle GetRenderTarget()
#if HD_API_VERSION >= 66
                                            const;
#else
                                                 ;
#endif
 
 
    HDPRMAN_API
    HdPathDataSourceHandle GetCamera()
#if HD_API_VERSION >= 66
                                            const;
#else
                                                 ;
#endif
 
 
    HDPRMAN_API
    HdPathDataSourceHandle GetIntegrator()
#if HD_API_VERSION >= 66
                                            const;
#else
                                                 ;
#endif
 
 
    HDPRMAN_API
    HdPathArrayDataSourceHandle GetDisplayFilters()
#if HD_API_VERSION >= 66
                                            const;
#else
                                                 ;
#endif
 
 
    HDPRMAN_API
    HdPathArrayDataSourceHandle GetSampleFilters()
#if HD_API_VERSION >= 66
                                            const;
#else
                                                 ;
#endif
 
 
    HDPRMAN_API
    HdPrmanRileyParamListSchema GetParams()
#if HD_API_VERSION >= 66
                                            const;
#else
                                                 ;
#endif
 
 
 
 
    HDPRMAN_API
    static const TfToken &GetSchemaToken();
 
    HDPRMAN_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
 
    HDPRMAN_API
    static const HdDataSourceLocator &GetRenderTargetLocator();
 
    HDPRMAN_API
    static const HdDataSourceLocator &GetCameraLocator();
 
    HDPRMAN_API
    static const HdDataSourceLocator &GetIntegratorLocator();
 
    HDPRMAN_API
    static const HdDataSourceLocator &GetDisplayFiltersLocator();
 
    HDPRMAN_API
    static const HdDataSourceLocator &GetSampleFiltersLocator();
 
    HDPRMAN_API
    static const HdDataSourceLocator &GetParamsLocator();
 
 
    HDPRMAN_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdPathDataSourceHandle &renderTarget,
        const HdPathDataSourceHandle &camera,
        const HdPathDataSourceHandle &integrator,
        const HdPathArrayDataSourceHandle &displayFilters,
        const HdPathArrayDataSourceHandle &sampleFilters,
        const HdContainerDataSourceHandle &params
    );
 
    class Builder
    {
    public:
        HDPRMAN_API
        Builder &SetRenderTarget(
            const HdPathDataSourceHandle &renderTarget);
        HDPRMAN_API
        Builder &SetCamera(
            const HdPathDataSourceHandle &camera);
        HDPRMAN_API
        Builder &SetIntegrator(
            const HdPathDataSourceHandle &integrator);
        HDPRMAN_API
        Builder &SetDisplayFilters(
            const HdPathArrayDataSourceHandle &displayFilters);
        HDPRMAN_API
        Builder &SetSampleFilters(
            const HdPathArrayDataSourceHandle &sampleFilters);
        HDPRMAN_API
        Builder &SetParams(
            const HdContainerDataSourceHandle &params);
 
        HDPRMAN_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdPathDataSourceHandle _renderTarget;
        HdPathDataSourceHandle _camera;
        HdPathDataSourceHandle _integrator;
        HdPathArrayDataSourceHandle _displayFilters;
        HdPathArrayDataSourceHandle _sampleFilters;
        HdContainerDataSourceHandle _params;
 
    };
 
    HDPRMAN_API
    static HdTokenDataSourceHandle BuildFilterModeDataSource(
        const TfToken &filterMode);
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif