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

#include <dependencySchema.h>

+ Inheritance diagram for HdDependencySchema:

Classes

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
HdContainerDataSourceHandle 		BuildRetained (const HdPathDataSourceHandle &dependedOnPrimPath, const HdLocatorDataSourceHandle &dependedOnDataSourceLocator, const HdLocatorDataSourceHandle &affectedDataSourceLocator)
 

Additional Inherited Members

- Public Types inherited from HdSchema
using UnderlyingDataSource = HdContainerDataSource
 
- 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 63 of file dependencySchema.h.

Constructor & Destructor Documentation

HdDependencySchema::HdDependencySchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 66 of file dependencySchema.h.

Member Function Documentation

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

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: