Public Member Functions | Static Public Member Functions | List of all members
HdContainerDataSource Class Referenceabstract

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

+ 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. More...
 
virtual HdDataSourceBaseHandle Get (const TfToken &name)=0
 Returns the child datasource of the given name. More...
 

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. More...
 

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 110 of file dataSource.h.

Member Function Documentation

◆ Get() [1/2]

virtual HdDataSourceBaseHandle Get ( const TfToken &  name)
pure virtual

Returns the child datasource of the given name.

This call is expected to be threadsafe.

Implemented in UsdImagingDataSourcePrim, UsdImagingDataSourcePrimOrigin, UsdImagingDataSourceModel, UsdImagingDataSourceXform, UsdImagingDataSourceExtent, UsdImagingDataSourcePrimvar, UsdImagingDataSourceMeshPrim, UsdImagingDataSourceRenderVarPrim, UsdImagingDataSourceBasisCurvesPrim, UsdImagingDataSourceMesh, UsdImagingDataSourcePurpose, UsdImagingDataSourcePointInstancerTopology, UsdImagingDataSourceRenderProductPrim, HdDataSourceLegacyPrim, UsdImagingDataSourceFieldAssetPrim, UsdImagingDataSourceCameraPrim, UsdImagingDataSourceBasisCurves, UsdImagingDataSourceSchemaBased< UsdSchemaType, UsdSchemaBaseTypes, Translator >, UsdImagingDataSourceVolumePrim, UsdImagingDataSourceMeshTopology, HdOverlayContainerDataSource, HdFlattenedPrimvarsDataSource, UsdImagingDataSourceVisibility, HdMapContainerDataSource, UsdImagingDataSourceMaterial, UsdImagingDataSourceStage, UsdImagingDataSourceFieldAsset, UsdImagingDataSourceGprim, UsdImagingDataSourceRenderSettingsPrim, UsdImagingDataSourceCamera, UsdImagingDataSourceBasisCurvesTopology, UsdImagingDataSourcePrimvars, HdLazyContainerDataSource, UsdImagingDataSourceSubdivisionTags, UsdImagingDataSourceVolumeFieldBindings, UsdImagingDataSourcePointsPrim, UsdImagingDataSourceUsdPrimInfo, UsdImagingDataSourceNurbsCurvesPrim, and UsdImagingDataSourceNurbsPatchPrim.

◆ Get() [2/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.

◆ GetNames()

virtual TfTokenVector GetNames ( )
pure virtual

Returns the list of names for which Get(...) is expected to return a non-null value.

This call is expected to be threadsafe.

Implemented in UsdImagingDataSourcePrim, UsdImagingDataSourcePrimOrigin, UsdImagingDataSourceModel, UsdImagingDataSourceXform, UsdImagingDataSourceExtent, UsdImagingDataSourcePrimvar, UsdImagingDataSourceMeshPrim, UsdImagingDataSourceRenderVarPrim, UsdImagingDataSourceBasisCurvesPrim, UsdImagingDataSourceMesh, UsdImagingDataSourcePurpose, UsdImagingDataSourcePointInstancerTopology, HdDataSourceLegacyPrim, UsdImagingDataSourceRenderProductPrim, UsdImagingDataSourceFieldAssetPrim, UsdImagingDataSourceCameraPrim, UsdImagingDataSourceBasisCurves, UsdImagingDataSourceVolumePrim, UsdImagingDataSourceSchemaBased< UsdSchemaType, UsdSchemaBaseTypes, Translator >, UsdImagingDataSourceMeshTopology, HdOverlayContainerDataSource, HdFlattenedPrimvarsDataSource, HdMapContainerDataSource, UsdImagingDataSourceVisibility, UsdImagingDataSourceMaterial, UsdImagingDataSourceFieldAsset, UsdImagingDataSourceCamera, UsdImagingDataSourceStage, UsdImagingDataSourceBasisCurvesTopology, UsdImagingDataSourcePrimvars, UsdImagingDataSourceRenderSettingsPrim, UsdImagingDataSourceSubdivisionTags, UsdImagingDataSourceVolumeFieldBindings, HdLazyContainerDataSource, UsdImagingDataSourceUsdPrimInfo, UsdImagingDataSourceNurbsCurvesPrim, and UsdImagingDataSourceNurbsPatchPrim.

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