HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Static Public Member Functions | List of all members
UsdImagingUsdRenderVarSchema Class Reference

#include <usdRenderVarSchema.h>

+ Inheritance diagram for UsdImagingUsdRenderVarSchema:

Classes

class  Builder
 

Public Member Functions

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

Static Public Member Functions

static USDIMAGING_API
HdContainerDataSourceHandle 		BuildRetained (const HdTokenDataSourceHandle &dataType, const HdStringDataSourceHandle &sourceName, const HdTokenDataSourceHandle &sourceType, const HdContainerDataSourceHandle &namespacedSettings)
 
static USDIMAGING_API
UsdImagingUsdRenderVarSchema 		GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 
static USDIMAGING_API const
TfToken & 		GetSchemaToken ()
 
static USDIMAGING_API const
HdDataSourceLocator & 		GetDefaultLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator & 		GetNamespacedSettingsLocator ()
 

Additional Inherited Members

- Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle _GetTypedDataSource (TfToken name)
 
- Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle _container
 

Detailed Description

Definition at line 54 of file usdRenderVarSchema.h.

Constructor & Destructor Documentation

UsdImagingUsdRenderVarSchema::UsdImagingUsdRenderVarSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 57 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

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 ( )
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 ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderVarSchema::GetNamespacedSettingsLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the namespacedsettings data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

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 ( )
USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderVarSchema::GetSourceType ( )
The documentation for this class was generated from the following file: