UsdImagingAPISchemaAdapter Class Reference

Base class for all API schema adapters. More...

Inherits enable_shared_from_this< UsdImagingAPISchemaAdapter >.

Inherited by UsdImagingCollectionAPIAdapter, UsdImagingCoordSysAPIAdapter, UsdImagingLightAPIAdapter, and UsdImagingMaterialBindingAPIAdapter.

Public Member Functions

virtual USDIMAGING_API TfTokenVector GetImagingSubprims (UsdPrim const &prim, TfToken const &appliedInstanceName)
 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. More...
 
virtual USDIMAGING_API TfToken GetImagingSubprimType (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName)
 Called to determine whether an API schema specifies the hydra type of a given prim previously defined by a call to GetImagingSubprims. More...
 
virtual USDIMAGING_API HdContainerDataSourceHandle GetImagingSubprimData (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName, const UsdImagingDataSourceStageGlobals &stageGlobals)
 Returns an HdContainerDataSourceHandle representing the API schema's contributions to the primary prim (empty subprim value) or a specific subprim. More...
 
virtual USDIMAGING_API HdDataSourceLocatorSet InvalidateImagingSubprim (UsdPrim const &prim, TfToken const &subprim, TfToken const &appliedInstanceName, TfTokenVector const &properties)
 Given the names of USD properties which have changed, an adapter may provide a HdDataSourceLocatorSet describing which data sources should be flagged as dirty. More...
 

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 55 of file apiSchemaAdapter.h.

Member Function Documentation

◆ GetImagingSubprimData()

virtual USDIMAGING_API HdContainerDataSourceHandle 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.

◆ GetImagingSubprims()

virtual USDIMAGING_API TfTokenVector 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.

◆ GetImagingSubprimType()

virtual USDIMAGING_API TfToken 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.

◆ InvalidateImagingSubprim()

virtual USDIMAGING_API HdDataSourceLocatorSet InvalidateImagingSubprim ( UsdPrim const &  prim,
TfToken const &  subprim,
TfToken const &  appliedInstanceName,
TfTokenVector const &  properties 
)
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.


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