A retained container data source is a data source whose data are available locally, meaning that they are fully stored and contained within the data source. More...

#include <retainedDataSource.h>

Inheritance diagram for HdRetainedContainerDataSource:

Public Member Functions
	HD_DECLARE_DATASOURCE_ABSTRACT (HdRetainedContainerDataSource)

Public Member Functions inherited from HdContainerDataSource
	HD_DECLARE_DATASOURCE_ABSTRACT (HdContainerDataSource)

virtual TfTokenVector	GetNames ()=0
	Returns the list of names for which `Get(...)` is expected to return a non-null value.

virtual HdDataSourceBaseHandle	Get (const TfToken &name)=0
	Returns the child datasource of the given name.

Static Public Member Functions
static HD_API Handle	New ()

static HD_API Handle	New (size_t count, const TfToken names, const HdDataSourceBaseHandle values)

static HD_API Handle	New (const TfToken &name1, const HdDataSourceBaseHandle &value1)

static HD_API Handle	New (const TfToken &name1, const HdDataSourceBaseHandle &value1, const TfToken &name2, const HdDataSourceBaseHandle &value2)

static HD_API Handle	New (const TfToken &name1, const HdDataSourceBaseHandle &value1, const TfToken &name2, const HdDataSourceBaseHandle &value2, const TfToken &name3, const HdDataSourceBaseHandle &value3)

static HD_API Handle	New (const TfToken &name1, const HdDataSourceBaseHandle &value1, const TfToken &name2, const HdDataSourceBaseHandle &value2, const TfToken &name3, const HdDataSourceBaseHandle &value3, const TfToken &name4, const HdDataSourceBaseHandle &value4)

static HD_API Handle	New (const TfToken &name1, const HdDataSourceBaseHandle &value1, const TfToken &name2, const HdDataSourceBaseHandle &value2, const TfToken &name3, const HdDataSourceBaseHandle &value3, const TfToken &name4, const HdDataSourceBaseHandle &value4, const TfToken &name5, const HdDataSourceBaseHandle &value5)

static HD_API Handle	New (const TfToken &name1, const HdDataSourceBaseHandle &value1, const TfToken &name2, const HdDataSourceBaseHandle &value2, const TfToken &name3, const HdDataSourceBaseHandle &value3, const TfToken &name4, const HdDataSourceBaseHandle &value4, const TfToken &name5, const HdDataSourceBaseHandle &value5, const TfToken &name6, const HdDataSourceBaseHandle &value6)

Static Public Member Functions inherited from HdContainerDataSource
static HD_API HdDataSourceBaseHandle	Get (const Handle &container, const HdDataSourceLocator &locator)
	A convenience function: given `container`, return the descendant identified by `locator`, which may be at any depth.

Detailed Description

A retained container data source is a data source whose data are available locally, meaning that they are fully stored and contained within the data source.

These are typically used for the kinds of operations that need to break away from the more live data sources (e.g., those that query a backing scene).

Definition at line 45 of file retainedDataSource.h.

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

pxr/imaging/hd/retainedDataSource.h

Public Member Functions

Static Public Member Functions

Detailed Description