HdSceneGlobalsSchema Class Reference

#include <sceneGlobalsSchema.h>

Inheritance diagram for HdSceneGlobalsSchema:

Classes
class	Builder

Public Member Functions
	HdSceneGlobalsSchema (HdContainerDataSourceHandle container)
HD_API HdPathDataSourceHandle	GetActiveRenderSettingsPrim ()
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer ()
	Returns the container data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const

Static Public Member Functions
static HD_API HdContainerDataSourceHandle	BuildRetained (const HdPathDataSourceHandle &activeRenderSettingsPrim)
static HD_API HdSceneGlobalsSchema	GetFromSceneIndex (const HdSceneIndexBaseRefPtr &si)
static const SdfPath &	GetDefaultPrimPath ()
static HD_API HdSceneGlobalsSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
static HD_API const TfToken &	GetSchemaToken ()
static HD_API const HdDataSourceLocator &	GetDefaultLocator ()
static HD_API const HdDataSourceLocator &	GetActiveRenderSettingsPrimLocator ()

Additional Inherited Members
Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name)
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

The HdSceneGlobalsSchema encapsulates "global" state to orchestrate a render. It currently houses the active render settings prim path that describes the information necessary to generate images from a single invocation of a renderer.

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.

Definition at line 66 of file sceneGlobalsSchema.h.

Constructor & Destructor Documentation

HdSceneGlobalsSchema::HdSceneGlobalsSchema ( HdContainerDataSourceHandle  container )

inline

Definition at line 69 of file sceneGlobalsSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdSceneGlobalsSchema::BuildRetained ( const HdPathDataSourceHandle &  activeRenderSettingsPrim )

static

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 HdPathDataSourceHandle HdSceneGlobalsSchema::GetActiveRenderSettingsPrim

(

)

static HD_API const HdDataSourceLocator& HdSceneGlobalsSchema::GetActiveRenderSettingsPrimLocator ( )

static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the activerendersettingsprim data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

static HD_API const HdDataSourceLocator& HdSceneGlobalsSchema::GetDefaultLocator ( )

static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

static const SdfPath& HdSceneGlobalsSchema::GetDefaultPrimPath ( )

inlinestatic

Utility method to concretize the convention of parking the "sceneGlobals" container at the root prim of the scene index.

Definition at line 125 of file sceneGlobalsSchema.h.

static HD_API HdSceneGlobalsSchema HdSceneGlobalsSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

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.

static HD_API HdSceneGlobalsSchema HdSceneGlobalsSchema::GetFromSceneIndex ( const HdSceneIndexBaseRefPtr &  si )

static

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).

static HD_API const TfToken& HdSceneGlobalsSchema::GetSchemaToken ( )

static

Returns a token where the container representing this schema is found in a container by default.

---

The documentation for this class was generated from the following file:

• pxr/imaging/hd/sceneGlobalsSchema.h