HdContainerDataSource Class Reference

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 115 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

Returns the child datasource of the given name.

This call is expected to be threadsafe.

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

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 HdDataSourceLegacyPrim, HdLazyContainerDataSource, HdMapContainerDataSource, HdOverlayContainerDataSource, UsdImagingDataSourceBasisCurvesTopology, UsdImagingDataSourceBasisCurves, UsdImagingDataSourceBasisCurvesPrim, UsdImagingDataSourceCamera, UsdImagingDataSourceCameraPrim, UsdImagingDataSourceMaterial, UsdImagingDataSourceSubdivisionTags, UsdImagingDataSourceMeshTopology, UsdImagingDataSourceMesh, UsdImagingDataSourceMeshPrim, UsdImagingDataSourceNurbsCurvesPrim, UsdImagingDataSourceNurbsPatchPrim, UsdImagingDataSourcePointInstancerTopology, UsdImagingDataSourceVisibility, UsdImagingDataSourcePurpose, UsdImagingDataSourceExtent, UsdImagingDataSourceExtentsHint, UsdImagingDataSourceXform, UsdImagingDataSourcePrimOrigin, UsdImagingDataSourcePrim, UsdImagingDataSourcePrimvars, UsdImagingDataSourcePrimvar, UsdImagingDataSourceRenderSettingsPrim, UsdImagingDataSourceRenderProductPrim, UsdImagingDataSourceRenderVarPrim, UsdImagingDataSourceSchemaBased< UsdSchemaType, UsdSchemaBaseTypes, Translator >, UsdImagingDataSourceStage, UsdImagingDataSourceUsdPrimInfo, UsdImagingDataSourceVolumeFieldBindings, UsdImagingDataSourceVolumePrim, UsdImagingDataSourceFieldAsset, and UsdImagingDataSourceFieldAssetPrim.

---

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

• pxr/imaging/hd/dataSource.h