HdFlattenedOverlayDataSourceProvider Class Reference

Flattens a data source by using HdOverlayContainerDataSource. More...

#include <flattenedOverlayDataSourceProvider.h>

Inheritance diagram for HdFlattenedOverlayDataSourceProvider:

Public Member Functions
HD_API HdContainerDataSourceHandle	GetFlattenedDataSource (const Context &) const override
	Returns flattened data source.
HD_API void	ComputeDirtyLocatorsForDescendants (HdDataSourceLocatorSet *locators) const override
	If data source locators are dirtied in the input scene index, the locators relevant for the input data source serving this provider are extracted and made relative to the input data source.
virtual HdContainerDataSourceHandle	GetFlattenedDataSource (const Context &ctx) const =0
	Returns flattened data source.
virtual void	ComputeDirtyLocatorsForDescendants (HdDataSourceLocatorSet *locators) const =0
	If data source locators are dirtied in the input scene index, the locators relevant for the input data source serving this provider are extracted and made relative to the input data source.

Detailed Description

Flattens a data source by using HdOverlayContainerDataSource.

Definition at line 20 of file flattenedOverlayDataSourceProvider.h.

Member Function Documentation

ComputeDirtyLocatorsForDescendants()

HD_API void ComputeDirtyLocatorsForDescendants ( HdDataSourceLocatorSet *  locators ) const

overridevirtual

If data source locators are dirtied in the input scene index, the locators relevant for the input data source serving this provider are extracted and made relative to the input data source.

They are later used to invalidate the flattened data source of the dirtied prim and its descendants and send prim dirtied messages to the descendants.

Example: If a prim dirtied for locator xform:matrix was received, the flattening scene index will call the flattened data source provider for xform. The locators given to ComputeDirtyLocatorsForDescendants will be { matrix }. If ComputeDirtyLocatorsForDescendants sets it to the universal set, the flatening scene index will emit a prim dirtied locator xform for the descendants.

The implementation of ComputeDirtyLocatorsForDescendants gives a chance to drop locators or expand the locator set in between.

Note that ComputeDirtyLocatorsForDescendants will never be called with the empty or universal set as these cases are already handled by the callee.

Implements HdFlattenedDataSourceProvider.

GetFlattenedDataSource()

HD_API HdContainerDataSourceHandle GetFlattenedDataSource ( const Context &  ctx ) const

overridevirtual

Returns flattened data source.

Implements HdFlattenedDataSourceProvider.

---

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

• pxr/imaging/hd/flattenedOverlayDataSourceProvider.h