HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | List of all members
HdFlattenedDataSourceProvider Class Referenceabstract

#include <flattenedDataSourceProvider.h>

+ Inheritance diagram for HdFlattenedDataSourceProvider:

Classes

class  Context
 
class  Given
 

Public Member Functions

virtual HdContainerDataSourceHandle GetFlattenedDataSource (const Context &ctx) const =0
 Returns flattened data source. More...
 
virtual void ComputeDirtyLocatorsForDescendants (HdDataSourceLocatorSet *locators) const =0
 

Detailed Description

Definition at line 45 of file flattenedDataSourceProvider.h.

Member Function Documentation

virtual void HdFlattenedDataSourceProvider::ComputeDirtyLocatorsForDescendants ( HdDataSourceLocatorSet *  locators) const
pure virtual

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.

Implemented in HdFlattenedOverlayDataSourceProvider.

virtual HdContainerDataSourceHandle HdFlattenedDataSourceProvider::GetFlattenedDataSource ( const Context &  ctx) const
pure virtual

Returns flattened data source.

Implemented in HdFlattenedOverlayDataSourceProvider.

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