All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdDependencySchema Class Reference

#include <dependencySchema.h>

+ Inheritance diagram for HdDependencySchema:


class  Builder

Public Member Functions

 HdDependencySchema (HdContainerDataSourceHandle container)
HD_API HdPathDataSourceHandle GetDependedOnPrimPath ()
HD_API HdLocatorDataSourceHandle GetDependedOnDataSourceLocator ()
HD_API HdLocatorDataSourceHandle GetAffectedDataSourceLocator ()
- 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
BuildRetained (const HdPathDataSourceHandle &dependedOnPrimPath, const HdLocatorDataSourceHandle &dependedOnDataSourceLocator, const HdLocatorDataSourceHandle &affectedDataSourceLocator)

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

Definition at line 49 of file dependencySchema.h.

Constructor & Destructor Documentation

HdDependencySchema::HdDependencySchema ( HdContainerDataSourceHandle  container)

Definition at line 52 of file dependencySchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdDependencySchema::BuildRetained ( const HdPathDataSourceHandle dependedOnPrimPath,
const HdLocatorDataSourceHandle dependedOnDataSourceLocator,
const HdLocatorDataSourceHandle affectedDataSourceLocator 

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 HdLocatorDataSourceHandle HdDependencySchema::GetAffectedDataSourceLocator ( )
HD_API HdLocatorDataSourceHandle HdDependencySchema::GetDependedOnDataSourceLocator ( )
HD_API HdPathDataSourceHandle HdDependencySchema::GetDependedOnPrimPath ( )

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