sceneGlobalsSchema.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_SCENE_GLOBALS_SCHEMA_H
#define PXR_IMAGING_HD_SCENE_GLOBALS_SCHEMA_H


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

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

// --(BEGIN CUSTOM CODE: Includes)--
#include "pxr/usd/sdf/path.h"
#include "pxr/imaging/hd/sceneIndex.h"
#include "pxr/imaging/hd/vectorSchema.h"
// --(END CUSTOM CODE: Includes)--

PXR_NAMESPACE_OPEN_SCOPE

// --(BEGIN CUSTOM CODE: Declares)--
using HdPathVectorSchema = HdTypedVectorSchema<HdPathDataSource>;
// --(END CUSTOM CODE: Declares)--

#define HD_SCENE_GLOBALS_SCHEMA_TOKENS \
    (sceneGlobals) \
    (primaryCameraPrim) \
    (activeRenderPassPrim) \
    (activeRenderSettingsPrim) \
    (startTimeCode) \
    (endTimeCode) \
    (timeCodesPerSecond) \
    (currentFrame) \
    (sceneStateId) \
    (primIdToPath) \

TF_DECLARE_PUBLIC_TOKENS(HdSceneGlobalsSchemaTokens, HD_API,
    HD_SCENE_GLOBALS_SCHEMA_TOKENS);

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


class HdSceneGlobalsSchema : public HdSchema
{
public:

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

    HD_API
    static HdSceneGlobalsSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);


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

    HD_API
    static HdSceneGlobalsSchema
    GetFromSceneIndex(
        const HdSceneIndexBaseRefPtr &si);
    
    static const SdfPath&
    GetDefaultPrimPath() {
        return SdfPath::AbsoluteRootPath();
    }

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


    HD_API
    HdPathDataSourceHandle GetPrimaryCameraPrim() const;

    HD_API
    HdPathDataSourceHandle GetActiveRenderPassPrim() const;

    HD_API
    HdPathDataSourceHandle GetActiveRenderSettingsPrim() const;

    HD_API
    HdDoubleDataSourceHandle GetStartTimeCode() const;

    HD_API
    HdDoubleDataSourceHandle GetEndTimeCode() const;

    HD_API
    HdDoubleDataSourceHandle GetTimeCodesPerSecond() const;

    HD_API
    HdDoubleDataSourceHandle GetCurrentFrame() const;

    HD_API
    HdIntDataSourceHandle GetSceneStateId() const;

    HD_API
    HdPathVectorSchema GetPrimIdToPath() const; 



    HD_API
    static const TfToken &GetSchemaToken();

    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();



    HD_API
    static const HdDataSourceLocator &GetPrimaryCameraPrimLocator();

    HD_API
    static const HdDataSourceLocator &GetActiveRenderPassPrimLocator();

    HD_API
    static const HdDataSourceLocator &GetActiveRenderSettingsPrimLocator();

    HD_API
    static const HdDataSourceLocator &GetStartTimeCodeLocator();

    HD_API
    static const HdDataSourceLocator &GetEndTimeCodeLocator();

    HD_API
    static const HdDataSourceLocator &GetTimeCodesPerSecondLocator();

    HD_API
    static const HdDataSourceLocator &GetCurrentFrameLocator();

    HD_API
    static const HdDataSourceLocator &GetSceneStateIdLocator();

    HD_API
    static const HdDataSourceLocator &GetPrimIdToPathLocator();


    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdPathDataSourceHandle &primaryCameraPrim,
        const HdPathDataSourceHandle &activeRenderPassPrim,
        const HdPathDataSourceHandle &activeRenderSettingsPrim,
        const HdDoubleDataSourceHandle &startTimeCode,
        const HdDoubleDataSourceHandle &endTimeCode,
        const HdDoubleDataSourceHandle &timeCodesPerSecond,
        const HdDoubleDataSourceHandle &currentFrame,
        const HdIntDataSourceHandle &sceneStateId,
        const HdVectorDataSourceHandle &primIdToPath
    );

    class Builder
    {
    public:
        HD_API
        Builder &SetPrimaryCameraPrim(
            const HdPathDataSourceHandle &primaryCameraPrim);
        HD_API
        Builder &SetActiveRenderPassPrim(
            const HdPathDataSourceHandle &activeRenderPassPrim);
        HD_API
        Builder &SetActiveRenderSettingsPrim(
            const HdPathDataSourceHandle &activeRenderSettingsPrim);
        HD_API
        Builder &SetStartTimeCode(
            const HdDoubleDataSourceHandle &startTimeCode);
        HD_API
        Builder &SetEndTimeCode(
            const HdDoubleDataSourceHandle &endTimeCode);
        HD_API
        Builder &SetTimeCodesPerSecond(
            const HdDoubleDataSourceHandle &timeCodesPerSecond);
        HD_API
        Builder &SetCurrentFrame(
            const HdDoubleDataSourceHandle &currentFrame);
        HD_API
        Builder &SetSceneStateId(
            const HdIntDataSourceHandle &sceneStateId);
        HD_API
        Builder &SetPrimIdToPath(
            const HdVectorDataSourceHandle &primIdToPath);

        HD_API
        HdContainerDataSourceHandle Build();

    private:
        HdPathDataSourceHandle _primaryCameraPrim;
        HdPathDataSourceHandle _activeRenderPassPrim;
        HdPathDataSourceHandle _activeRenderSettingsPrim;
        HdDoubleDataSourceHandle _startTimeCode;
        HdDoubleDataSourceHandle _endTimeCode;
        HdDoubleDataSourceHandle _timeCodesPerSecond;
        HdDoubleDataSourceHandle _currentFrame;
        HdIntDataSourceHandle _sceneStateId;
        HdVectorDataSourceHandle _primIdToPath;

    };

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif