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

#include <categoriesSchema.h>

+ Inheritance diagram for HdCategoriesSchema:

Public Member Functions

HD_API VtArray< TfToken > GetIncludedCategoryNames ()
 
HD_API bool IsIncludedInCategory (const TfToken &categoryName)
 
- Public Member Functions inherited from HdSchema
 HdSchema (HdContainerDataSourceHandle container)
 
HD_API HdContainerDataSourceHandle GetContainer () const
 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 (size_t includedNameCount, const TfToken *includedNames, size_t excludedNameCount, const TfToken *excludedNames)
 
Schema location
static HD_API const TfToken & GetSchemaToken ()
 
static HD_API const
HdDataSourceLocator & 		GetDefaultLocator ()
 

Schema retrieval

 HdCategoriesSchema (HdContainerDataSourceHandle container)
 
static HD_API HdCategoriesSchema GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 

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) const
 
- Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle _container
 

Detailed Description

Definition at line 44 of file categoriesSchema.h.

Constructor & Destructor Documentation

HdCategoriesSchema::HdCategoriesSchema ( HdContainerDataSourceHandle  container)
inline

Retrieves a container data source with the schema's default name token "categories" from the parent container and constructs a HdCategoriesSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

Definition at line 50 of file categoriesSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdCategoriesSchema::BuildRetained ( size_t  includedNameCount,
const TfToken *  includedNames,
size_t  excludedNameCount,
const TfToken *  excludedNames 
)
static
static HD_API const HdDataSourceLocator& HdCategoriesSchema::GetDefaultLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

static HD_API HdCategoriesSchema HdCategoriesSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

Retrieves a container data source with the schema's default name token "categories" from the parent container and constructs a HdCategoriesSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

HD_API VtArray<TfToken> HdCategoriesSchema::GetIncludedCategoryNames ( )
static HD_API const TfToken& HdCategoriesSchema::GetSchemaToken ( )
static

Returns a token where the container representing this schema is found in a container by default.

HD_API bool HdCategoriesSchema::IsIncludedInCategory ( const TfToken &  categoryName)
The documentation for this class was generated from the following file: