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

#include <instanceIndicesSchema.h>

+ Inheritance diagram for HdInstanceIndicesSchema:

Classes

class  Builder
 

Public Member Functions

 HdInstanceIndicesSchema (HdContainerDataSourceHandle container)
 
HD_API HdPathDataSourceHandle GetInstancer ()
 
HD_API HdIntDataSourceHandle GetPrototypeIndex ()
 
HD_API HdIntArrayDataSourceHandle GetInstanceIndices ()
 
- 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 &instancer, const HdIntDataSourceHandle &prototypeIndex, const HdIntArrayDataSourceHandle &instanceIndices)
 

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 52 of file instanceIndicesSchema.h.

Constructor & Destructor Documentation

HdInstanceIndicesSchema::HdInstanceIndicesSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 55 of file instanceIndicesSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdInstanceIndicesSchema::BuildRetained ( const HdPathDataSourceHandle &  instancer,
const HdIntDataSourceHandle &  prototypeIndex,
const HdIntArrayDataSourceHandle &  instanceIndices 
)
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 HdIntArrayDataSourceHandle HdInstanceIndicesSchema::GetInstanceIndices ( )
HD_API HdPathDataSourceHandle HdInstanceIndicesSchema::GetInstancer ( )
HD_API HdIntDataSourceHandle HdInstanceIndicesSchema::GetPrototypeIndex ( )
The documentation for this class was generated from the following file: