HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdImagingUsdRenderProductSchema Class Reference

#include <usdRenderProductSchema.h>

+ Inheritance diagram for UsdImagingUsdRenderProductSchema:

Classes

class  Builder
 

Public Member Functions

 UsdImagingUsdRenderProductSchema (HdContainerDataSourceHandle container)
 
USDIMAGING_API
HdVec2iDataSourceHandle 
GetResolution ()
 
USDIMAGING_API
HdFloatDataSourceHandle 
GetPixelAspectRatio ()
 
USDIMAGING_API
HdTokenDataSourceHandle 
GetAspectRatioConformPolicy ()
 
USDIMAGING_API
HdVec4fDataSourceHandle 
GetDataWindowNDC ()
 
USDIMAGING_API
HdBoolDataSourceHandle 
GetDisableMotionBlur ()
 
USDIMAGING_API
HdPathDataSourceHandle 
GetCamera ()
 
USDIMAGING_API
HdTokenDataSourceHandle 
GetProductType ()
 
USDIMAGING_API
HdTokenDataSourceHandle 
GetProductName ()
 
USDIMAGING_API
HdPathArrayDataSourceHandle 
GetOrderedVars ()
 
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 HdVec2iDataSourceHandle &resolution, const HdFloatDataSourceHandle &pixelAspectRatio, const HdTokenDataSourceHandle &aspectRatioConformPolicy, const HdVec4fDataSourceHandle &dataWindowNDC, const HdBoolDataSourceHandle &disableMotionBlur, const HdPathDataSourceHandle &camera, const HdTokenDataSourceHandle &productType, const HdTokenDataSourceHandle &productName, const HdPathArrayDataSourceHandle &orderedVars, const HdContainerDataSourceHandle &namespacedSettings)
 
static USDIMAGING_API
UsdImagingUsdRenderProductSchema 
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 60 of file usdRenderProductSchema.h.

Constructor & Destructor Documentation

UsdImagingUsdRenderProductSchema::UsdImagingUsdRenderProductSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 63 of file usdRenderProductSchema.h.

Member Function Documentation

static USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdRenderProductSchema::BuildRetained ( const HdVec2iDataSourceHandle resolution,
const HdFloatDataSourceHandle pixelAspectRatio,
const HdTokenDataSourceHandle aspectRatioConformPolicy,
const HdVec4fDataSourceHandle dataWindowNDC,
const HdBoolDataSourceHandle disableMotionBlur,
const HdPathDataSourceHandle camera,
const HdTokenDataSourceHandle productType,
const HdTokenDataSourceHandle productName,
const HdPathArrayDataSourceHandle orderedVars,
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 UsdImagingUsdRenderProductSchema::GetAspectRatioConformPolicy ( )
USDIMAGING_API HdPathDataSourceHandle UsdImagingUsdRenderProductSchema::GetCamera ( )
USDIMAGING_API HdVec4fDataSourceHandle UsdImagingUsdRenderProductSchema::GetDataWindowNDC ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderProductSchema::GetDefaultLocator ( )
static

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

USDIMAGING_API HdBoolDataSourceHandle UsdImagingUsdRenderProductSchema::GetDisableMotionBlur ( )
static USDIMAGING_API UsdImagingUsdRenderProductSchema UsdImagingUsdRenderProductSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

Retrieves a container data source with the schema's default name token "__usdRenderProduct" from the parent container and constructs a UsdImagingUsdRenderProductSchema 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 UsdImagingUsdRenderProductSchema::GetNamespacedSettings ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderProductSchema::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.

USDIMAGING_API HdPathArrayDataSourceHandle UsdImagingUsdRenderProductSchema::GetOrderedVars ( )
USDIMAGING_API HdFloatDataSourceHandle UsdImagingUsdRenderProductSchema::GetPixelAspectRatio ( )
USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderProductSchema::GetProductName ( )
USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderProductSchema::GetProductType ( )
USDIMAGING_API HdVec2iDataSourceHandle UsdImagingUsdRenderProductSchema::GetResolution ( )
static USDIMAGING_API const TfToken& UsdImagingUsdRenderProductSchema::GetSchemaToken ( )
static

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


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