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

/// \file

#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"
// --(END CUSTOM CODE: Includes)--

PXR_NAMESPACE_OPEN_SCOPE

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

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

TF_DECLARE_PUBLIC_TOKENS(HdSceneGlobalsSchemaTokens, HD_API,
    HD_SCENE_GLOBALS_SCHEMA_TOKENS);

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


/// \class HdSceneGlobalsSchema
///
/// The HdSceneGlobalsSchema encapsulates "global" state to orchestrate a
/// render. It currently houses the active render settings and pass prim paths
/// that describe the information necessary to generate images from a single
/// invocation of a renderer, the active time sample range and current frame
/// number that may be relevant to downstream scene indices (e.g. procedural
/// evaluation), the time codes per second (sometimes informally referred to as
/// FPS), and the primary camera.
///
/// We shall use the convention of a container data source at the root prim of
/// the scene index that is populated with this global state. The renderer and
/// downstream scene indices can query it to configure their behavior as
/// necessary.
///
class HdSceneGlobalsSchema : public HdSchema
{
public:
    /// \name Schema retrieval
    /// @{

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

    /// Retrieves a container data source with the schema's default name token
    /// "sceneGlobals" from the parent container and constructs a
    /// HdSceneGlobalsSchema instance.
    /// Because the requested container data source may not exist, the result
    /// should be checked with IsDefined() or a bool comparison before use.
    HD_API
    static HdSceneGlobalsSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);

    /// @}

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

    /// Constructs and returns a HdSceneGlobalsSchema from the root prim in the
    /// scene index. Since the root prim might not have a data source for this
    /// schema, the result should be checked with IsDefined() or a bool 
    /// conversion before use.
    ///
    /// \note This API is preferable to GetFromParent(container).
    HD_API
    static HdSceneGlobalsSchema
    GetFromSceneIndex(
        const HdSceneIndexBaseRefPtr &si);
    
    /// Utility method to concretize the convention of parking the 
    /// "sceneGlobals" container at the root prim of the scene index.
    static const SdfPath&
    GetDefaultPrimPath() {
        return SdfPath::AbsoluteRootPath();
    }

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

    /// \name Member accessor
    /// @{

    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; 

    /// @}

    /// \name Schema location
    /// @{

    /// Returns a token where the container representing this schema is found in
    /// a container by default.
    HD_API
    static const TfToken &GetSchemaToken();

    /// Returns an HdDataSourceLocator (relative to the prim-level data source)
    /// where the container representing this schema is found by default.
    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();

    /// @}

    /// \name Data source locators for members
    ///
    /// The following methods return an HdDataSourceLocator (relative to the
    /// prim-level data source) where the data source for a member can be found.
    ///
    /// This is often useful for checking intersection against the
    /// HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
    /// @{

    /// Prim-level relative data source locator to locate primaryCameraPrim.
    HD_API
    static const HdDataSourceLocator &GetPrimaryCameraPrimLocator();

    /// Prim-level relative data source locator to locate activeRenderPassPrim.
    HD_API
    static const HdDataSourceLocator &GetActiveRenderPassPrimLocator();

    /// Prim-level relative data source locator to locate activeRenderSettingsPrim.
    HD_API
    static const HdDataSourceLocator &GetActiveRenderSettingsPrimLocator();

    /// Prim-level relative data source locator to locate startTimeCode.
    HD_API
    static const HdDataSourceLocator &GetStartTimeCodeLocator();

    /// Prim-level relative data source locator to locate endTimeCode.
    HD_API
    static const HdDataSourceLocator &GetEndTimeCodeLocator();

    /// Prim-level relative data source locator to locate timeCodesPerSecond.
    HD_API
    static const HdDataSourceLocator &GetTimeCodesPerSecondLocator();

    /// Prim-level relative data source locator to locate currentFrame.
    HD_API
    static const HdDataSourceLocator &GetCurrentFrameLocator();

    /// Prim-level relative data source locator to locate sceneStateId.
    HD_API
    static const HdDataSourceLocator &GetSceneStateIdLocator();
    /// @} 

    /// \name Schema construction
    /// @{

    /// \deprecated Use Builder instead.
    ///
    /// Builds a container data source which includes the provided child data
    /// sources. Parameters with nullptr values are excluded. This is a
    /// low-level interface. For cases in which it's desired to define
    /// the container with a sparse set of child fields, the Builder class
    /// is often more convenient and readable.
    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
    );

    /// \class HdSceneGlobalsSchema::Builder
    /// 
    /// Utility class for setting sparse sets of child data source fields to be
    /// filled as arguments into BuildRetained. Because all setter methods
    /// return a reference to the instance, this can be used in the "builder
    /// pattern" form.
    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);

        /// Returns a container data source containing the members set thus far.
        HD_API
        HdContainerDataSourceHandle Build();

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

    };

    /// @}
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif