UsdImagingUsdRenderVarSchema Class Reference

#include <usdRenderVarSchema.h>

Inheritance diagram for UsdImagingUsdRenderVarSchema:

Classes
class	Builder

Public Member Functions
Member accessor
USDIMAGING_API HdTokenDataSourceHandle	GetDataType () const
USDIMAGING_API HdStringDataSourceHandle	GetSourceName () const
USDIMAGING_API HdTokenDataSourceHandle	GetSourceType () const
USDIMAGING_API HdContainerDataSourceHandle	GetNamespacedSettings () const
Public Member Functions inherited from HdSchema
	HdSchema (HdContainerDataSourceHandle container)
HD_API HdContainerDataSourceHandle	GetContainer () const
	Returns the container data source that this schema is interpreting. More...
HD_API bool	IsDefined () const
	operator bool () const

Static Public Member Functions
Schema location
static USDIMAGING_API const TfToken &	GetSchemaToken ()
static USDIMAGING_API const HdDataSourceLocator &	GetDefaultLocator ()
Data source locators for members
The following methods return an HdDataSourceLocator (relative to the prim-level data source) where the data source for a member can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
static USDIMAGING_API const HdDataSourceLocator &	GetNamespacedSettingsLocator ()
	Prim-level relative data source locator to locate namespacedSettings. More...
Schema construction
static USDIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdTokenDataSourceHandle &dataType, const HdStringDataSourceHandle &sourceName, const HdTokenDataSourceHandle &sourceType, const HdContainerDataSourceHandle &namespacedSettings)

Schema retrieval
	UsdImagingUsdRenderVarSchema (HdContainerDataSourceHandle container)
static USDIMAGING_API UsdImagingUsdRenderVarSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource
Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name) const
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 48 of file usdRenderVarSchema.h.

Constructor & Destructor Documentation

UsdImagingUsdRenderVarSchema::UsdImagingUsdRenderVarSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "__usdRenderVar" from the parent container and constructs a UsdImagingUsdRenderVarSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

Definition at line 54 of file usdRenderVarSchema.h.

Member Function Documentation

static USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdRenderVarSchema::BuildRetained ( const HdTokenDataSourceHandle &  dataType, const HdStringDataSourceHandle &  sourceName, const HdTokenDataSourceHandle &  sourceType, const HdContainerDataSourceHandle &  namespacedSettings  )

static

Deprecated:

Use Builder instead.

Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderVarSchema::GetDataType

(

)

const

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderVarSchema::GetDefaultLocator ( )

static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

static USDIMAGING_API UsdImagingUsdRenderVarSchema UsdImagingUsdRenderVarSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer )

static

Retrieves a container data source with the schema's default name token "__usdRenderVar" from the parent container and constructs a UsdImagingUsdRenderVarSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdRenderVarSchema::GetNamespacedSettings

(

)

const

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderVarSchema::GetNamespacedSettingsLocator ( )

static

Prim-level relative data source locator to locate namespacedSettings.

static USDIMAGING_API const TfToken& UsdImagingUsdRenderVarSchema::GetSchemaToken ( )

static

Returns a token where the container representing this schema is found in a container by default.

USDIMAGING_API HdStringDataSourceHandle UsdImagingUsdRenderVarSchema::GetSourceName

(

)

const

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderVarSchema::GetSourceType

(

)

const

---

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

• pxr/usdImaging/usdImaging/usdRenderVarSchema.h