UsdImagingAPISchemaAdapter Class Reference

#include <apiSchemaAdapter.h>

Inheritance diagram for UsdImagingAPISchemaAdapter:

Public Member Functions
virtual USDIMAGING_API	~UsdImagingAPISchemaAdapter ()
virtual USDIMAGING_API TfTokenVector	GetImagingSubprims (UsdPrim const &prim, TfToken const &appliedInstanceName)
virtual USDIMAGING_API TfToken	GetImagingSubprimType (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName)
virtual USDIMAGING_API HdContainerDataSourceHandle	GetImagingSubprimData (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName, const UsdImagingDataSourceStageGlobals &stageGlobals)
virtual USDIMAGING_API HdDataSourceLocatorSet	InvalidateImagingSubprim (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName, TfTokenVector const &properties, UsdImagingPropertyInvalidationType invalidationType)

Detailed Description

Base class for all API schema adapters.

These map behavior of applied API schemas to contributions the hydra prims and data sources generated for a given USD prim.

Definition at line 56 of file apiSchemaAdapter.h.

Constructor & Destructor Documentation

virtual USDIMAGING_API UsdImagingAPISchemaAdapter::~UsdImagingAPISchemaAdapter ( )

virtual

Member Function Documentation

virtual USDIMAGING_API HdContainerDataSourceHandle UsdImagingAPISchemaAdapter::GetImagingSubprimData ( UsdPrim const &  prim, TfToken const &  subprim, TfToken const &  appliedInstanceName, const UsdImagingDataSourceStageGlobals &  stageGlobals  )

virtual

Returns an HdContainerDataSourceHandle representing the API schema's contributions to the primary prim (empty subprim value) or a specific subprim. The non-null results of the prim adapter and each applied API schema adapter are overlaid (in application order).

Ideally, data sources within this container are lazily evaluated to avoid doing work until some consumes the data.

Reimplemented in UsdImagingCollectionAPIAdapter, UsdImagingCoordSysAPIAdapter, UsdImagingLightAPIAdapter, and UsdImagingMaterialBindingAPIAdapter.

virtual USDIMAGING_API TfTokenVector UsdImagingAPISchemaAdapter::GetImagingSubprims ( UsdPrim const &  prim, TfToken const &  appliedInstanceName  )

virtual

Called to determine whether an API schema defines additional child hydra prims beyond the primary hydra prim representing the USD prim on which the API schema is applied. The token values returned are appended (as property names) to the SdfPath which serves as the hydra id of the primary prim. appliedInstanceName will be non-empty for multiple-apply schema instance names.

virtual USDIMAGING_API TfToken UsdImagingAPISchemaAdapter::GetImagingSubprimType ( UsdPrim const &  prim, TfToken const &  subprim, TfToken const &  appliedInstanceName  )

virtual

Called to determine whether an API schema specifies the hydra type of a given prim previously defined by a call to GetImagingSubprims. subprim corresponds to an element in the result of a previous call to GetImagingSubprims. appliedInstanceName will be non-empty for multiple-apply schema instance names.

virtual USDIMAGING_API HdDataSourceLocatorSet UsdImagingAPISchemaAdapter::InvalidateImagingSubprim ( UsdPrim const &  prim, TfToken const &  subprim, TfToken const &  appliedInstanceName, TfTokenVector const &  properties, UsdImagingPropertyInvalidationType  invalidationType  )

virtual

Given the names of USD properties which have changed, an adapter may provide a HdDataSourceLocatorSet describing which data sources should be flagged as dirty.

Reimplemented in UsdImagingCollectionAPIAdapter, UsdImagingCoordSysAPIAdapter, UsdImagingLightAPIAdapter, and UsdImagingMaterialBindingAPIAdapter.

---

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

• pxr/usdImaging/usdImaging/apiSchemaAdapter.h