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
HdSelectionSchema Class Reference

#include <selectionSchema.h>

+ Inheritance diagram for HdSelectionSchema:

Classes

class  Builder
 

Public Member Functions

 HdSelectionSchema (HdContainerDataSourceHandle container)
 
HD_API HdBoolDataSourceHandle GetFullySelected ()
 
HD_API
HdInstanceIndicesVectorSchema 		GetNestedInstanceIndices ()
 
- 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 HdBoolDataSourceHandle &fullySelected, const HdVectorDataSourceHandle &nestedInstanceIndices)
 

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 selectionSchema.h.

Constructor & Destructor Documentation

HdSelectionSchema::HdSelectionSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 66 of file selectionSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdSelectionSchema::BuildRetained ( const HdBoolDataSourceHandle &  fullySelected,
const HdVectorDataSourceHandle &  nestedInstanceIndices 
)
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 HdBoolDataSourceHandle HdSelectionSchema::GetFullySelected ( )
HD_API HdInstanceIndicesVectorSchema HdSelectionSchema::GetNestedInstanceIndices ( )
The documentation for this class was generated from the following file: