HdOverlayContainerDataSource Class Reference

#include <overlayContainerDataSource.h>

Inheritance diagram for HdOverlayContainerDataSource:

Public Member Functions
	HD_DECLARE_DATASOURCE (HdOverlayContainerDataSource)
	HD_DECLARE_DATASOURCE_INITIALIZER_LIST_NEW (HdOverlayContainerDataSource, HdContainerDataSourceHandle)
HD_API	HdOverlayContainerDataSource (std::initializer_list< HdContainerDataSourceHandle > sources)
HD_API	HdOverlayContainerDataSource (size_t count, HdContainerDataSourceHandle *containers)
HD_API	HdOverlayContainerDataSource (const HdContainerDataSourceHandle &src1, const HdContainerDataSourceHandle &src2)
HD_API	HdOverlayContainerDataSource (const HdContainerDataSourceHandle &src1, const HdContainerDataSourceHandle &src2, const HdContainerDataSourceHandle &src3)
HD_API TfTokenVector	GetNames () override
HD_API HdDataSourceBaseHandle	Get (const TfToken &name) override
Public Member Functions inherited from HdContainerDataSource
	HD_DECLARE_DATASOURCE_ABSTRACT (HdContainerDataSource)
Public Member Functions inherited from HdDataSourceBase
virtual HD_API	~HdDataSourceBase ()=0

Static Public Member Functions
static HD_API HdContainerDataSourceHandle	OverlayedContainerDataSources (const HdContainerDataSourceHandle &src1, const HdContainerDataSourceHandle &src2)
Static Public Member Functions inherited from HdContainerDataSource
static HD_API HdDataSourceBaseHandle	Get (const Handle &container, const HdDataSourceLocator &locator)

Detailed Description

Lazily composes two or more container source hierarchies Earlier entries on the containers array have stronger opinion strength for overlapping child names. Overlapping children which are all containers themselves are returned as another instance of this class

Definition at line 37 of file overlayContainerDataSource.h.

Constructor & Destructor Documentation

HD_API HdOverlayContainerDataSource::HdOverlayContainerDataSource

(

std::initializer_list< HdContainerDataSourceHandle >

sources

)

HD_API HdOverlayContainerDataSource::HdOverlayContainerDataSource	(	size_t	count,
		HdContainerDataSourceHandle *	containers
	)

HD_API HdOverlayContainerDataSource::HdOverlayContainerDataSource	(	const HdContainerDataSourceHandle &	src1,
		const HdContainerDataSourceHandle &	src2
	)

HD_API HdOverlayContainerDataSource::HdOverlayContainerDataSource	(	const HdContainerDataSourceHandle &	src1,
		const HdContainerDataSourceHandle &	src2,
		const HdContainerDataSourceHandle &	src3
	)

Member Function Documentation

HD_API HdDataSourceBaseHandle HdOverlayContainerDataSource::Get ( const TfToken &  name )

overridevirtual

Returns the child datasource of the given name. This call is expected to be threadsafe.

Implements HdContainerDataSource.

HD_API TfTokenVector HdOverlayContainerDataSource::GetNames ( )

overridevirtual

Returns the list of names for which Get(...) is expected to return a non-null value. This call is expected to be threadsafe.

Implements HdContainerDataSource.

HdOverlayContainerDataSource::HD_DECLARE_DATASOURCE

(

HdOverlayContainerDataSource

)

HdOverlayContainerDataSource::HD_DECLARE_DATASOURCE_INITIALIZER_LIST_NEW	(	HdOverlayContainerDataSource	,
		HdContainerDataSourceHandle
	)

static HD_API HdContainerDataSourceHandle HdOverlayContainerDataSource::OverlayedContainerDataSources ( const HdContainerDataSourceHandle &  src1, const HdContainerDataSourceHandle &  src2  )

static

Creates HdOverlayContainerDataSource from sources, but only if needed. If one of given handles is null, the other handle is returned instead.

---

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

• pxr/imaging/hd/overlayContainerDataSource.h