This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
HdContainerDataSource Class Referenceabstract

A datasource representing structured (named, hierarchical) data, for example a geometric primitive or a sub-object like a material definition. More...

#include <dataSource.h>

+ Inheritance diagram for HdContainerDataSource:

Public Member Functions

 HD_DECLARE_DATASOURCE_ABSTRACT (HdContainerDataSource)
 
virtual TfTokenVector GetNames ()=0
 Returns the list of names for which Get(...) is expected to return a non-null value.
 
virtual HdDataSourceBaseHandle Get (const TfToken &name)=0
 Returns the child datasource of the given name.
 

Static Public Member Functions

static HD_API HdDataSourceBaseHandle Get (const Handle &container, const HdDataSourceLocator &locator)
 A convenience function: given container, return the descendant identified by locator, which may be at any depth.
 

Detailed Description

A datasource representing structured (named, hierarchical) data, for example a geometric primitive or a sub-object like a material definition.

Note that implementations are responsible for providing cache invalidation, if necessary.

Definition at line 98 of file dataSource.h.

Member Function Documentation

◆ Get() [1/2]

static HD_API HdDataSourceBaseHandle Get ( const Handle &  container,
const HdDataSourceLocator locator 
)
static

A convenience function: given container, return the descendant identified by locator, which may be at any depth.

Returns container itself on an empty locator, or null if locator doesn't identify a valid descendant.

◆ Get() [2/2]

virtual HdDataSourceBaseHandle Get ( const TfToken name)
pure virtual

◆ GetNames()


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