UsdImagingLightAPIAdapter Class Reference

#include <lightAPIAdapter.h>

Inheritance diagram for UsdImagingLightAPIAdapter:

Public Types
using	BaseAdapter = UsdImagingAPISchemaAdapter

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

Detailed Description

Definition at line 14 of file lightAPIAdapter.h.

Member Typedef Documentation

using UsdImagingLightAPIAdapter::BaseAdapter = UsdImagingAPISchemaAdapter

Definition at line 18 of file lightAPIAdapter.h.

Member Function Documentation

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

overridevirtual

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 from UsdImagingAPISchemaAdapter.

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

overridevirtual

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.

Reimplemented from UsdImagingAPISchemaAdapter.

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

overridevirtual

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 from UsdImagingAPISchemaAdapter.

---

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

• pxr/usdImaging/usdImaging/lightAPIAdapter.h