HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdContainerDataSource Class Referenceabstract

#include <dataSource.h>

+ Inheritance diagram for HdContainerDataSource:

Public Member Functions

 HD_DECLARE_DATASOURCE_ABSTRACT (HdContainerDataSource)
 
virtual TfTokenVector GetNames ()=0
 
virtual HdDataSourceBaseHandle Get (const TfToken &name)=0
 
- Public Member Functions inherited from HdDataSourceBase
virtual HD_API ~HdDataSourceBase ()=0
 

Static Public Member Functions

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

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

Member Function Documentation

virtual HdDataSourceBaseHandle HdContainerDataSource::Get ( const TfToken name)
pure virtual

Returns the child datasource of the given name. This call is expected to be threadsafe.

Implemented in UsdImagingDataSourcePrim, UsdImagingDataSourceDataSharing, UsdImagingDataSourcePrimOrigin, UsdImagingDataSourceXform, UsdImagingDataSourceExtentsHint, HdsiLocatorCachingSceneIndex::_DataSource, UsdImagingDataSourceExtent, UsdImagingDataSourceMapped, UsdImagingDataSourceRenderVarPrim, UsdImagingDataSourcePrimvar, UsdImagingDataSourceMeshPrim, UsdImagingDataSourceRenderProductPrim, UsdImagingDataSourcePointInstancerPrim, UsdImagingDataSourceTetMeshPrim, UsdImagingDataSourceBasisCurvesPrim, UsdImagingDataSourceMesh, UsdImagingDataSourcePurpose, UsdImagingDataSourceMaterialPrim, UsdImagingDataSourcePointInstancerTopology, UsdSkelImagingDataSourceResolvedPointsBasedPrim, UsdImagingDataSourceRenderSettingsPrim, UsdImagingDataSourceFieldAssetPrim, UsdImagingDataSourceCustomPrimvars, HdOverlayContainerDataSource, HdxFreeCameraPrimDataSource, UsdImagingDataSourceCameraPrim, UsdImagingDataSourceTetMesh, HdDataSourceLegacyPrim, UsdImagingDataSourceBasisCurves, UsdImagingDataSourceVolumePrim, UsdImagingDataSourceMeshTopology, UsdSkelImagingDataSourceResolvedSkeletonPrim, UsdImagingDataSourceVisibility, HdDataSourceLegacyTaskPrim, UsdImagingDataSourceMaterial, UsdImagingRerootingContainerDataSource, UsdSkelImagingDataSourceBindingAPI, UsdImagingDataSourceGprim, UsdImagingDataSourceStage, UsdImagingDataSourceFieldAsset, HdMapContainerDataSource, UsdImagingDataSourceRenderPassPrim, UsdSkelImagingDataSourceAnimationPrim, UsdImagingDataSourceCamera, UsdImagingDataSourceTetMeshTopology, UsdImagingDataSourceBasisCurvesTopology, UsdImagingDataSourcePrimvars, UsdSkelImagingDataSourceBlendShapePrim, HdLazyContainerDataSource, UsdImagingDataSourceSubdivisionTags, UsdImagingDataSourceVolumeFieldBindings, UsdImagingDataSourcePointsPrim, UsdImagingDataSourceUsdPrimInfo, UsdImagingDataSourceNurbsCurvesPrim, UsdImagingDataSourceNurbsPatchPrim, UsdSkelImagingDataSourceSkeletonPrim, and UsdImagingDataSourceParticleFieldPrim.

static HD_API HdDataSourceBaseHandle HdContainerDataSource::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.

virtual TfTokenVector HdContainerDataSource::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, UsdImagingDataSourceDataSharing, UsdImagingDataSourcePrimOrigin, UsdImagingDataSourceXform, HdsiLocatorCachingSceneIndex::_DataSource, UsdImagingDataSourceExtentsHint, UsdImagingDataSourceExtent, UsdImagingDataSourceMapped, UsdImagingDataSourceRenderVarPrim, UsdImagingDataSourcePrimvar, UsdImagingDataSourceMeshPrim, UsdImagingDataSourcePointInstancerPrim, UsdImagingDataSourceRenderProductPrim, UsdImagingDataSourceTetMeshPrim, UsdImagingDataSourceBasisCurvesPrim, UsdImagingDataSourceMesh, UsdImagingDataSourcePurpose, UsdImagingDataSourceMaterialPrim, UsdImagingDataSourcePointInstancerTopology, UsdSkelImagingDataSourceResolvedPointsBasedPrim, HdxFreeCameraPrimDataSource, UsdImagingDataSourceRenderSettingsPrim, UsdImagingDataSourceFieldAssetPrim, HdOverlayContainerDataSource, UsdImagingDataSourceCustomPrimvars, UsdImagingDataSourceCameraPrim, UsdImagingDataSourceTetMesh, HdDataSourceLegacyPrim, UsdImagingDataSourceBasisCurves, UsdImagingDataSourceVolumePrim, UsdImagingDataSourceMeshTopology, UsdSkelImagingDataSourceResolvedSkeletonPrim, UsdImagingDataSourceVisibility, HdDataSourceLegacyTaskPrim, UsdImagingDataSourceMaterial, UsdImagingRerootingContainerDataSource, UsdImagingDataSourceFieldAsset, UsdSkelImagingDataSourceBindingAPI, HdMapContainerDataSource, UsdImagingDataSourceCamera, UsdImagingDataSourceGprim, UsdImagingDataSourceStage, UsdImagingDataSourceTetMeshTopology, UsdImagingDataSourceBasisCurvesTopology, UsdImagingDataSourcePrimvars, UsdImagingDataSourceRenderPassPrim, UsdSkelImagingDataSourceAnimationPrim, UsdImagingDataSourceSubdivisionTags, UsdImagingDataSourceVolumeFieldBindings, HdLazyContainerDataSource, UsdSkelImagingDataSourceBlendShapePrim, UsdImagingDataSourceUsdPrimInfo, UsdImagingDataSourceNurbsCurvesPrim, UsdImagingDataSourceNurbsPatchPrim, and UsdSkelImagingDataSourceSkeletonPrim.

HdContainerDataSource::HD_DECLARE_DATASOURCE_ABSTRACT ( HdContainerDataSource  )

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